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 \ V2Methods
__construct
Constructor.
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
↳ last_update_time
↳ metrics
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
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
var
string
$this
getTaskId
The unique ID of the task to which this subtask belongs.
string
setTaskId
The unique ID of the task to which this subtask belongs.
var
string
$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.
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.
var
string
$this
getState
Output only. The current state of the subtask.
int
setState
Output only. The current state of the subtask.
var
int
$this
getProcessingError
Output only. An explanation that may be populated when the task is in FAILED state.
hasProcessingError
clearProcessingError
setProcessingError
Output only. An explanation that may be populated when the task is in FAILED state.
$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.
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.
$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
.
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
.
var
int
$this
getCreateTime
Time when the subtask was created.
hasCreateTime
clearCreateTime
setCreateTime
Time when the subtask was created.
$this
getLastUpdateTime
Time when the subtask was last updated.
hasLastUpdateTime
clearLastUpdateTime
setLastUpdateTime
Time when the subtask was last updated.
$this
getMetrics
The metrics for the subtask.
setMetrics
The metrics for the subtask.
$this