Class TranslationTaskDetails (0.49.0)

public final class TranslationTaskDetails extends 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

Static Fields

BTEQ_OPTIONS_FIELD_NUMBER

public static final int BTEQ_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

FILE_ENCODING_FIELD_NUMBER

public static final int FILE_ENCODING_FIELD_NUMBER
Field Value
Type Description
int

FILE_PATHS_FIELD_NUMBER

public static final int FILE_PATHS_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

IDENTIFIER_SETTINGS_FIELD_NUMBER

public static final int IDENTIFIER_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

INPUT_PATH_FIELD_NUMBER

public static final int INPUT_PATH_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_PATH_FIELD_NUMBER

public static final int OUTPUT_PATH_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_PATH_FIELD_NUMBER

public static final int SCHEMA_PATH_FIELD_NUMBER
Field Value
Type Description
int

SPECIAL_TOKEN_MAP_FIELD_NUMBER

public static final int SPECIAL_TOKEN_MAP_FIELD_NUMBER
Field Value
Type Description
int

TERADATA_OPTIONS_FIELD_NUMBER

public static final int TERADATA_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

TRANSLATION_EXCEPTION_TABLE_FIELD_NUMBER

public static final int TRANSLATION_EXCEPTION_TABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TranslationTaskDetails getDefaultInstance()
Returns
Type Description
TranslationTaskDetails

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TranslationTaskDetails.Builder newBuilder()
Returns
Type Description
TranslationTaskDetails.Builder

newBuilder(TranslationTaskDetails prototype)

public static TranslationTaskDetails.Builder newBuilder(TranslationTaskDetails prototype)
Parameter
Name Description
prototype TranslationTaskDetails
Returns
Type Description
TranslationTaskDetails.Builder

parseDelimitedFrom(InputStream input)

public static TranslationTaskDetails parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TranslationTaskDetails parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TranslationTaskDetails parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TranslationTaskDetails parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TranslationTaskDetails parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TranslationTaskDetails parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TranslationTaskDetails parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TranslationTaskDetails parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TranslationTaskDetails parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TranslationTaskDetails parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TranslationTaskDetails parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TranslationTaskDetails parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TranslationTaskDetails
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TranslationTaskDetails> parser()
Returns
Type Description
Parser<TranslationTaskDetails>

Methods

