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 messagegoogle.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.
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 aresource_error_countthat is higher than the size ofresource_error_details.
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.
Output only. Provides details to errors and issues encountered while
processing the subtask. Presence of error details does not mean that the
subtask failed.
Output only. Provides details to errors and issues encountered while
processing the subtask. Presence of error details does not mean that the
subtask failed.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud BigQuery Migration V2 Client - Class MigrationSubtask (1.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.5 (latest)](/php/docs/reference/cloud-bigquery-migration/latest/V2.MigrationSubtask)\n- [1.1.4](/php/docs/reference/cloud-bigquery-migration/1.1.4/V2.MigrationSubtask)\n- [1.0.0](/php/docs/reference/cloud-bigquery-migration/1.0.0/V2.MigrationSubtask)\n- [0.4.5](/php/docs/reference/cloud-bigquery-migration/0.4.5/V2.MigrationSubtask)\n- [0.3.3](/php/docs/reference/cloud-bigquery-migration/0.3.3/V2.MigrationSubtask)\n- [0.2.2](/php/docs/reference/cloud-bigquery-migration/0.2.2/V2.MigrationSubtask)\n- [0.1.4](/php/docs/reference/cloud-bigquery-migration/0.1.4/V2.MigrationSubtask) \nReference documentation and code samples for the Google Cloud BigQuery Migration V2 Client class MigrationSubtask.\n\nA subtask for a migration which carries details about the configuration of\nthe subtask. The content of the details should not matter to the end user,\nbut is a contract between the subtask creator and subtask worker.\n\nGenerated from protobuf message `google.cloud.bigquery.migration.v2.MigrationSubtask`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ Migration \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Immutable. The resource name for the migration subtask. The ID\nis server-generated.\n\nExample: `projects/123/locations/us/workflows/345/subtasks/678`\n\n### setName\n\nOutput only. Immutable. The resource name for the migration subtask. The ID\nis server-generated.\n\nExample: `projects/123/locations/us/workflows/345/subtasks/678`\n\n### getTaskId\n\nThe unique ID of the task to which this subtask belongs.\n\n### setTaskId\n\nThe unique ID of the task to which this subtask belongs.\n\n### getType\n\nThe type of the Subtask. The migration service does not check whether this\nis a known type. It is up to the task creator (i.e. orchestrator or worker)\nto ensure it only creates subtasks for which there are compatible workers\npolling for Subtasks.\n\n### setType\n\nThe type of the Subtask. The migration service does not check whether this\nis a known type. It is up to the task creator (i.e. orchestrator or worker)\nto ensure it only creates subtasks for which there are compatible workers\npolling for Subtasks.\n\n### getState\n\nOutput only. The current state of the subtask.\n\n### setState\n\nOutput only. The current state of the subtask.\n\n### getProcessingError\n\nOutput only. An explanation that may be populated when the task is in\nFAILED state.\n\n### hasProcessingError\n\n### clearProcessingError\n\n### setProcessingError\n\nOutput only. An explanation that may be populated when the task is in\nFAILED state.\n\n### getResourceErrorDetails\n\nOutput only. Provides details to errors and issues encountered while\nprocessing the subtask. Presence of error details does not mean that the\nsubtask failed.\n\n### setResourceErrorDetails\n\nOutput only. Provides details to errors and issues encountered while\nprocessing the subtask. Presence of error details does not mean that the\nsubtask failed.\n\n### getResourceErrorCount\n\nThe number or resources with errors. Note: This is not the total\nnumber of errors as each resource can have more than one error.\n\nThis is used to indicate truncation by having a `resource_error_count`\nthat is higher than the size of `resource_error_details`.\n\n### setResourceErrorCount\n\nThe number or resources with errors. Note: This is not the total\nnumber of errors as each resource can have more than one error.\n\nThis is used to indicate truncation by having a `resource_error_count`\nthat is higher than the size of `resource_error_details`.\n\n### getCreateTime\n\nTime when the subtask was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nTime when the subtask was created.\n\n### getLastUpdateTime\n\nTime when the subtask was last updated.\n\n### hasLastUpdateTime\n\n### clearLastUpdateTime\n\n### setLastUpdateTime\n\nTime when the subtask was last updated.\n\n### getMetrics\n\nThe metrics for the subtask.\n\n### setMetrics\n\nThe metrics for the subtask."]]
