Class ListHyperparameterTuningJobsRequest.Builder (3.44.0)

public static final class ListHyperparameterTuningJobsRequest.Builder extends GeneratedMessageV3.Builder<ListHyperparameterTuningJobsRequest.Builder> implements ListHyperparameterTuningJobsRequestOrBuilder

Request message for JobService.ListHyperparameterTuningJobs.

Protobuf type google.cloud.aiplatform.v1.ListHyperparameterTuningJobsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListHyperparameterTuningJobsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides

build()

public ListHyperparameterTuningJobsRequest build()
Returns
Type Description
ListHyperparameterTuningJobsRequest

buildPartial()

public ListHyperparameterTuningJobsRequest buildPartial()
Returns
Type Description
ListHyperparameterTuningJobsRequest

clear()

public ListHyperparameterTuningJobsRequest.Builder clear()
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListHyperparameterTuningJobsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides

clearFilter()

public ListHyperparameterTuningJobsRequest.Builder clearFilter()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListHyperparameterTuningJobsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides

clearPageSize()

public ListHyperparameterTuningJobsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 3;

Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

This builder for chaining.

clearPageToken()

public ListHyperparameterTuningJobsRequest.Builder clearPageToken()

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

This builder for chaining.

clearParent()

public ListHyperparameterTuningJobsRequest.Builder clearParent()

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

This builder for chaining.

clearReadMask()

public ListHyperparameterTuningJobsRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

clone()

public ListHyperparameterTuningJobsRequest.Builder clone()
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListHyperparameterTuningJobsRequest getDefaultInstanceForType()
Returns
Type Description
ListHyperparameterTuningJobsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public 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 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 int getPageSize()

The standard list page size.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public 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 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 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 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 FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
Type Description
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListHyperparameterTuningJobsRequest other)

public ListHyperparameterTuningJobsRequest.Builder mergeFrom(ListHyperparameterTuningJobsRequest other)
Parameter
Name Description
other ListHyperparameterTuningJobsRequest
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListHyperparameterTuningJobsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListHyperparameterTuningJobsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListHyperparameterTuningJobsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListHyperparameterTuningJobsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListHyperparameterTuningJobsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides

setFilter(String value)

public ListHyperparameterTuningJobsRequest.Builder setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListHyperparameterTuningJobsRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListHyperparameterTuningJobsRequest.Builder setPageSize(int value)

The standard list page size.

int32 page_size = 3;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListHyperparameterTuningJobsRequest.Builder setPageToken(String value)

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

string page_token = 4;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListHyperparameterTuningJobsRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 4;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

This builder for chaining.

setParent(String value)

public ListHyperparameterTuningJobsRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListHyperparameterTuningJobsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListHyperparameterTuningJobsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListHyperparameterTuningJobsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListHyperparameterTuningJobsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListHyperparameterTuningJobsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListHyperparameterTuningJobsRequest.Builder
Overrides