Cloud AI Platform v1 API - Class ListCustomJobsRequest (3.0.0) 

public sealed class ListCustomJobsRequest : IMessage<ListCustomJobsRequest>, IEquatable<ListCustomJobsRequest>, IDeepCloneable<ListCustomJobsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Cloud AI Platform v1 API class ListCustomJobsRequest.

Request message for [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs].

Inheritance

object > ListCustomJobsRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListCustomJobsRequest()

public ListCustomJobsRequest()

ListCustomJobsRequest(ListCustomJobsRequest)

public ListCustomJobsRequest(ListCustomJobsRequest other)
Parameter
Name Description
other ListCustomJobsRequest

Properties

Filter

public string Filter { get; set; }

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:*
Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

The standard list page size.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

The standard list page token. Typically obtained via [ListCustomJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListCustomJobsResponse.next_page_token] of the previous [JobService.ListCustomJobs][google.cloud.aiplatform.v1.JobService.ListCustomJobs] call.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The resource name of the Location to list the CustomJobs from. Format: projects/{project}/locations/{location}

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

ReadMask

public FieldMask ReadMask { get; set; }

Mask specifying which fields to read.

Property Value
Type Description
FieldMask