Interface StudySpec.ParameterSpecOrBuilder (3.21.0)

Version 3.21.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static interface StudySpec.ParameterSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCategoricalValueSpec()

public abstract StudySpec.ParameterSpec.CategoricalValueSpec getCategoricalValueSpec()

The value spec for a 'CATEGORICAL' parameter.

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

Returns
Type	Description
StudySpec.ParameterSpec.CategoricalValueSpec	The categoricalValueSpec.

getCategoricalValueSpecOrBuilder()

public abstract StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder getCategoricalValueSpecOrBuilder()

The value spec for a 'CATEGORICAL' parameter.

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

Returns
Type	Description
StudySpec.ParameterSpec.CategoricalValueSpecOrBuilder

getConditionalParameterSpecs(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
StudySpec.ParameterSpec.ConditionalParameterSpec

getConditionalParameterSpecsCount()

public abstract 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
Type	Description
int

getConditionalParameterSpecsList()

public abstract 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
Type	Description
List<ConditionalParameterSpec>

getConditionalParameterSpecsOrBuilder(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
StudySpec.ParameterSpec.ConditionalParameterSpecOrBuilder

getConditionalParameterSpecsOrBuilderList()

public abstract 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>

getDiscreteValueSpec()

public abstract StudySpec.ParameterSpec.DiscreteValueSpec getDiscreteValueSpec()

The value spec for a 'DISCRETE' parameter.

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

Returns
Type	Description
StudySpec.ParameterSpec.DiscreteValueSpec	The discreteValueSpec.

getDiscreteValueSpecOrBuilder()

public abstract StudySpec.ParameterSpec.DiscreteValueSpecOrBuilder getDiscreteValueSpecOrBuilder()

The value spec for a 'DISCRETE' parameter.

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

Returns
Type	Description
StudySpec.ParameterSpec.DiscreteValueSpecOrBuilder

getDoubleValueSpec()

public abstract StudySpec.ParameterSpec.DoubleValueSpec getDoubleValueSpec()

The value spec for a 'DOUBLE' parameter.

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

Returns
Type	Description
StudySpec.ParameterSpec.DoubleValueSpec	The doubleValueSpec.

getDoubleValueSpecOrBuilder()

public abstract StudySpec.ParameterSpec.DoubleValueSpecOrBuilder getDoubleValueSpecOrBuilder()

The value spec for a 'DOUBLE' parameter.

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

Returns
Type	Description
StudySpec.ParameterSpec.DoubleValueSpecOrBuilder

getIntegerValueSpec()

public abstract StudySpec.ParameterSpec.IntegerValueSpec getIntegerValueSpec()

The value spec for an 'INTEGER' parameter.

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

Returns
Type	Description
StudySpec.ParameterSpec.IntegerValueSpec	The integerValueSpec.

getIntegerValueSpecOrBuilder()

public abstract StudySpec.ParameterSpec.IntegerValueSpecOrBuilder getIntegerValueSpecOrBuilder()

The value spec for an 'INTEGER' parameter.

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

Returns
Type	Description
StudySpec.ParameterSpec.IntegerValueSpecOrBuilder

getParameterId()

public abstract 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.

getParameterIdBytes()

public abstract 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.

getParameterValueSpecCase()

public abstract StudySpec.ParameterSpec.ParameterValueSpecCase getParameterValueSpecCase()

Returns
Type	Description
StudySpec.ParameterSpec.ParameterValueSpecCase

getScaleType()

public abstract 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
Type	Description
StudySpec.ParameterSpec.ScaleType	The scaleType.

getScaleTypeValue()

public abstract 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.

hasCategoricalValueSpec()

public abstract 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.

hasDiscreteValueSpec()

public abstract 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.

hasDoubleValueSpec()

public abstract 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.

hasIntegerValueSpec()

public abstract 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.