public static final class StudySpec.ParameterSpec extends GeneratedMessageV3 implements StudySpec.ParameterSpecOrBuilder
Represents a single parameter to optimize.
Protobuf type google.cloud.aiplatform.v1.StudySpec.ParameterSpec
Static Fields
public static final int CATEGORICAL_VALUE_SPEC_FIELD_NUMBER
Field Value
public static final int CONDITIONAL_PARAMETER_SPECS_FIELD_NUMBER
Field Value
public static final int DISCRETE_VALUE_SPEC_FIELD_NUMBER
Field Value
public static final int DOUBLE_VALUE_SPEC_FIELD_NUMBER
Field Value
public static final int INTEGER_VALUE_SPEC_FIELD_NUMBER
Field Value
public static final int PARAMETER_ID_FIELD_NUMBER
Field Value
public static final int SCALE_TYPE_FIELD_NUMBER
Field Value
Static Methods
public static StudySpec.ParameterSpec getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static StudySpec.ParameterSpec.Builder newBuilder()
Returns
public static StudySpec.ParameterSpec.Builder newBuilder(StudySpec.ParameterSpec prototype)
Parameter
Returns
public static StudySpec.ParameterSpec parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static StudySpec.ParameterSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static StudySpec.ParameterSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<StudySpec.ParameterSpec> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public StudySpec.ParameterSpec.CategoricalValueSpec getCategoricalValueSpec()
The value spec for a 'CATEGORICAL' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;
Returns
public StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder getCategoricalValueSpecOrBuilder()
The value spec for a 'CATEGORICAL' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;
Returns
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;
Parameter
Returns
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;
Returns
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.v1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;
Returns
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.v1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;
Parameter
Returns
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.v1.StudySpec.ParameterSpec.ConditionalParameterSpec conditional_parameter_specs = 10;
Returns
Type | Description |
List<? extends com.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder> | |
public StudySpec.ParameterSpec getDefaultInstanceForType()
Returns
public StudySpec.ParameterSpec.DiscreteValueSpec getDiscreteValueSpec()
The value spec for a 'DISCRETE' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;
Returns
public StudySpec.ParameterSpec.DiscreteValueSpecOrBuilder getDiscreteValueSpecOrBuilder()
The value spec for a 'DISCRETE' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;
Returns
public StudySpec.ParameterSpec.DoubleValueSpec getDoubleValueSpec()
The value spec for a 'DOUBLE' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;
Returns
public StudySpec.ParameterSpec.DoubleValueSpecOrBuilder getDoubleValueSpecOrBuilder()
The value spec for a 'DOUBLE' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;
Returns
public StudySpec.ParameterSpec.IntegerValueSpec getIntegerValueSpec()
The value spec for an 'INTEGER' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;
Returns
public StudySpec.ParameterSpec.IntegerValueSpecOrBuilder getIntegerValueSpecOrBuilder()
The value spec for an 'INTEGER' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;
Returns
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
Type | Description |
String | The parameterId.
|
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
Type | Description |
ByteString | The bytes for parameterId.
|
public StudySpec.ParameterSpec.ParameterValueSpecCase getParameterValueSpecCase()
Returns
public Parser<StudySpec.ParameterSpec> getParserForType()
Returns
Overrides
public StudySpec.ParameterSpec.ScaleType getScaleType()
How the parameter should be scaled.
Leave unset for CATEGORICAL
parameters.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ScaleType scale_type = 6;
Returns
public int getScaleTypeValue()
How the parameter should be scaled.
Leave unset for CATEGORICAL
parameters.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.ScaleType scale_type = 6;
Returns
Type | Description |
int | The enum numeric value on the wire for scaleType.
|
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasCategoricalValueSpec()
The value spec for a 'CATEGORICAL' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.CategoricalValueSpec categorical_value_spec = 4;
Returns
Type | Description |
boolean | Whether the categoricalValueSpec field is set.
|
public boolean hasDiscreteValueSpec()
The value spec for a 'DISCRETE' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DiscreteValueSpec discrete_value_spec = 5;
Returns
Type | Description |
boolean | Whether the discreteValueSpec field is set.
|
public boolean hasDoubleValueSpec()
The value spec for a 'DOUBLE' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.DoubleValueSpec double_value_spec = 2;
Returns
Type | Description |
boolean | Whether the doubleValueSpec field is set.
|
public boolean hasIntegerValueSpec()
The value spec for an 'INTEGER' parameter.
.google.cloud.aiplatform.v1.StudySpec.ParameterSpec.IntegerValueSpec integer_value_spec = 3;
Returns
Type | Description |
boolean | Whether the integerValueSpec field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public StudySpec.ParameterSpec.Builder newBuilderForType()
Returns
protected StudySpec.ParameterSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public StudySpec.ParameterSpec.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions