Package com.google.cloud.aiplatform.v1

Class StudySpec.ParameterSpec

  • All Implemented Interfaces:
    StudySpec.ParameterSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    StudySpec
    public static final class StudySpec.ParameterSpec
extends com.google.protobuf.GeneratedMessageV3
implements StudySpec.ParameterSpecOrBuilder
     Represents a single parameter to optimize.
    Protobuf type google.cloud.aiplatform.v1.StudySpec.ParameterSpec
    See Also:
    Serialized Form

    • Field Detail

      • DOUBLE_VALUE_SPEC_FIELD_NUMBER

        public static final int DOUBLE_VALUE_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INTEGER_VALUE_SPEC_FIELD_NUMBER

        public static final int INTEGER_VALUE_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CATEGORICAL_VALUE_SPEC_FIELD_NUMBER

        public static final int CATEGORICAL_VALUE_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISCRETE_VALUE_SPEC_FIELD_NUMBER

        public static final int DISCRETE_VALUE_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARAMETER_ID_FIELD_NUMBER

        public static final int PARAMETER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCALE_TYPE_FIELD_NUMBER

        public static final int SCALE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONDITIONAL_PARAMETER_SPECS_FIELD_NUMBER

        public static final int CONDITIONAL_PARAMETER_SPECS_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

      • hasDoubleValueSpec

        public boolean hasDoubleValueSpec()
         The value spec for a 'DOUBLE' parameter.
        .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;
        Specified by:
        hasDoubleValueSpec in interface StudySpec.ParameterSpecOrBuilder
        Returns:
        Whether the doubleValueSpec field is set.

      • hasIntegerValueSpec

        public boolean hasIntegerValueSpec()
         The value spec for an 'INTEGER' parameter.
        .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;
        Specified by:
        hasIntegerValueSpec in interface StudySpec.ParameterSpecOrBuilder
        Returns:
        Whether the integerValueSpec field is set.

      • hasCategoricalValueSpec

        public boolean hasCategoricalValueSpec()
         The value spec for a 'CATEGORICAL' parameter.
        .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;
        Specified by:
        hasCategoricalValueSpec in interface StudySpec.ParameterSpecOrBuilder
        Returns:
        Whether the categoricalValueSpec field is set.

      • hasDiscreteValueSpec

        public boolean hasDiscreteValueSpec()
         The value spec for a 'DISCRETE' parameter.
        .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;
        Specified by:
        hasDiscreteValueSpec in interface StudySpec.ParameterSpecOrBuilder
        Returns:
        Whether the discreteValueSpec field is set.

      • getParameterId

        public String getParameterId()
         Required. The ID of the parameter. Must not contain whitespaces and must
 be unique amongst all ParameterSpecs.
        string parameter_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getParameterId in interface StudySpec.ParameterSpecOrBuilder
        Returns:
        The parameterId.

      • getParameterIdBytes

        public com.google.protobuf.ByteString getParameterIdBytes()
         Required. The ID of the parameter. Must not contain whitespaces and must
 be unique amongst all ParameterSpecs.
        string parameter_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getParameterIdBytes in interface StudySpec.ParameterSpecOrBuilder
        Returns:
        The bytes for parameterId.

      • getScaleTypeValue

        public int getScaleTypeValue()
         How the parameter should be scaled.
 Leave unset for `CATEGORICAL` parameters.
        .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ScaleType scale_type = 6;
        Specified by:
        getScaleTypeValue in interface StudySpec.ParameterSpecOrBuilder
        Returns:
        The enum numeric value on the wire for scaleType.

      • getConditionalParameterSpecsCount

        public int getConditionalParameterSpecsCount()
         A conditional parameter node is active if the parameter's value matches
 the conditional node's parent_value_condition.

 If two items in conditional_parameter_specs have the same name, they
 must have disjoint parent_value_condition.
        repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;
        Specified by:
        getConditionalParameterSpecsCount in interface StudySpec.ParameterSpecOrBuilder

      • getConditionalParameterSpecs

        public StudySpec.ParameterSpec.ConditionalParameterSpec getConditionalParameterSpecs​(int index)
         A conditional parameter node is active if the parameter's value matches
 the conditional node's parent_value_condition.

 If two items in conditional_parameter_specs have the same name, they
 must have disjoint parent_value_condition.
        repeated .google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;
        Specified by:
        getConditionalParameterSpecs in interface StudySpec.ParameterSpecOrBuilder

      • 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 StudySpec.ParameterSpec parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<StudySpec.ParameterSpec> 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 StudySpec.ParameterSpec getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder