Class ParameterDefinition (3.44.0)

public final class ParameterDefinition extends GeneratedMessageV3 implements ParameterDefinitionOrBuilder

Parameter's definition. Specifies what parameter is required to use the current Offer to purchase.

Protobuf type google.cloud.channel.v1.ParameterDefinition

Static Fields

ALLOWED_VALUES_FIELD_NUMBER

public static final int ALLOWED_VALUES_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_VALUE_FIELD_NUMBER

public static final int MAX_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_VALUE_FIELD_NUMBER

public static final int MIN_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OPTIONAL_FIELD_NUMBER

public static final int OPTIONAL_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETER_TYPE_FIELD_NUMBER

public static final int PARAMETER_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ParameterDefinition getDefaultInstance()
Returns
TypeDescription
ParameterDefinition

getDescriptor()

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

newBuilder()

public static ParameterDefinition.Builder newBuilder()
Returns
TypeDescription
ParameterDefinition.Builder

newBuilder(ParameterDefinition prototype)

public static ParameterDefinition.Builder newBuilder(ParameterDefinition prototype)
Parameter
NameDescription
prototypeParameterDefinition
Returns
TypeDescription
ParameterDefinition.Builder

parseDelimitedFrom(InputStream input)

public static ParameterDefinition parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ParameterDefinition
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ParameterDefinition parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ParameterDefinition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ParameterDefinition parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ParameterDefinition
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ParameterDefinition parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ParameterDefinition
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ParameterDefinition parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ParameterDefinition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ParameterDefinition> parser()
Returns
TypeDescription
Parser<ParameterDefinition>

Methods

equals(Object obj)

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

getAllowedValues(int index)

public Value getAllowedValues(int index)

If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.

repeated .google.cloud.channel.v1.Value allowed_values = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Value

getAllowedValuesCount()

public int getAllowedValuesCount()

If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.

repeated .google.cloud.channel.v1.Value allowed_values = 5;

Returns
TypeDescription
int

getAllowedValuesList()

public List<Value> getAllowedValuesList()

If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.

repeated .google.cloud.channel.v1.Value allowed_values = 5;

Returns
TypeDescription
List<Value>

getAllowedValuesOrBuilder(int index)

public ValueOrBuilder getAllowedValuesOrBuilder(int index)

If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.

repeated .google.cloud.channel.v1.Value allowed_values = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
ValueOrBuilder

getAllowedValuesOrBuilderList()

public List<? extends ValueOrBuilder> getAllowedValuesOrBuilderList()

If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.

repeated .google.cloud.channel.v1.Value allowed_values = 5;

Returns
TypeDescription
List<? extends com.google.cloud.channel.v1.ValueOrBuilder>

getDefaultInstanceForType()

public ParameterDefinition getDefaultInstanceForType()
Returns
TypeDescription
ParameterDefinition

getMaxValue()

public Value getMaxValue()

Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types.

.google.cloud.channel.v1.Value max_value = 4;

Returns
TypeDescription
Value

The maxValue.

getMaxValueOrBuilder()

public ValueOrBuilder getMaxValueOrBuilder()

Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types.

.google.cloud.channel.v1.Value max_value = 4;

Returns
TypeDescription
ValueOrBuilder

getMinValue()

public Value getMinValue()

Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types.

.google.cloud.channel.v1.Value min_value = 3;

Returns
TypeDescription
Value

The minValue.

getMinValueOrBuilder()

public ValueOrBuilder getMinValueOrBuilder()

Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types.

.google.cloud.channel.v1.Value min_value = 3;

Returns
TypeDescription
ValueOrBuilder

getName()

public String getName()

Name of the parameter.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the parameter.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOptional()

public boolean getOptional()

If set to true, parameter is optional to purchase this Offer.

bool optional = 6;

Returns
TypeDescription
boolean

The optional.

getParameterType()

public ParameterDefinition.ParameterType getParameterType()

Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.

.google.cloud.channel.v1.ParameterDefinition.ParameterType parameter_type = 2;

Returns
TypeDescription
ParameterDefinition.ParameterType

The parameterType.

getParameterTypeValue()

public int getParameterTypeValue()

Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.

.google.cloud.channel.v1.ParameterDefinition.ParameterType parameter_type = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for parameterType.

getParserForType()

public Parser<ParameterDefinition> getParserForType()
Returns
TypeDescription
Parser<ParameterDefinition>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasMaxValue()

public boolean hasMaxValue()

Maximum value of the parameter, if applicable. Inclusive. For example, maximum seats when purchasing Google Workspace Business Standard. Applicable to INT64 and DOUBLE parameter types.

.google.cloud.channel.v1.Value max_value = 4;

Returns
TypeDescription
boolean

Whether the maxValue field is set.

hasMinValue()

public boolean hasMinValue()

Minimal value of the parameter, if applicable. Inclusive. For example, minimal commitment when purchasing Anthos is 0.01. Applicable to INT64 and DOUBLE parameter types.

.google.cloud.channel.v1.Value min_value = 3;

Returns
TypeDescription
boolean

Whether the minValue 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 ParameterDefinition.Builder newBuilderForType()
Returns
TypeDescription
ParameterDefinition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ParameterDefinition.Builder toBuilder()
Returns
TypeDescription
ParameterDefinition.Builder

writeTo(CodedOutputStream output)

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