Class StudySpec.ParameterSpec (3.33.0)

public static final class StudySpec.ParameterSpec extends GeneratedMessageV3 implements StudySpec.ParameterSpecOrBuilder

Represents a single parameter to optimize.

Protobuf type google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec

Static Fields

CATEGORICAL_VALUE_SPEC_FIELD_NUMBER

public static final int CATEGORICAL_VALUE_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

CONDITIONAL_PARAMETER_SPECS_FIELD_NUMBER

public static final int CONDITIONAL_PARAMETER_SPECS_FIELD_NUMBER
Field Value
TypeDescription
int

DISCRETE_VALUE_SPEC_FIELD_NUMBER

public static final int DISCRETE_VALUE_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

DOUBLE_VALUE_SPEC_FIELD_NUMBER

public static final int DOUBLE_VALUE_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

INTEGER_VALUE_SPEC_FIELD_NUMBER

public static final int INTEGER_VALUE_SPEC_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETER_ID_FIELD_NUMBER

public static final int PARAMETER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

SCALE_TYPE_FIELD_NUMBER

public static final int SCALE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StudySpec.ParameterSpec getDefaultInstance()
Returns
TypeDescription
StudySpec.ParameterSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StudySpec.ParameterSpec.Builder newBuilder()
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

newBuilder(StudySpec.ParameterSpec prototype)

public static StudySpec.ParameterSpec.Builder newBuilder(StudySpec.ParameterSpec prototype)
Parameter
NameDescription
prototypeStudySpec.ParameterSpec
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.ParameterSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StudySpec.ParameterSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec.ParameterSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.ParameterSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StudySpec.ParameterSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StudySpec.ParameterSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StudySpec.ParameterSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StudySpec.ParameterSpec> parser()
Returns
TypeDescription
Parser<ParameterSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCategoricalValueSpec()

public StudySpec.ParameterSpec.CategoricalValueSpec getCategoricalValueSpec()

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpec

The categoricalValueSpec.

getCategoricalValueSpecOrBuilder()

public StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder getCategoricalValueSpecOrBuilder()

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Returns
TypeDescription
StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

getConditionalParameterSpecs(int index)

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.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec.ConditionalParameterSpec

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.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Returns
TypeDescription
int

getConditionalParameterSpecsList()

public List<StudySpec.ParameterSpec.ConditionalParameterSpec> getConditionalParameterSpecsList()

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.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Returns
TypeDescription
List<ConditionalParameterSpec>

getConditionalParameterSpecsOrBuilder(int index)

public StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder getConditionalParameterSpecsOrBuilder(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.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder

getConditionalParameterSpecsOrBuilderList()

public List<? extends StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder> getConditionalParameterSpecsOrBuilderList()

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.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder>

getDefaultInstanceForType()

public StudySpec.ParameterSpec getDefaultInstanceForType()
Returns
TypeDescription
StudySpec.ParameterSpec

getDiscreteValueSpec()

public StudySpec.ParameterSpec.DiscreteValueSpec getDiscreteValueSpec()

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpec

The discreteValueSpec.

getDiscreteValueSpecOrBuilder()

public StudySpec.ParameterSpec.DiscreteValueSpecOrBuilder getDiscreteValueSpecOrBuilder()

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Returns
TypeDescription
StudySpec.ParameterSpec.DiscreteValueSpecOrBuilder

getDoubleValueSpec()

public StudySpec.ParameterSpec.DoubleValueSpec getDoubleValueSpec()

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Returns
TypeDescription
StudySpec.ParameterSpec.DoubleValueSpec

The doubleValueSpec.

getDoubleValueSpecOrBuilder()

public StudySpec.ParameterSpec.DoubleValueSpecOrBuilder getDoubleValueSpecOrBuilder()

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Returns
TypeDescription
StudySpec.ParameterSpec.DoubleValueSpecOrBuilder

getIntegerValueSpec()

public StudySpec.ParameterSpec.IntegerValueSpec getIntegerValueSpec()

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Returns
TypeDescription
StudySpec.ParameterSpec.IntegerValueSpec

The integerValueSpec.

getIntegerValueSpecOrBuilder()

public StudySpec.ParameterSpec.IntegerValueSpecOrBuilder getIntegerValueSpecOrBuilder()

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Returns
TypeDescription
StudySpec.ParameterSpec.IntegerValueSpecOrBuilder

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

Returns
TypeDescription
String

The parameterId.

getParameterIdBytes()

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

Returns
TypeDescription
ByteString

The bytes for parameterId.

getParameterValueSpecCase()

public StudySpec.ParameterSpec.ParameterValueSpecCase getParameterValueSpecCase()
Returns
TypeDescription
StudySpec.ParameterSpec.ParameterValueSpecCase

getParserForType()

public Parser<StudySpec.ParameterSpec> getParserForType()
Returns
TypeDescription
Parser<ParameterSpec>
Overrides

getScaleType()

public StudySpec.ParameterSpec.ScaleType getScaleType()

How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ScaleType scale_type = 6;

Returns
TypeDescription
StudySpec.ParameterSpec.ScaleType

The scaleType.

getScaleTypeValue()

public int getScaleTypeValue()

How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.ScaleType scale_type = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for scaleType.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasCategoricalValueSpec()

public boolean hasCategoricalValueSpec()

The value spec for a 'CATEGORICAL' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;

Returns
TypeDescription
boolean

Whether the categoricalValueSpec field is set.

hasDiscreteValueSpec()

public boolean hasDiscreteValueSpec()

The value spec for a 'DISCRETE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;

Returns
TypeDescription
boolean

Whether the discreteValueSpec field is set.

hasDoubleValueSpec()

public boolean hasDoubleValueSpec()

The value spec for a 'DOUBLE' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;

Returns
TypeDescription
boolean

Whether the doubleValueSpec field is set.

hasIntegerValueSpec()

public boolean hasIntegerValueSpec()

The value spec for an 'INTEGER' parameter.

.google.cloud.aiplatform.v1beta1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;

Returns
TypeDescription
boolean

Whether the integerValueSpec field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StudySpec.ParameterSpec.Builder newBuilderForType()
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.ParameterSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StudySpec.ParameterSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StudySpec.ParameterSpec.Builder toBuilder()
Returns
TypeDescription
StudySpec.ParameterSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException