Class CompleteTrialRequest (3.42.0)

public final class CompleteTrialRequest extends GeneratedMessageV3 implements CompleteTrialRequestOrBuilder

Request message for VizierService.CompleteTrial.

Protobuf type google.cloud.aiplatform.v1beta1.CompleteTrialRequest

Static Fields

FINAL_MEASUREMENT_FIELD_NUMBER

public static final int FINAL_MEASUREMENT_FIELD_NUMBER
Field Value
Type Description
int

INFEASIBLE_REASON_FIELD_NUMBER

public static final int INFEASIBLE_REASON_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TRIAL_INFEASIBLE_FIELD_NUMBER

public static final int TRIAL_INFEASIBLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CompleteTrialRequest getDefaultInstance()
Returns
Type Description
CompleteTrialRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CompleteTrialRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CompleteTrialRequest getDefaultInstanceForType()
Returns
Type Description
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.v1beta1.Measurement final_measurement = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
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.v1beta1.Measurement final_measurement = 2 [(.google.api.field_behavior) = OPTIONAL];

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

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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.v1beta1.Measurement final_measurement = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the finalMeasurement field is set.

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 CompleteTrialRequest.Builder newBuilderForType()
Returns
Type Description
CompleteTrialRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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