Class StudySpec.ParameterSpec (2.7.4)

Version 2.7.4

• 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 final class StudySpec.ParameterSpec extends GeneratedMessageV3 implements StudySpec.ParameterSpecOrBuilder

Represents a single parameter to optimize.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StudySpec.ParameterSpec

Implements

StudySpec.ParameterSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CATEGORICAL_VALUE_SPEC_FIELD_NUMBER

public static final int CATEGORICAL_VALUE_SPEC_FIELD_NUMBER

Field Value

Type	Description
int

CONDITIONAL_PARAMETER_SPECS_FIELD_NUMBER

public static final int CONDITIONAL_PARAMETER_SPECS_FIELD_NUMBER

Field Value

Type	Description
int

DISCRETE_VALUE_SPEC_FIELD_NUMBER

public static final int DISCRETE_VALUE_SPEC_FIELD_NUMBER

Field Value

Type	Description
int

DOUBLE_VALUE_SPEC_FIELD_NUMBER

public static final int DOUBLE_VALUE_SPEC_FIELD_NUMBER

Field Value

Type	Description
int

INTEGER_VALUE_SPEC_FIELD_NUMBER

public static final int INTEGER_VALUE_SPEC_FIELD_NUMBER

Field Value

Type	Description
int

PARAMETER_ID_FIELD_NUMBER

public static final int PARAMETER_ID_FIELD_NUMBER

Field Value

Type	Description
int

SCALE_TYPE_FIELD_NUMBER

public static final int SCALE_TYPE_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static StudySpec.ParameterSpec getDefaultInstance()

Returns

Type	Description
StudySpec.ParameterSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static StudySpec.ParameterSpec.Builder newBuilder()

Returns

Type	Description
StudySpec.ParameterSpec.Builder

newBuilder(StudySpec.ParameterSpec prototype)

public static StudySpec.ParameterSpec.Builder newBuilder(StudySpec.ParameterSpec prototype)

Parameter

Name	Description
prototype	StudySpec.ParameterSpec

Returns

Type	Description
StudySpec.ParameterSpec.Builder

parseDelimitedFrom(InputStream input)

public static StudySpec.ParameterSpec parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static StudySpec.ParameterSpec parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StudySpec.ParameterSpec parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StudySpec.ParameterSpec parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static StudySpec.ParameterSpec parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static StudySpec.ParameterSpec parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StudySpec.ParameterSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
StudySpec.ParameterSpec

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<StudySpec.ParameterSpec> parser()

Returns

Type	Description
Parser<ParameterSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCategoricalValueSpec()

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

getDefaultInstanceForType()

public StudySpec.ParameterSpec getDefaultInstanceForType()

Returns

Type	Description
StudySpec.ParameterSpec

getDiscreteValueSpec()

public 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 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 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 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 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 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 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 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 StudySpec.ParameterSpec.ParameterValueSpecCase getParameterValueSpecCase()

Returns

Type	Description
StudySpec.ParameterSpec.ParameterValueSpecCase

getParserForType()

public Parser<StudySpec.ParameterSpec> getParserForType()

Returns

Type	Description
Parser<ParameterSpec>

Overrides

GeneratedMessageV3.getParserForType()

getScaleType()

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

Type	Description
StudySpec.ParameterSpec.ScaleType	The scaleType.

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;

Returns

Type	Description
int	The enum numeric value on the wire for scaleType.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hasCategoricalValueSpec()

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.

hasDiscreteValueSpec()

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.

hasDoubleValueSpec()

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.

hasIntegerValueSpec()

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.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public StudySpec.ParameterSpec.Builder newBuilderForType()

Returns

Type	Description
StudySpec.ParameterSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StudySpec.ParameterSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
StudySpec.ParameterSpec.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public StudySpec.ParameterSpec.Builder toBuilder()

Returns

Type	Description
StudySpec.ParameterSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException