Class SuggestTrialsRequest.Builder (3.12.0)

public static final class SuggestTrialsRequest.Builder extends GeneratedMessageV3.Builder<SuggestTrialsRequest.Builder> implements SuggestTrialsRequestOrBuilder

Request message for VizierService.SuggestTrials.

Protobuf type google.cloud.aiplatform.v1beta1.SuggestTrialsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SuggestTrialsRequest build()
Returns
TypeDescription
SuggestTrialsRequest

buildPartial()

public SuggestTrialsRequest buildPartial()
Returns
TypeDescription
SuggestTrialsRequest

clear()

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

clearClientId()

public SuggestTrialsRequest.Builder clearClientId()

Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

string client_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SuggestTrialsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public SuggestTrialsRequest.Builder clearParent()

Required. The project and location that the Study belongs to. Format: projects/{project}/locations/{location}/studies/{study}

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

Returns
TypeDescription
SuggestTrialsRequest.Builder

This builder for chaining.

clearSuggestionCount()

public SuggestTrialsRequest.Builder clearSuggestionCount()

Required. The number of suggestions requested. It must be positive.

int32 suggestion_count = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
SuggestTrialsRequest.Builder

This builder for chaining.

clone()

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

getClientId()

public String getClientId()

Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

string client_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The clientId.

getClientIdBytes()

public ByteString getClientIdBytes()

Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

string client_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for clientId.

getDefaultInstanceForType()

public SuggestTrialsRequest getDefaultInstanceForType()
Returns
TypeDescription
SuggestTrialsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getParent()

public String getParent()

Required. The project and location that the Study belongs to. 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 project and location that the Study belongs to. 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.

getSuggestionCount()

public int getSuggestionCount()

Required. The number of suggestions requested. It must be positive.

int32 suggestion_count = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The suggestionCount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SuggestTrialsRequest other)

public SuggestTrialsRequest.Builder mergeFrom(SuggestTrialsRequest other)
Parameter
NameDescription
otherSuggestTrialsRequest
Returns
TypeDescription
SuggestTrialsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setClientId(String value)

public SuggestTrialsRequest.Builder setClientId(String value)

Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

string client_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The clientId to set.

Returns
TypeDescription
SuggestTrialsRequest.Builder

This builder for chaining.

setClientIdBytes(ByteString value)

public SuggestTrialsRequest.Builder setClientIdBytes(ByteString value)

Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

string client_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for clientId to set.

Returns
TypeDescription
SuggestTrialsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public SuggestTrialsRequest.Builder setParent(String value)

Required. The project and location that the Study belongs to. 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
SuggestTrialsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public SuggestTrialsRequest.Builder setParentBytes(ByteString value)

Required. The project and location that the Study belongs to. 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
SuggestTrialsRequest.Builder

This builder for chaining.

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

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

setSuggestionCount(int value)

public SuggestTrialsRequest.Builder setSuggestionCount(int value)

Required. The number of suggestions requested. It must be positive.

int32 suggestion_count = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueint

The suggestionCount to set.

Returns
TypeDescription
SuggestTrialsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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