containsSpecialTokenMap(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBteqOptions()

public BteqOptions getBteqOptions()

The BTEQ specific settings for the translation task.

.google.cloud.bigquery.migration.v2alpha.BteqOptions bteq_options = 11;

Returns
Type Description
BteqOptions

The bteqOptions.

getBteqOptionsOrBuilder()

public BteqOptionsOrBuilder getBteqOptionsOrBuilder()

The BTEQ specific settings for the translation task.

.google.cloud.bigquery.migration.v2alpha.BteqOptions bteq_options = 11;

Returns
Type Description
BteqOptionsOrBuilder

getDefaultInstanceForType()

public TranslationTaskDetails getDefaultInstanceForType()
Returns
Type Description
TranslationTaskDetails

getFileEncoding()

public TranslationTaskDetails.FileEncoding getFileEncoding()

The file encoding type.

.google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.FileEncoding file_encoding = 4;

Returns
Type Description
TranslationTaskDetails.FileEncoding

The fileEncoding.

getFileEncodingValue()

public int getFileEncodingValue()

The file encoding type.

.google.cloud.bigquery.migration.v2alpha.TranslationTaskDetails.FileEncoding file_encoding = 4;

Returns
Type Description
int

The enum numeric value on the wire for fileEncoding.

getFilePaths(int index)

public TranslationFileMapping getFilePaths(int index)

Cloud Storage files to be processed for translation.

repeated .google.cloud.bigquery.migration.v2alpha.TranslationFileMapping file_paths = 12;

Parameter
Name Description
index int
Returns
Type Description
TranslationFileMapping

getFilePathsCount()

public int getFilePathsCount()

Cloud Storage files to be processed for translation.

repeated .google.cloud.bigquery.migration.v2alpha.TranslationFileMapping file_paths = 12;

Returns
Type Description
int

getFilePathsList()

public List<TranslationFileMapping> getFilePathsList()

Cloud Storage files to be processed for translation.

repeated .google.cloud.bigquery.migration.v2alpha.TranslationFileMapping file_paths = 12;

Returns
Type Description
List<TranslationFileMapping>

getFilePathsOrBuilder(int index)

public TranslationFileMappingOrBuilder getFilePathsOrBuilder(int index)

Cloud Storage files to be processed for translation.

repeated .google.cloud.bigquery.migration.v2alpha.TranslationFileMapping file_paths = 12;

Parameter
Name Description
index int
Returns
Type Description
TranslationFileMappingOrBuilder

getFilePathsOrBuilderList()

public List<? extends TranslationFileMappingOrBuilder> getFilePathsOrBuilderList()

Cloud Storage files to be processed for translation.

repeated .google.cloud.bigquery.migration.v2alpha.TranslationFileMapping file_paths = 12;

Returns
Type Description
List<? extends com.google.cloud.bigquery.migration.v2alpha.TranslationFileMappingOrBuilder>

getFilter()

public Filter getFilter()

The filter applied to translation details.

.google.cloud.bigquery.migration.v2alpha.Filter filter = 7;

Returns
Type Description
Filter

The filter.

getFilterOrBuilder()

public FilterOrBuilder getFilterOrBuilder()

The filter applied to translation details.

.google.cloud.bigquery.migration.v2alpha.Filter filter = 7;

Returns
Type Description
FilterOrBuilder

getIdentifierSettings()

public IdentifierSettings getIdentifierSettings()

The settings for SQL identifiers.

.google.cloud.bigquery.migration.v2alpha.IdentifierSettings identifier_settings = 5;

Returns
Type Description
IdentifierSettings

The identifierSettings.

getIdentifierSettingsOrBuilder()

public IdentifierSettingsOrBuilder getIdentifierSettingsOrBuilder()

The settings for SQL identifiers.

.google.cloud.bigquery.migration.v2alpha.IdentifierSettings identifier_settings = 5;

Returns
Type Description
IdentifierSettingsOrBuilder

getInputPath()

public String getInputPath()

The Cloud Storage path for translation input files.

string input_path = 1;

Returns
Type Description
String

The inputPath.

getInputPathBytes()

public ByteString getInputPathBytes()

The Cloud Storage path for translation input files.

string input_path = 1;

Returns
Type Description
ByteString

The bytes for inputPath.

getLanguageOptionsCase()

public TranslationTaskDetails.LanguageOptionsCase getLanguageOptionsCase()
Returns
Type Description
TranslationTaskDetails.LanguageOptionsCase

getOutputPath()

public String getOutputPath()

The Cloud Storage path for translation output files.

string output_path = 2;

Returns
Type Description
String

The outputPath.

getOutputPathBytes()

public ByteString getOutputPathBytes()

The Cloud Storage path for translation output files.

string output_path = 2;

Returns
Type Description
ByteString

The bytes for outputPath.

getParserForType()

public Parser<TranslationTaskDetails> getParserForType()
Returns
Type Description
Parser<TranslationTaskDetails>
Overrides

getSchemaPath()

public String getSchemaPath()

The Cloud Storage path to DDL files as table schema to assist semantic translation.

string schema_path = 3;

Returns
Type Description
String

The schemaPath.

getSchemaPathBytes()

public ByteString getSchemaPathBytes()

The Cloud Storage path to DDL files as table schema to assist semantic translation.

string schema_path = 3;

Returns
Type Description
ByteString

The bytes for schemaPath.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpecialTokenMap() (deprecated)

public Map<String,TranslationTaskDetails.TokenType> getSpecialTokenMap()
Returns
Type Description
Map<String,TokenType>

getSpecialTokenMapCount()

public int getSpecialTokenMapCount()

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;

Returns
Type Description
int

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;

Returns
Type Description
Map<String,TokenType>

getSpecialTokenMapOrDefault(String key, TranslationTaskDetails.TokenType defaultValue)

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;

Parameters
Name Description
key String
defaultValue TranslationTaskDetails.TokenType
Returns
Type Description
TranslationTaskDetails.TokenType

getSpecialTokenMapOrThrow(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
TranslationTaskDetails.TokenType

getSpecialTokenMapValue() (deprecated)

public Map<String,Integer> getSpecialTokenMapValue()
Returns
Type Description
Map<String,java.lang.Integer>

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;

Returns
Type Description
Map<String,java.lang.Integer>

getSpecialTokenMapValueOrDefault(String key, int defaultValue)

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;

Parameters
Name Description
key String
defaultValue int
Returns
Type Description
int

getSpecialTokenMapValueOrThrow(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
int

getTeradataOptions()

public TeradataOptions getTeradataOptions()

The Teradata SQL specific settings for the translation task.

.google.cloud.bigquery.migration.v2alpha.TeradataOptions teradata_options = 10;

Returns
Type Description
TeradataOptions

The teradataOptions.

getTeradataOptionsOrBuilder()

public TeradataOptionsOrBuilder getTeradataOptionsOrBuilder()

The Teradata SQL specific settings for the translation task.

.google.cloud.bigquery.migration.v2alpha.TeradataOptions teradata_options = 10;

Returns
Type Description
TeradataOptionsOrBuilder

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;

Returns
Type Description
String

The translationExceptionTable.

getTranslationExceptionTableBytes()

public 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;

Returns
Type Description
ByteString

The bytes for translationExceptionTable.

hasBteqOptions()

public boolean hasBteqOptions()

The BTEQ specific settings for the translation task.

.google.cloud.bigquery.migration.v2alpha.BteqOptions bteq_options = 11;

Returns
Type Description
boolean

Whether the bteqOptions field is set.

hasFilter()

public boolean hasFilter()

The filter applied to translation details.

.google.cloud.bigquery.migration.v2alpha.Filter filter = 7;

Returns
Type Description
boolean

Whether the filter field is set.

hasIdentifierSettings()

public boolean hasIdentifierSettings()

The settings for SQL identifiers.

.google.cloud.bigquery.migration.v2alpha.IdentifierSettings identifier_settings = 5;

Returns
Type Description
boolean

Whether the identifierSettings field is set.

hasTeradataOptions()

public boolean hasTeradataOptions()

The Teradata SQL specific settings for the translation task.

.google.cloud.bigquery.migration.v2alpha.TeradataOptions teradata_options = 10;

Returns
Type Description
boolean

Whether the teradataOptions field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TranslationTaskDetails.Builder newBuilderForType()
Returns
Type Description
TranslationTaskDetails.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TranslationTaskDetails.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TranslationTaskDetails.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TranslationTaskDetails.Builder toBuilder()
Returns
Type Description
TranslationTaskDetails.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException