Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ListCustomJobsRequest (v0.7.0)

Version 0.7.0

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 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.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ListCustomJobsRequest.

Request message for JobService.ListCustomJobs.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String

Returns

• (::String) —

  The standard list filter.

  Supported fields:

  • display_name supports = and !=.

  • state supports = and !=.

  Some examples of using the filter are:

  • state="JOB_STATE_SUCCEEDED" AND display_name="my_job"

  • state="JOB_STATE_RUNNING" OR display_name="my_job"

  • NOT display_name="my_job"

  • state="JOB_STATE_FAILED"

#filter=

def filter=(value) -> ::String

Parameter

• value (::String) —

  The standard list filter.

  Supported fields:

  • display_name supports = and !=.

  • state supports = and !=.

  Some examples of using the filter are:

  • state="JOB_STATE_SUCCEEDED" AND display_name="my_job"

  • state="JOB_STATE_RUNNING" OR display_name="my_job"

  • NOT display_name="my_job"

  • state="JOB_STATE_FAILED"

Returns

• (::String) —

  The standard list filter.

  Supported fields:

  • display_name supports = and !=.

  • state supports = and !=.

  Some examples of using the filter are:

  • state="JOB_STATE_SUCCEEDED" AND display_name="my_job"

  • state="JOB_STATE_RUNNING" OR display_name="my_job"

  • NOT display_name="my_job"

  • state="JOB_STATE_FAILED"

#page_size

def page_size() -> ::Integer

Returns

• (::Integer) — The standard list page size.

#page_size=

def page_size=(value) -> ::Integer

Parameter

• value (::Integer) — The standard list page size.

Returns

• (::Integer) — The standard list page size.

#page_token

def page_token() -> ::String

Returns

• (::String) — The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.

#page_token=

def page_token=(value) -> ::String

Parameter

• value (::String) — The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.

Returns

• (::String) — The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.

#parent

def parent() -> ::String

Returns

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

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — Required. The resource name of the Location to list the CustomJobs from. Format: projects/{project}/locations/{location}

Returns

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

#read_mask

def read_mask() -> ::Google::Protobuf::FieldMask

Returns

• (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.

#read_mask=

def read_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

• value (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.

Returns

• (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.