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

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 CW Batch/Offline SQL Translation.

↳ translation_details Google\Cloud\BigQuery\Migration\V2\TranslationDetails

Task details for unified 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, Translation_SQLite2BQ, Translation_Greenplum2BQ.

↳ 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.

↳ resource_error_details array<Google\Cloud\BigQuery\Migration\V2\ResourceErrorDetail>

Output only. Provides details to errors and issues encountered while processing the task. Presence of error details does not mean that the task failed.

↳ resource_error_count int

The number or resources with errors. Note: This is not the total number of errors as each resource can have more than one error. This is used to indicate truncation by having a resource_error_count that is higher than the size of resource_error_details.

↳ metrics array<Google\Cloud\BigQuery\Migration\V2\TimeSeries>

The metrics for the task.

↳ task_result Google\Cloud\BigQuery\Migration\V2\MigrationTaskResult

Output only. The result of the task.

↳ total_processing_error_count int

Count of all the processing errors in this task and its subtasks.

↳ total_resource_error_count int

Count of all the resource errors in this task and its subtasks.

getTranslationConfigDetails

Task configuration for CW Batch/Offline SQL Translation.

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

hasTranslationConfigDetails

setTranslationConfigDetails

Task configuration for CW Batch/Offline SQL Translation.

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

getTranslationDetails

Task details for unified SQL Translation.

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

hasTranslationDetails

setTranslationDetails

Task details for unified SQL Translation.

Parameter
Name Description
var Google\Cloud\BigQuery\Migration\V2\TranslationDetails
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, Translation_SQLite2BQ, Translation_Greenplum2BQ.

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, Translation_SQLite2BQ, Translation_Greenplum2BQ.

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

getResourceErrorDetails

Output only. Provides details to errors and issues encountered while processing the task. Presence of error details does not mean that the task failed.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setResourceErrorDetails

Output only. Provides details to errors and issues encountered while processing the task. Presence of error details does not mean that the task failed.

Parameter
Name Description
var array<Google\Cloud\BigQuery\Migration\V2\ResourceErrorDetail>
Returns
Type Description
$this

getResourceErrorCount

The number or resources with errors. Note: This is not the total number of errors as each resource can have more than one error.

This is used to indicate truncation by having a resource_error_count that is higher than the size of resource_error_details.

Returns
Type Description
int

setResourceErrorCount

The number or resources with errors. Note: This is not the total number of errors as each resource can have more than one error.

This is used to indicate truncation by having a resource_error_count that is higher than the size of resource_error_details.

Parameter
Name Description
var int
Returns
Type Description
$this

getMetrics

The metrics for the task.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMetrics

The metrics for the task.

Parameter
Name Description
var array<Google\Cloud\BigQuery\Migration\V2\TimeSeries>
Returns
Type Description
$this

getTaskResult

Output only. The result of the task.

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

hasTaskResult

clearTaskResult

setTaskResult

Output only. The result of the task.

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

getTotalProcessingErrorCount

Count of all the processing errors in this task and its subtasks.

Returns
Type Description
int

setTotalProcessingErrorCount

Count of all the processing errors in this task and its subtasks.

Parameter
Name Description
var int
Returns
Type Description
$this

getTotalResourceErrorCount

Count of all the resource errors in this task and its subtasks.

Returns
Type Description
int

setTotalResourceErrorCount

Count of all the resource errors in this task and its subtasks.

Parameter
Name Description
var int
Returns
Type Description
$this

getTaskDetails

Returns
Type Description
string