Google Cloud Ai Platform V1 Client - Class ListCustomJobsRequest (0.10.0)

Version 0.10.0

• 1.12.0 (latest)
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListCustomJobsRequest.

Request message for JobService.ListCustomJobs.

Generated from protobuf message google.cloud.aiplatform.v1.ListCustomJobsRequest

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The resource name of the Location to list the CustomJobs from. Format: projects/{project}/locations/{location}
↳ filter	string The standard list filter. Supported fields: * display_name supports =, != comparisons, and : wildcard. * state supports =, != comparisons. * create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format. * labels supports general map functions that is: labels.key=value - key:value equality labels.key:* - key existence Some examples of using the filter are: *state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_"*state!="JOB_STATE_FAILED" OR display_name="my_job"*NOT display_name="my_job"*create_time>"2021-05-18T00:00:00Z"*labels.keyA=valueA*labels.keyB:`
↳ page_size	int The standard list page size.
↳ page_token	string The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.
↳ read_mask	Google\Protobuf\FieldMask Mask specifying which fields to read.

getParent

Required. The resource name of the Location to list the CustomJobs from.

Format: projects/{project}/locations/{location}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
string

setParent

Required. The resource name of the Location to list the CustomJobs from.

Format: projects/{project}/locations/{location}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

The standard list filter.

Supported fields:

• display_name supports =, != comparisons, and : wildcard.
• state supports =, != comparisons.
• create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
• labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence Some examples of using the filter are:
• state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
• state!="JOB_STATE_FAILED" OR display_name="my_job"
• NOT display_name="my_job"
• create_time>"2021-05-18T00:00:00Z"
• labels.keyA=valueA
• labels.keyB:*

Generated from protobuf field string filter = 2;

Returns
Type	Description
string

setFilter

The standard list filter.

Supported fields:

• display_name supports =, != comparisons, and : wildcard.
• state supports =, != comparisons.
• create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
• labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence Some examples of using the filter are:
• state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
• state!="JOB_STATE_FAILED" OR display_name="my_job"
• NOT display_name="my_job"
• create_time>"2021-05-18T00:00:00Z"
• labels.keyA=valueA
• labels.keyB:*

Generated from protobuf field string filter = 2;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

The standard list page size.

Generated from protobuf field int32 page_size = 3;

Returns
Type	Description
int

setPageSize

The standard list page size.

Generated from protobuf field int32 page_size = 3;

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

The standard list page token.

Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.

Generated from protobuf field string page_token = 4;

Returns
Type	Description
string

setPageToken

The standard list page token.

Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.

Generated from protobuf field string page_token = 4;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getReadMask

Mask specifying which fields to read.

Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this