Google Cloud Dms V1 Client - Class ListConversionWorkspacesRequest (2.0.1)

Reference documentation and code samples for the Google Cloud Dms V1 Client class ListConversionWorkspacesRequest.

Retrieve a list of all conversion workspaces in a given project and location.

Generated from protobuf message google.cloud.clouddms.v1.ListConversionWorkspacesRequest

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent which owns this collection of conversion workspaces.

↳ page_size int

The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets are returned.

↳ page_token string

The nextPageToken value received in the previous call to conversionWorkspaces.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspaces.list must match the call that provided the page token.

↳ filter string

A filter expression that filters conversion workspaces listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list conversion workspaces created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify source.version = "12.c.1" to select all conversion workspaces with source database version equal to 12.c.1.

getParent

Required. The parent which owns this collection of conversion workspaces.

Returns
Type Description
string

setParent

Required. The parent which owns this collection of conversion workspaces.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets are returned.

Returns
Type Description
int

setPageSize

The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets are returned.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The nextPageToken value received in the previous call to conversionWorkspaces.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspaces.list must match the call that provided the page token.

Returns
Type Description
string

setPageToken

The nextPageToken value received in the previous call to conversionWorkspaces.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspaces.list must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

A filter expression that filters conversion workspaces listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list conversion workspaces created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify source.version = "12.c.1" to select all conversion workspaces with source database version equal to 12.c.1.

Returns
Type Description
string

setFilter

A filter expression that filters conversion workspaces listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list conversion workspaces created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify source.version = "12.c.1" to select all conversion workspaces with source database version equal to 12.c.1.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent which owns this collection of conversion workspaces. Please see Google\Cloud\CloudDms\V1\DataMigrationServiceClient::locationName() for help formatting this field.

Returns
Type Description
Google\Cloud\CloudDms\V1\ListConversionWorkspacesRequest