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

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

A request to list previously created migration workflows.

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

Namespace

Google \ Cloud \ BigQuery \ Migration \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The project and location of the migration workflows to list. Example: projects/123/locations/us

↳ read_mask Google\Protobuf\FieldMask

The list of fields to be retrieved.

↳ page_size int

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

↳ page_token string

A page token, received from previous ListMigrationWorkflows call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMigrationWorkflows must match the call that provided the page token.

getParent

Required. The project and location of the migration workflows to list.

Example: projects/123/locations/us

Returns
TypeDescription
string

setParent

Required. The project and location of the migration workflows to list.

Example: projects/123/locations/us

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

The list of fields to be retrieved.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

The list of fields to be retrieved.

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

getPageSize

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

Returns
TypeDescription
int

setPageSize

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A page token, received from previous ListMigrationWorkflows call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMigrationWorkflows must match the call that provided the page token.

Returns
TypeDescription
string

setPageToken

A page token, received from previous ListMigrationWorkflows call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMigrationWorkflows must match the call that provided the page token.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The project and location of the migration workflows to list. Example: projects/123/locations/us Please see Google\Cloud\BigQuery\Migration\V2\MigrationServiceClient::locationName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\BigQuery\Migration\V2\ListMigrationWorkflowsRequest