Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ListHyperparameterTuningJobsRequest (v0.2.0)

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

Request message for JobService.ListHyperparameterTuningJobs.

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

#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 HyperparameterTuningJobs from. Format: projects/{project}/locations/{location}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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}

#read_mask

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

#read_mask=

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