Package com.google.cloud.aiplatform.v1
Interface CompleteTrialRequestOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
CompleteTrialRequest
,CompleteTrialRequest.Builder
public interface CompleteTrialRequestOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Measurement
getFinalMeasurement()
Optional.MeasurementOrBuilder
getFinalMeasurementOrBuilder()
Optional.String
getInfeasibleReason()
Optional.com.google.protobuf.ByteString
getInfeasibleReasonBytes()
Optional.String
getName()
Required.com.google.protobuf.ByteString
getNameBytes()
Required.boolean
getTrialInfeasible()
Optional.boolean
hasFinalMeasurement()
Optional.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
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:
- The name.
-
getNameBytes
com.google.protobuf.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:
- The bytes for name.
-
hasFinalMeasurement
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:
- Whether the finalMeasurement field is set.
-
getFinalMeasurement
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:
- The finalMeasurement.
-
getFinalMeasurementOrBuilder
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];
-
getTrialInfeasible
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:
- The trialInfeasible.
-
getInfeasibleReason
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:
- The infeasibleReason.
-
getInfeasibleReasonBytes
com.google.protobuf.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:
- The bytes for infeasibleReason.
-
-