Package com.google.cloud.aiplatform.v1

Class CompleteTrialRequest

  • All Implemented Interfaces:
    CompleteTrialRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CompleteTrialRequest
extends com.google.protobuf.GeneratedMessageV3
implements CompleteTrialRequestOrBuilder
     Request message for
 [VizierService.CompleteTrial][google.cloud.aiplatform.v1.VizierService.CompleteTrial].
    Protobuf type google.cloud.aiplatform.v1.CompleteTrialRequest
    See Also:
    Serialized Form

    • Field Detail

      • FINAL_MEASUREMENT_FIELD_NUMBER

        public static final int FINAL_MEASUREMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRIAL_INFEASIBLE_FIELD_NUMBER

        public static final int TRIAL_INFEASIBLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INFEASIBLE_REASON_FIELD_NUMBER

        public static final int INFEASIBLE_REASON_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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) = { ... }
        Specified by:
        getName in interface CompleteTrialRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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) = { ... }
        Specified by:
        getNameBytes in interface CompleteTrialRequestOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        hasFinalMeasurement in interface CompleteTrialRequestOrBuilder
        Returns:
        Whether the finalMeasurement field is set.

      • 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];
        Specified by:
        getFinalMeasurement in interface CompleteTrialRequestOrBuilder
        Returns:
        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];
        Specified by:
        getFinalMeasurementOrBuilder in interface CompleteTrialRequestOrBuilder

      • 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];
        Specified by:
        getTrialInfeasible in interface CompleteTrialRequestOrBuilder
        Returns:
        The trialInfeasible.

      • 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];
        Specified by:
        getInfeasibleReason in interface CompleteTrialRequestOrBuilder
        Returns:
        The infeasibleReason.

      • getInfeasibleReasonBytes

        public 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];
        Specified by:
        getInfeasibleReasonBytes in interface CompleteTrialRequestOrBuilder
        Returns:
        The bytes for infeasibleReason.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CompleteTrialRequest parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteTrialRequest parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteTrialRequest parseFrom​(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteTrialRequest parseFrom​(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteTrialRequest parseFrom​(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteTrialRequest parseFrom​(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public CompleteTrialRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CompleteTrialRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CompleteTrialRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<CompleteTrialRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CompleteTrialRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder