Class CompleteTrialRequest (3.31.0)

public final class CompleteTrialRequest extends GeneratedMessageV3 implements CompleteTrialRequestOrBuilder

Request message for VizierService.CompleteTrial.

Protobuf type google.cloud.aiplatform.v1.CompleteTrialRequest

Static Fields

FINAL_MEASUREMENT_FIELD_NUMBER

public static final int FINAL_MEASUREMENT_FIELD_NUMBER
Field Value
TypeDescription
int

INFEASIBLE_REASON_FIELD_NUMBER

public static final int INFEASIBLE_REASON_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TRIAL_INFEASIBLE_FIELD_NUMBER

public static final int TRIAL_INFEASIBLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CompleteTrialRequest getDefaultInstance()
Returns
TypeDescription
CompleteTrialRequest

getDescriptor()

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

newBuilder()

public static CompleteTrialRequest.Builder newBuilder()
Returns
TypeDescription
CompleteTrialRequest.Builder

newBuilder(CompleteTrialRequest prototype)

public static CompleteTrialRequest.Builder newBuilder(CompleteTrialRequest prototype)
Parameter
NameDescription
prototypeCompleteTrialRequest
Returns
TypeDescription
CompleteTrialRequest.Builder

parseDelimitedFrom(InputStream input)

public static CompleteTrialRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteTrialRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CompleteTrialRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompleteTrialRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CompleteTrialRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompleteTrialRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CompleteTrialRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteTrialRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CompleteTrialRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteTrialRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CompleteTrialRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompleteTrialRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteTrialRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CompleteTrialRequest> parser()
Returns
TypeDescription
Parser<CompleteTrialRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CompleteTrialRequest getDefaultInstanceForType()
Returns
TypeDescription
CompleteTrialRequest

getFinalMeasurement()

public Measurement getFinalMeasurement()

Optional. If provided, it will be used as the completed Trial's final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement

.google.cloud.aiplatform.v1.Measurement final_measurement = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Measurement

The finalMeasurement.

getFinalMeasurementOrBuilder()

public MeasurementOrBuilder getFinalMeasurementOrBuilder()

Optional. If provided, it will be used as the completed Trial's final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement

.google.cloud.aiplatform.v1.Measurement final_measurement = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
MeasurementOrBuilder

getInfeasibleReason()

public String getInfeasibleReason()

Optional. A human readable reason why the trial was infeasible. This should only be provided if trial_infeasible is true.

string infeasible_reason = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The infeasibleReason.

getInfeasibleReasonBytes()

public ByteString getInfeasibleReasonBytes()

Optional. A human readable reason why the trial was infeasible. This should only be provided if trial_infeasible is true.

string infeasible_reason = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for infeasibleReason.

getName()

public String getName()

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The Trial's name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<CompleteTrialRequest> getParserForType()
Returns
TypeDescription
Parser<CompleteTrialRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTrialInfeasible()

public boolean getTrialInfeasible()

Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.

bool trial_infeasible = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The trialInfeasible.

hasFinalMeasurement()

public boolean hasFinalMeasurement()

Optional. If provided, it will be used as the completed Trial's final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement

.google.cloud.aiplatform.v1.Measurement final_measurement = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the finalMeasurement field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CompleteTrialRequest.Builder newBuilderForType()
Returns
TypeDescription
CompleteTrialRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompleteTrialRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CompleteTrialRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CompleteTrialRequest.Builder toBuilder()
Returns
TypeDescription
CompleteTrialRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException