Class: Google::Cloud::AIPlatform::V1::ListCustomJobsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/job_service.rb

Overview

Request message for JobService.ListCustomJobs.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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"



84
85
86
87
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 84

class ListCustomJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns The standard list page size.

Returns:

  • (::Integer) —

    The standard list page size.



84
85
86
87
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 84

class ListCustomJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.

Returns:



84
85
86
87
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 84

class ListCustomJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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}



84
85
86
87
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 84

class ListCustomJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_mask ⇒ ::Google::Protobuf::FieldMask

Returns Mask specifying which fields to read.

Returns:



84
85
86
87
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 84

class ListCustomJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end