Class SuggestTrialsRequest (3.4.2)

public final class SuggestTrialsRequest extends GeneratedMessageV3 implements SuggestTrialsRequestOrBuilder

Request message for VizierService.SuggestTrials.

Protobuf type google.cloud.aiplatform.v1.SuggestTrialsRequest

Static Fields

CLIENT_ID_FIELD_NUMBER

public static final int CLIENT_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SUGGESTION_COUNT_FIELD_NUMBER

public static final int SUGGESTION_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SuggestTrialsRequest getDefaultInstance()
Returns
Type Description
SuggestTrialsRequest

getDescriptor()

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

newBuilder()

public static SuggestTrialsRequest.Builder newBuilder()
Returns
Type Description
SuggestTrialsRequest.Builder

newBuilder(SuggestTrialsRequest prototype)

public static SuggestTrialsRequest.Builder newBuilder(SuggestTrialsRequest prototype)
Parameter
Name Description
prototype SuggestTrialsRequest
Returns
Type Description
SuggestTrialsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SuggestTrialsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SuggestTrialsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SuggestTrialsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SuggestTrialsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SuggestTrialsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SuggestTrialsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SuggestTrialsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SuggestTrialsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SuggestTrialsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SuggestTrialsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SuggestTrialsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SuggestTrialsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SuggestTrialsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SuggestTrialsRequest> parser()
Returns
Type Description
Parser<SuggestTrialsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
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
Type Description
ByteString

The bytes for clientId.

getDefaultInstanceForType()

public SuggestTrialsRequest getDefaultInstanceForType()
Returns
Type Description
SuggestTrialsRequest

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
Type Description
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
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<SuggestTrialsRequest> getParserForType()
Returns
Type Description
Parser<SuggestTrialsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSuggestionCount()

public int getSuggestionCount()

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

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

Returns
Type Description
int

The suggestionCount.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SuggestTrialsRequest.Builder newBuilderForType()
Returns
Type Description
SuggestTrialsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SuggestTrialsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SuggestTrialsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SuggestTrialsRequest.Builder toBuilder()
Returns
Type Description
SuggestTrialsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException