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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class ListMetadataJobsRequest (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.ListMetadataJobsRequest)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.ListMetadataJobsRequest)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.ListMetadataJobsRequest)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.ListMetadataJobsRequest)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.ListMetadataJobsRequest)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.ListMetadataJobsRequest)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.ListMetadataJobsRequest)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.ListMetadataJobsRequest)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.ListMetadataJobsRequest)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.ListMetadataJobsRequest)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.ListMetadataJobsRequest)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.ListMetadataJobsRequest)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.ListMetadataJobsRequest)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.ListMetadataJobsRequest)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.ListMetadataJobsRequest)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.ListMetadataJobsRequest)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.ListMetadataJobsRequest)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.ListMetadataJobsRequest)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.ListMetadataJobsRequest)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.ListMetadataJobsRequest)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.ListMetadataJobsRequest)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.ListMetadataJobsRequest)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.ListMetadataJobsRequest)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.ListMetadataJobsRequest) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class ListMetadataJobsRequest.\n\nList metadata jobs request.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.ListMetadataJobsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The resource name of the parent location, in the format\n`projects/{project_id_or_number}/locations/{location_id}`\n\n### setParent\n\nRequired. The resource name of the parent location, in the format\n`projects/{project_id_or_number}/locations/{location_id}`\n\n### getPageSize\n\nOptional. The maximum number of metadata jobs to return. The service might\nreturn fewer jobs than this value. If unspecified, at most 10 jobs are\nreturned. The maximum value is 1,000.\n\n### setPageSize\n\nOptional. The maximum number of metadata jobs to return. The service might\nreturn fewer jobs than this value. If unspecified, at most 10 jobs are\nreturned. The maximum value is 1,000.\n\n### getPageToken\n\nOptional. The page token received from a previous `ListMetadataJobs` call.\n\nProvide this token to retrieve the subsequent page of results. When\npaginating, all other parameters that are provided to the\n`ListMetadataJobs` request must match the call that provided the page\ntoken.\n\n### setPageToken\n\nOptional. The page token received from a previous `ListMetadataJobs` call.\n\nProvide this token to retrieve the subsequent page of results. When\npaginating, all other parameters that are provided to the\n`ListMetadataJobs` request must match the call that provided the page\ntoken.\n\n### getFilter\n\nOptional. Filter request. Filters are case-sensitive.\n\nThe service supports the following formats:\n\n- `labels.key1 = \"value1\"`\n- `labels:key1`\n- `name = \"value\"` You can combine filters with `AND`, `OR`, and `NOT` operators.\n\n### setFilter\n\nOptional. Filter request. Filters are case-sensitive.\n\nThe service supports the following formats:\n\n- `labels.key1 = \"value1\"`\n- `labels:key1`\n- `name = \"value\"` You can combine filters with `AND`, `OR`, and `NOT` operators.\n\n### getOrderBy\n\nOptional. The field to sort the results by, either `name` or `create_time`.\n\nIf not specified, the ordering is undefined.\n\n### setOrderBy\n\nOptional. The field to sort the results by, either `name` or `create_time`.\n\nIf not specified, the ordering is undefined.\n\n### static::build"]]