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

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
NameDescription
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
TypeDescription
string

setParent

Required. The migration task of the subtasks to list.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Optional. The list of fields to be retrieved.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Optional. The list of fields to be retrieved.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

getPageSize

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

Returns
TypeDescription
int

setPageSize

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

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\BigQuery\Migration\V2\ListMigrationSubtasksRequest