Class ListTrialsRequest.Builder (3.44.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListTrialsRequest build()
Returns
Type Description
ListTrialsRequest

buildPartial()

public ListTrialsRequest buildPartial()
Returns
Type Description
ListTrialsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTrialsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
ListTrialsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListTrialsRequest getDefaultInstanceForType()
Returns
Type Description
ListTrialsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListTrialsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public ListTrialsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value int

The pageSize to set.

Returns
Type Description
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
Name Description
value String

The pageToken to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
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
Name Description
value String

The parent to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListTrialsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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