Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ListBatchPredictionJobsRequest (v0.36.0)

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

Request message for JobService.ListBatchPredictionJobs.

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 =, != comparisons, and : wildcard.
    • model_display_name supports =, != comparisons.
    • 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:*

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    The standard list filter.

    Supported fields:

    • display_name supports =, != comparisons, and : wildcard.
    • model_display_name supports =, != comparisons.
    • 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
  • (::String) —

    The standard list filter.

    Supported fields:

    • display_name supports =, != comparisons, and : wildcard.
    • model_display_name supports =, != comparisons.
    • 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

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

#page_token=

def page_token=(value) -> ::String
Parameter
Returns

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}
Returns
  • (::String) — Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}

#read_mask

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

#read_mask=

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