Google Cloud Ai Platform V1 Client - Class ListCustomJobsRequest (0.16.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

build

Parameter
NameDescription
parent string

Required. The resource name of the Location to list the CustomJobs from. Format: projects/{project}/locations/{location} Please see {@see \Google\Cloud\AIPlatform\V1\JobServiceClient::locationName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\ListCustomJobsRequest

__construct

Constructor.

Parameters
NameDescription
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}

Returns
TypeDescription
string

setParent

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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:*
Returns
TypeDescription
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:*
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The standard list page size.

Returns
TypeDescription
int

setPageSize

The standard list page size.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The standard list page token.

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

Returns
TypeDescription
string

setPageToken

The standard list page token.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Mask specifying which fields to read.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this