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

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

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
Google\Cloud\BigQuery\Migration\V2\TranslationConfigDetails|null

hasTranslationConfigDetails

setTranslationConfigDetails

Task configuration for Batch SQL Translation.

Parameter
NameDescription
var Google\Cloud\BigQuery\Migration\V2\TranslationConfigDetails
Returns
TypeDescription
$this

getId

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

Returns
TypeDescription
string

setId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The current state of the task.

Returns
TypeDescription
int

setState

Output only. The current state of the task.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getProcessingError

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

Returns
TypeDescription
Google\Rpc\ErrorInfo|null

hasProcessingError

clearProcessingError

setProcessingError

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

Parameter
NameDescription
var Google\Rpc\ErrorInfo
Returns
TypeDescription
$this

getCreateTime

Time when the task was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Time when the task was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLastUpdateTime

Time when the task was last updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasLastUpdateTime

clearLastUpdateTime

setLastUpdateTime

Time when the task was last updated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getTaskDetails

Returns
TypeDescription
string