Google Cloud BigQuery Migration V2 Client - Class MigrationSubtask (1.0.0)

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

A subtask for a migration which carries details about the configuration of the subtask. The content of the details should not matter to the end user, but is a contract between the subtask creator and subtask worker.

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

Namespace

Google \ Cloud \ BigQuery \ Migration \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. Immutable. The resource name for the migration subtask. The ID is server-generated. Example: projects/123/locations/us/workflows/345/subtasks/678
↳ task_id string

The unique ID of the task to which this subtask belongs.
↳ type string

The type of the Subtask. The migration service does not check whether this is a known type. It is up to the task creator (i.e. orchestrator or worker) to ensure it only creates subtasks for which there are compatible workers polling for Subtasks.
↳ state int

Output only. The current state of the subtask.
↳ processing_error Google\Rpc\ErrorInfo

Output only. An explanation that may be populated when the task is in FAILED state.
↳ resource_error_details array<Google\Cloud\BigQuery\Migration\V2\ResourceErrorDetail>

Output only. Provides details to errors and issues encountered while processing the subtask. Presence of error details does not mean that the subtask 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.
↳ create_time Google\Protobuf\Timestamp

Time when the subtask was created.
↳ last_update_time Google\Protobuf\Timestamp

Time when the subtask was last updated.
↳ metrics array<Google\Cloud\BigQuery\Migration\V2\TimeSeries>

The metrics for the subtask.

getName

Output only. Immutable. The resource name for the migration subtask. The ID is server-generated.

Example: projects/123/locations/us/workflows/345/subtasks/678

Returns
Type Description
string

setName

Output only. Immutable. The resource name for the migration subtask. The ID is server-generated.

Example: projects/123/locations/us/workflows/345/subtasks/678

Parameter
Name Description
var string
Returns
Type Description
$this

getTaskId

The unique ID of the task to which this subtask belongs.

Returns
Type Description
string

setTaskId

The unique ID of the task to which this subtask belongs.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

The type of the Subtask. The migration service does not check whether this is a known type. It is up to the task creator (i.e. orchestrator or worker) to ensure it only creates subtasks for which there are compatible workers polling for Subtasks.

Returns
Type Description
string

setType

The type of the Subtask. The migration service does not check whether this is a known type. It is up to the task creator (i.e. orchestrator or worker) to ensure it only creates subtasks for which there are compatible workers polling for Subtasks.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The current state of the subtask.

Returns
Type Description
int

setState

Output only. The current state of the subtask.

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

getResourceErrorDetails

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setResourceErrorDetails

Output only. Provides details to errors and issues encountered while processing the subtask. Presence of error details does not mean that the subtask 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

getCreateTime

Time when the subtask was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Time when the subtask was created.

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

getLastUpdateTime

Time when the subtask was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastUpdateTime

clearLastUpdateTime

setLastUpdateTime

Time when the subtask was last updated.

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

getMetrics

The metrics for the subtask.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMetrics

The metrics for the subtask.

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