Google Cloud Dms V1 Client - Class ListMigrationJobsRequest (1.5.5)

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

Retrieves a list of all migration jobs in a given project and location.

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

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 migrationJobs.

↳ page_size int

The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.

↳ page_token string

The nextPageToken value received in the previous call to migrationJobs.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 migrationJobs.list must match the call that provided the page token.

↳ filter string

A filter expression that filters migration jobs 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 migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.

↳ order_by string

Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".

getParent

Required. The parent which owns this collection of migrationJobs.

Returns
Type Description
string

setParent

Required. The parent which owns this collection of migrationJobs.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.

Returns
Type Description
int

setPageSize

The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The nextPageToken value received in the previous call to migrationJobs.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 migrationJobs.list must match the call that provided the page token.

Returns
Type Description
string

setPageToken

The nextPageToken value received in the previous call to migrationJobs.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 migrationJobs.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 migration jobs 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 migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.

Returns
Type Description
string

setFilter

A filter expression that filters migration jobs 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 migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Sort the results based on the migration job name.

Valid values are: "name", "name asc", and "name desc".

Returns
Type Description
string

setOrderBy

Sort the results based on the migration job name.

Valid values are: "name", "name asc", and "name desc".

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

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

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