Interface ListHyperparameterTuningJobsRequestOrBuilder (3.77.0)

public interface ListHyperparameterTuningJobsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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:*`

string filter = 2;

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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:*`

string filter = 2;

Returns
Type	Description
ByteString	The bytes for filter.

getPageSize()

public abstract int getPageSize()

The standard list page size.

int32 page_size = 3;

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

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

string page_token = 4;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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

string page_token = 4;

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.

getReadMask()

public abstract FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type	Description
FieldMask	The readMask.

getReadMaskOrBuilder()

public abstract FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type	Description
FieldMaskOrBuilder

hasReadMask()

public abstract boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type	Description
boolean	Whether the readMask field is set.