Google Cloud BigQuery Migration V2 Client - Class ListMigrationSubtasksRequest (0.4.3)

Version latest

• 0.4.3 (latest)
• 0.4.0
• 0.3.3
• 0.2.2
• 0.1.4

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

A request to list previously created migration subtasks.

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

Namespace

Google \ Cloud \ BigQuery \ Migration \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234
↳ read_mask	Google\Protobuf\FieldMask Optional. The list of fields to be retrieved.
↳ page_size	int Optional. The maximum number of migration tasks to return. The service may return fewer than this number.
↳ page_token	string Optional. A page token, received from previous ListMigrationSubtasks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMigrationSubtasks must match the call that provided the page token.
↳ filter	string Optional. The filter to apply. This can be used to get the subtasks of a specific tasks in a workflow, e.g. migration_task = "ab012" where "ab012" is the task ID (not the name in the named map).

getParent

Required. The migration task of the subtasks to list.

Example: projects/123/locations/us/workflows/1234

Returns
Type	Description
string

setParent

Required. The migration task of the subtasks to list.

Example: projects/123/locations/us/workflows/1234

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getReadMask

Optional. The list of fields to be retrieved.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Optional. The list of fields to be retrieved.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of migration tasks to return. The service may return fewer than this number.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of migration tasks to return. The service may return fewer than this number.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. A page token, received from previous ListMigrationSubtasks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMigrationSubtasks must match the call that provided the page token.

Returns
Type	Description
string

setPageToken

Optional. A page token, received from previous ListMigrationSubtasks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListMigrationSubtasks must match the call that provided the page token.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

Optional. The filter to apply. This can be used to get the subtasks of a specific tasks in a workflow, e.g. migration_task = "ab012" where "ab012" is the task ID (not the name in the named map).

Returns
Type	Description
string

setFilter

Optional. The filter to apply. This can be used to get the subtasks of a specific tasks in a workflow, e.g. migration_task = "ab012" where "ab012" is the task ID (not the name in the named map).

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234 Please see Google\Cloud\BigQuery\Migration\V2\MigrationServiceClient::migrationWorkflowName() for help formatting this field.

Returns
Type	Description
Google\Cloud\BigQuery\Migration\V2\ListMigrationSubtasksRequest