Google Cloud BigQuery Migration V2 Client - Class TranslationConfigDetails (1.1.0)

Reference documentation and code samples for the Google Cloud BigQuery Migration V2 Client class TranslationConfigDetails.

The translation config to capture necessary settings for a translation task and subtask.

Generated from protobuf message google.cloud.bigquery.migration.v2.TranslationConfigDetails

Namespace

Google \ Cloud \ BigQuery \ Migration \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ gcs_source_path string

The Cloud Storage path for a directory of files to translate in a task.

↳ gcs_target_path string

The Cloud Storage path to write back the corresponding input files to.

↳ name_mapping_list Google\Cloud\BigQuery\Migration\V2\ObjectNameMappingList

The mapping of objects to their desired output names in list form.

↳ source_dialect Google\Cloud\BigQuery\Migration\V2\Dialect

The dialect of the input files.

↳ target_dialect Google\Cloud\BigQuery\Migration\V2\Dialect

The target dialect for the engine to translate the input to.

↳ source_env Google\Cloud\BigQuery\Migration\V2\SourceEnv

The default source environment values for the translation.

↳ request_source string

The indicator to show translation request initiator.

↳ target_types array

The types of output to generate, e.g. sql, metadata etc. If not specified, a default set of targets will be generated. Some additional target types may be slower to generate. See the documentation for the set of available target types.

getGcsSourcePath

The Cloud Storage path for a directory of files to translate in a task.

Returns
Type Description
string

hasGcsSourcePath

setGcsSourcePath

The Cloud Storage path for a directory of files to translate in a task.

Parameter
Name Description
var string
Returns
Type Description
$this

getGcsTargetPath

The Cloud Storage path to write back the corresponding input files to.

Returns
Type Description
string

hasGcsTargetPath

setGcsTargetPath

The Cloud Storage path to write back the corresponding input files to.

Parameter
Name Description
var string
Returns
Type Description
$this

getNameMappingList

The mapping of objects to their desired output names in list form.

Returns
Type Description
Google\Cloud\BigQuery\Migration\V2\ObjectNameMappingList|null

hasNameMappingList

setNameMappingList

The mapping of objects to their desired output names in list form.

Parameter
Name Description
var Google\Cloud\BigQuery\Migration\V2\ObjectNameMappingList
Returns
Type Description
$this

getSourceDialect

The dialect of the input files.

Returns
Type Description
Google\Cloud\BigQuery\Migration\V2\Dialect|null

hasSourceDialect

clearSourceDialect

setSourceDialect

The dialect of the input files.

Parameter
Name Description
var Google\Cloud\BigQuery\Migration\V2\Dialect
Returns
Type Description
$this

getTargetDialect

The target dialect for the engine to translate the input to.

Returns
Type Description
Google\Cloud\BigQuery\Migration\V2\Dialect|null

hasTargetDialect

clearTargetDialect

setTargetDialect

The target dialect for the engine to translate the input to.

Parameter
Name Description
var Google\Cloud\BigQuery\Migration\V2\Dialect
Returns
Type Description
$this

getSourceEnv

The default source environment values for the translation.

Returns
Type Description
Google\Cloud\BigQuery\Migration\V2\SourceEnv|null

hasSourceEnv

clearSourceEnv

setSourceEnv

The default source environment values for the translation.

Parameter
Name Description
var Google\Cloud\BigQuery\Migration\V2\SourceEnv
Returns
Type Description
$this

getRequestSource

The indicator to show translation request initiator.

Returns
Type Description
string

setRequestSource

The indicator to show translation request initiator.

Parameter
Name Description
var string
Returns
Type Description
$this

getTargetTypes

The types of output to generate, e.g. sql, metadata etc. If not specified, a default set of targets will be generated. Some additional target types may be slower to generate. See the documentation for the set of available target types.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTargetTypes

The types of output to generate, e.g. sql, metadata etc. If not specified, a default set of targets will be generated. Some additional target types may be slower to generate. See the documentation for the set of available target types.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getSourceLocation

Returns
Type Description
string

getTargetLocation

Returns
Type Description
string

getOutputNameMapping

Returns
Type Description
string