Class: Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsRequest

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.ListHyperparameterTuningJobs.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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

  • (::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:*


321
322
323
324
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 321

class ListHyperparameterTuningJobsRequest
  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.



321
322
323
324
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 321

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

#page_token ⇒ ::String

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

Returns:



321
322
323
324
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 321

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

#parent ⇒ ::String

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

Returns:

  • (::String) —

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



321
322
323
324
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 321

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

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

Returns Mask specifying which fields to read.

Returns:



321
322
323
324
 
# File 'proto_docs/google/cloud/aiplatform/v1/job_service.rb', line 321

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