Class ListTrialsRequest.Builder (3.31.0)

public static final class ListTrialsRequest.Builder extends GeneratedMessageV3.Builder<ListTrialsRequest.Builder> implements ListTrialsRequestOrBuilder

Request message for VizierService.ListTrials.

Protobuf type google.cloud.aiplatform.v1.ListTrialsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTrialsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides

build()

public ListTrialsRequest build()
Returns
TypeDescription
ListTrialsRequest

buildPartial()

public ListTrialsRequest buildPartial()
Returns
TypeDescription
ListTrialsRequest

clear()

public ListTrialsRequest.Builder clear()
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListTrialsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTrialsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides

clearPageSize()

public ListTrialsRequest.Builder clearPageSize()

Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListTrialsRequest.Builder

This builder for chaining.

clearPageToken()

public ListTrialsRequest.Builder clearPageToken()

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListTrialsRequest.Builder

This builder for chaining.

clearParent()

public ListTrialsRequest.Builder clearParent()

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

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

Returns
TypeDescription
ListTrialsRequest.Builder

This builder for chaining.

clone()

public ListTrialsRequest.Builder clone()
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListTrialsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListTrialsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListTrialsRequest other)

public ListTrialsRequest.Builder mergeFrom(ListTrialsRequest other)
Parameter
NameDescription
otherListTrialsRequest
Returns
TypeDescription
ListTrialsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListTrialsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListTrialsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListTrialsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListTrialsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides

setPageSize(int value)

public ListTrialsRequest.Builder setPageSize(int value)

Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListTrialsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTrialsRequest.Builder setPageToken(String value)

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListTrialsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTrialsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListTrialsRequest.Builder

This builder for chaining.

setParent(String value)

public ListTrialsRequest.Builder setParent(String value)

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListTrialsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListTrialsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListTrialsRequest.Builder

This builder for chaining.

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

public ListTrialsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListTrialsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListTrialsRequest.Builder
Overrides