Class CompleteTrialRequest.Builder (3.42.0)

public static final class CompleteTrialRequest.Builder extends GeneratedMessageV3.Builder<CompleteTrialRequest.Builder> implements CompleteTrialRequestOrBuilder

Request message for VizierService.CompleteTrial.

Protobuf type google.cloud.aiplatform.v1.CompleteTrialRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CompleteTrialRequest build()
Returns
Type Description
CompleteTrialRequest

buildPartial()

public CompleteTrialRequest buildPartial()
Returns
Type Description
CompleteTrialRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFinalMeasurement()

public CompleteTrialRequest.Builder clearFinalMeasurement()

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
Type Description
CompleteTrialRequest.Builder

clearInfeasibleReason()

public CompleteTrialRequest.Builder clearInfeasibleReason()

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
CompleteTrialRequest.Builder

This builder for chaining.

clearName()

public CompleteTrialRequest.Builder clearName()

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
CompleteTrialRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CompleteTrialRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CompleteTrialRequest.Builder
Overrides

clearTrialInfeasible()

public CompleteTrialRequest.Builder clearTrialInfeasible()

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
CompleteTrialRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public CompleteTrialRequest getDefaultInstanceForType()
Returns
Type Description
CompleteTrialRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

The finalMeasurement.

getFinalMeasurementBuilder()

public Measurement.Builder getFinalMeasurementBuilder()

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
Type Description
Measurement.Builder

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
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.

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

Returns
Type Description
boolean

Whether the finalMeasurement field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFinalMeasurement(Measurement value)

public CompleteTrialRequest.Builder mergeFinalMeasurement(Measurement value)

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];

Parameter
Name Description
value Measurement
Returns
Type Description
CompleteTrialRequest.Builder

mergeFrom(CompleteTrialRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFinalMeasurement(Measurement value)

public CompleteTrialRequest.Builder setFinalMeasurement(Measurement value)

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];

Parameter
Name Description
value Measurement
Returns
Type Description
CompleteTrialRequest.Builder

setFinalMeasurement(Measurement.Builder builderForValue)

public CompleteTrialRequest.Builder setFinalMeasurement(Measurement.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Measurement.Builder
Returns
Type Description
CompleteTrialRequest.Builder

setInfeasibleReason(String value)

public CompleteTrialRequest.Builder setInfeasibleReason(String value)

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];

Parameter
Name Description
value String

The infeasibleReason to set.

Returns
Type Description
CompleteTrialRequest.Builder

This builder for chaining.

setInfeasibleReasonBytes(ByteString value)

public CompleteTrialRequest.Builder setInfeasibleReasonBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for infeasibleReason to set.

Returns
Type Description
CompleteTrialRequest.Builder

This builder for chaining.

setName(String value)

public CompleteTrialRequest.Builder setName(String value)

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) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
CompleteTrialRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CompleteTrialRequest.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
CompleteTrialRequest.Builder

This builder for chaining.

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

public CompleteTrialRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CompleteTrialRequest.Builder
Overrides

setTrialInfeasible(boolean value)

public CompleteTrialRequest.Builder setTrialInfeasible(boolean value)

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];

Parameter
Name Description
value boolean

The trialInfeasible to set.

Returns
Type Description
CompleteTrialRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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