Google Cloud BigQuery Migration V2 Client - Class MigrationTask (0.4.5)

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

A single task for a migration which has details about the configuration of the task.

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

Namespace

Google \ Cloud \ BigQuery \ Migration \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ translation_config_details Google\Cloud\BigQuery\Migration\V2\TranslationConfigDetails

Task configuration for Batch SQL Translation.

↳ id string

Output only. Immutable. The unique identifier for the migration task. The ID is server-generated.

↳ type string

The type of the task. This must be one of the supported task types: Translation_Teradata2BQ, Translation_Redshift2BQ, Translation_Bteq2BQ, Translation_Oracle2BQ, Translation_HiveQL2BQ, Translation_SparkSQL2BQ, Translation_Snowflake2BQ, Translation_Netezza2BQ, Translation_AzureSynapse2BQ, Translation_Vertica2BQ, Translation_SQLServer2BQ, Translation_Presto2BQ, Translation_MySQL2BQ, Translation_Postgresql2BQ.

↳ state int

Output only. The current state of the task.

↳ processing_error Google\Rpc\ErrorInfo

Output only. An explanation that may be populated when the task is in FAILED state.

↳ create_time Google\Protobuf\Timestamp

Time when the task was created.

↳ last_update_time Google\Protobuf\Timestamp

Time when the task was last updated.

getTranslationConfigDetails

Task configuration for Batch SQL Translation.

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

hasTranslationConfigDetails

setTranslationConfigDetails

Task configuration for Batch SQL Translation.

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

getId

Output only. Immutable. The unique identifier for the migration task. The ID is server-generated.

Returns
Type Description
string

setId

Output only. Immutable. The unique identifier for the migration task. The ID is server-generated.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

The type of the task. This must be one of the supported task types: Translation_Teradata2BQ, Translation_Redshift2BQ, Translation_Bteq2BQ, Translation_Oracle2BQ, Translation_HiveQL2BQ, Translation_SparkSQL2BQ, Translation_Snowflake2BQ, Translation_Netezza2BQ, Translation_AzureSynapse2BQ, Translation_Vertica2BQ, Translation_SQLServer2BQ, Translation_Presto2BQ, Translation_MySQL2BQ, Translation_Postgresql2BQ.

Returns
Type Description
string

setType

The type of the task. This must be one of the supported task types: Translation_Teradata2BQ, Translation_Redshift2BQ, Translation_Bteq2BQ, Translation_Oracle2BQ, Translation_HiveQL2BQ, Translation_SparkSQL2BQ, Translation_Snowflake2BQ, Translation_Netezza2BQ, Translation_AzureSynapse2BQ, Translation_Vertica2BQ, Translation_SQLServer2BQ, Translation_Presto2BQ, Translation_MySQL2BQ, Translation_Postgresql2BQ.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The current state of the task.

Returns
Type Description
int

setState

Output only. The current state of the task.

Parameter
Name Description
var int
Returns
Type Description
$this

getProcessingError

Output only. An explanation that may be populated when the task is in FAILED state.

Returns
Type Description
Google\Rpc\ErrorInfo|null

hasProcessingError

clearProcessingError

setProcessingError

Output only. An explanation that may be populated when the task is in FAILED state.

Parameter
Name Description
var Google\Rpc\ErrorInfo
Returns
Type Description
$this

getCreateTime

Time when the task was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Time when the task was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLastUpdateTime

Time when the task was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastUpdateTime

clearLastUpdateTime

setLastUpdateTime

Time when the task was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getTaskDetails

Returns
Type Description
string