Google Cloud Dataplex V1 Client - Class ListMetadataJobsRequest (1.1.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListMetadataJobsRequest.

List metadata jobs request.

Generated from protobuf message google.cloud.dataplex.v1.ListMetadataJobsRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}
↳ page_size int

Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.
↳ page_token string

Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.
↳ filter string

Optional. Filter request. Filters are case-sensitive. The service supports the following formats: * * labels.key1 = "value1" * * labels:key1 * * name = "value" You can combine filters with AND, OR, and NOT operators.
↳ order_by string

Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.

getParent

Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}

Returns
Type Description
string

setParent

Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The page token received from a previous ListMetadataJobs call.

Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Optional. The page token received from a previous ListMetadataJobs call.

Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filter request. Filters are case-sensitive.

The service supports the following formats:

  • labels.key1 = "value1"
  • labels:key1
  • name = "value" You can combine filters with AND, OR, and NOT operators.
Returns
Type Description
string

setFilter

Optional. Filter request. Filters are case-sensitive.

The service supports the following formats:

  • labels.key1 = "value1"
  • labels:key1
  • name = "value" You can combine filters with AND, OR, and NOT operators.
Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. The field to sort the results by, either name or create_time.

If not specified, the ordering is undefined.

Returns
Type Description
string

setOrderBy

Optional. The field to sort the results by, either name or create_time.

If not specified, the ordering is undefined.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} Please see CatalogServiceClient::locationName() for help formatting this field.
Returns
Type Description
ListMetadataJobsRequest