Class TranslationTaskDetails

  • All Implemented Interfaces:
    TranslationTaskDetailsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class TranslationTaskDetails
    extends com.google.protobuf.GeneratedMessageV3
    implements TranslationTaskDetailsOrBuilder
     The translation task config to capture necessary settings for a translation
     task and subtask.
     
    Protobuf type google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails
    See Also:
    Serialized Form
    • Field Detail

      • TERADATA_OPTIONS_FIELD_NUMBER

        public static final int TERADATA_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • BTEQ_OPTIONS_FIELD_NUMBER

        public static final int BTEQ_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • INPUT_PATH_FIELD_NUMBER

        public static final int INPUT_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OUTPUT_PATH_FIELD_NUMBER

        public static final int OUTPUT_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FILE_PATHS_FIELD_NUMBER

        public static final int FILE_PATHS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SCHEMA_PATH_FIELD_NUMBER

        public static final int SCHEMA_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FILE_ENCODING_FIELD_NUMBER

        public static final int FILE_ENCODING_FIELD_NUMBER
        See Also:
        Constant Field Values
      • IDENTIFIER_SETTINGS_FIELD_NUMBER

        public static final int IDENTIFIER_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SPECIAL_TOKEN_MAP_FIELD_NUMBER

        public static final int SPECIAL_TOKEN_MAP_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TRANSLATION_EXCEPTION_TABLE_FIELD_NUMBER

        public static final int TRANSLATION_EXCEPTION_TABLE_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasTeradataOptions

        public boolean hasTeradataOptions()
         The Teradata SQL specific settings for the translation task.
         
        .google.cloud.bigquery.migration.v2alpha.TeradataOptions teradata_options = 10;
        Specified by:
        hasTeradataOptions in interface TranslationTaskDetailsOrBuilder
        Returns:
        Whether the teradataOptions field is set.
      • hasBteqOptions

        public boolean hasBteqOptions()
         The BTEQ specific settings for the translation task.
         
        .google.cloud.bigquery.migration.v2alpha.BteqOptions bteq_options = 11;
        Specified by:
        hasBteqOptions in interface TranslationTaskDetailsOrBuilder
        Returns:
        Whether the bteqOptions field is set.
      • getBteqOptions

        public BteqOptions getBteqOptions()
         The BTEQ specific settings for the translation task.
         
        .google.cloud.bigquery.migration.v2alpha.BteqOptions bteq_options = 11;
        Specified by:
        getBteqOptions in interface TranslationTaskDetailsOrBuilder
        Returns:
        The bteqOptions.
      • getInputPathBytes

        public com.google.protobuf.ByteString getInputPathBytes()
         The Cloud Storage path for translation input files.
         
        string input_path = 1;
        Specified by:
        getInputPathBytes in interface TranslationTaskDetailsOrBuilder
        Returns:
        The bytes for inputPath.
      • getOutputPathBytes

        public com.google.protobuf.ByteString getOutputPathBytes()
         The Cloud Storage path for translation output files.
         
        string output_path = 2;
        Specified by:
        getOutputPathBytes in interface TranslationTaskDetailsOrBuilder
        Returns:
        The bytes for outputPath.
      • getFilePathsCount

        public int getFilePathsCount()
         Cloud Storage files to be processed for translation.
         
        repeated .google.cloud.bigquery.migration.v2alpha.TranslationFileMapping file_paths = 12;
        Specified by:
        getFilePathsCount in interface TranslationTaskDetailsOrBuilder
      • getSchemaPath

        public String getSchemaPath()
         The Cloud Storage path to DDL files as table schema to assist semantic
         translation.
         
        string schema_path = 3;
        Specified by:
        getSchemaPath in interface TranslationTaskDetailsOrBuilder
        Returns:
        The schemaPath.
      • getSchemaPathBytes

        public com.google.protobuf.ByteString getSchemaPathBytes()
         The Cloud Storage path to DDL files as table schema to assist semantic
         translation.
         
        string schema_path = 3;
        Specified by:
        getSchemaPathBytes in interface TranslationTaskDetailsOrBuilder
        Returns:
        The bytes for schemaPath.
      • getFileEncodingValue

        public int getFileEncodingValue()
         The file encoding type.
         
        .google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.FileEncoding file_encoding = 4;
        Specified by:
        getFileEncodingValue in interface TranslationTaskDetailsOrBuilder
        Returns:
        The enum numeric value on the wire for fileEncoding.
      • hasIdentifierSettings

        public boolean hasIdentifierSettings()
         The settings for SQL identifiers.
         
        .google.cloud.bigquery.migration.v2alpha.IdentifierSettings identifier_settings = 5;
        Specified by:
        hasIdentifierSettings in interface TranslationTaskDetailsOrBuilder
        Returns:
        Whether the identifierSettings field is set.
      • getSpecialTokenMapCount

        public int getSpecialTokenMapCount()
        Description copied from interface: TranslationTaskDetailsOrBuilder
         The map capturing special tokens to be replaced during translation. The key
         is special token in string. The value is the token data type. This is used
         to translate SQL query template which contains special token as place
         holder. The special token makes a query invalid to parse. This map will be
         applied to annotate those special token with types to let parser understand
         how to parse them into proper structure with type information.
         
        map<string, .google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.TokenType> special_token_map = 6;
        Specified by:
        getSpecialTokenMapCount in interface TranslationTaskDetailsOrBuilder
      • containsSpecialTokenMap

        public boolean containsSpecialTokenMap​(String key)
         The map capturing special tokens to be replaced during translation. The key
         is special token in string. The value is the token data type. This is used
         to translate SQL query template which contains special token as place
         holder. The special token makes a query invalid to parse. This map will be
         applied to annotate those special token with types to let parser understand
         how to parse them into proper structure with type information.
         
        map<string, .google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.TokenType> special_token_map = 6;
        Specified by:
        containsSpecialTokenMap in interface TranslationTaskDetailsOrBuilder
      • getSpecialTokenMapMap

        public Map<String,​TranslationTaskDetails.TokenType> getSpecialTokenMapMap()
         The map capturing special tokens to be replaced during translation. The key
         is special token in string. The value is the token data type. This is used
         to translate SQL query template which contains special token as place
         holder. The special token makes a query invalid to parse. This map will be
         applied to annotate those special token with types to let parser understand
         how to parse them into proper structure with type information.
         
        map<string, .google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.TokenType> special_token_map = 6;
        Specified by:
        getSpecialTokenMapMap in interface TranslationTaskDetailsOrBuilder
      • getSpecialTokenMapOrDefault

        public TranslationTaskDetails.TokenType getSpecialTokenMapOrDefault​(String key,
                                                                            TranslationTaskDetails.TokenType defaultValue)
         The map capturing special tokens to be replaced during translation. The key
         is special token in string. The value is the token data type. This is used
         to translate SQL query template which contains special token as place
         holder. The special token makes a query invalid to parse. This map will be
         applied to annotate those special token with types to let parser understand
         how to parse them into proper structure with type information.
         
        map<string, .google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.TokenType> special_token_map = 6;
        Specified by:
        getSpecialTokenMapOrDefault in interface TranslationTaskDetailsOrBuilder
      • getSpecialTokenMapOrThrow

        public TranslationTaskDetails.TokenType getSpecialTokenMapOrThrow​(String key)
         The map capturing special tokens to be replaced during translation. The key
         is special token in string. The value is the token data type. This is used
         to translate SQL query template which contains special token as place
         holder. The special token makes a query invalid to parse. This map will be
         applied to annotate those special token with types to let parser understand
         how to parse them into proper structure with type information.
         
        map<string, .google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.TokenType> special_token_map = 6;
        Specified by:
        getSpecialTokenMapOrThrow in interface TranslationTaskDetailsOrBuilder
      • getSpecialTokenMapValueMap

        public Map<String,​Integer> getSpecialTokenMapValueMap()
         The map capturing special tokens to be replaced during translation. The key
         is special token in string. The value is the token data type. This is used
         to translate SQL query template which contains special token as place
         holder. The special token makes a query invalid to parse. This map will be
         applied to annotate those special token with types to let parser understand
         how to parse them into proper structure with type information.
         
        map<string, .google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.TokenType> special_token_map = 6;
        Specified by:
        getSpecialTokenMapValueMap in interface TranslationTaskDetailsOrBuilder
      • getSpecialTokenMapValueOrDefault

        public int getSpecialTokenMapValueOrDefault​(String key,
                                                    int defaultValue)
         The map capturing special tokens to be replaced during translation. The key
         is special token in string. The value is the token data type. This is used
         to translate SQL query template which contains special token as place
         holder. The special token makes a query invalid to parse. This map will be
         applied to annotate those special token with types to let parser understand
         how to parse them into proper structure with type information.
         
        map<string, .google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.TokenType> special_token_map = 6;
        Specified by:
        getSpecialTokenMapValueOrDefault in interface TranslationTaskDetailsOrBuilder
      • getSpecialTokenMapValueOrThrow

        public int getSpecialTokenMapValueOrThrow​(String key)
         The map capturing special tokens to be replaced during translation. The key
         is special token in string. The value is the token data type. This is used
         to translate SQL query template which contains special token as place
         holder. The special token makes a query invalid to parse. This map will be
         applied to annotate those special token with types to let parser understand
         how to parse them into proper structure with type information.
         
        map<string, .google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.TokenType> special_token_map = 6;
        Specified by:
        getSpecialTokenMapValueOrThrow in interface TranslationTaskDetailsOrBuilder
      • hasFilter

        public boolean hasFilter()
         The filter applied to translation details.
         
        .google.cloud.bigquery.migration.v2alpha.Filter filter = 7;
        Specified by:
        hasFilter in interface TranslationTaskDetailsOrBuilder
        Returns:
        Whether the filter field is set.
      • getFilter

        public Filter getFilter()
         The filter applied to translation details.
         
        .google.cloud.bigquery.migration.v2alpha.Filter filter = 7;
        Specified by:
        getFilter in interface TranslationTaskDetailsOrBuilder
        Returns:
        The filter.
      • getTranslationExceptionTable

        public String getTranslationExceptionTable()
         Specifies the exact name of the bigquery table ("dataset.table") to be used
         for surfacing raw translation errors. If the table does not exist, we will
         create it. If it already exists and the schema is the same, we will re-use.
         If the table exists and the schema is different, we will throw an error.
         
        string translation_exception_table = 13;
        Specified by:
        getTranslationExceptionTable in interface TranslationTaskDetailsOrBuilder
        Returns:
        The translationExceptionTable.
      • getTranslationExceptionTableBytes

        public com.google.protobuf.ByteString getTranslationExceptionTableBytes()
         Specifies the exact name of the bigquery table ("dataset.table") to be used
         for surfacing raw translation errors. If the table does not exist, we will
         create it. If it already exists and the schema is the same, we will re-use.
         If the table exists and the schema is different, we will throw an error.
         
        string translation_exception_table = 13;
        Specified by:
        getTranslationExceptionTableBytes in interface TranslationTaskDetailsOrBuilder
        Returns:
        The bytes for translationExceptionTable.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static TranslationTaskDetails parseFrom​(ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TranslationTaskDetails parseFrom​(ByteBuffer data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TranslationTaskDetails parseFrom​(com.google.protobuf.ByteString data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TranslationTaskDetails parseFrom​(com.google.protobuf.ByteString data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TranslationTaskDetails parseFrom​(byte[] data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static TranslationTaskDetails parseFrom​(byte[] data,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public TranslationTaskDetails.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public TranslationTaskDetails.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected TranslationTaskDetails.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<TranslationTaskDetails> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public TranslationTaskDetails getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder