Reference documentation and code samples for the Google Cloud Channel V1 Client class ParameterDefinition.
Parameter's definition. Specifies what parameter is required to use the current Offer to purchase.
Generated from protobuf message google.cloud.channel.v1.ParameterDefinition
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Name of the parameter.
↳ parameter_type
int
Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.
↳ min_value
Google\Cloud\Channel\V1\Value
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.
↳ max_value
Google\Cloud\Channel\V1\Value
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.
↳ allowed_values
array< Google\Cloud\Channel\V1\Value
>
If not empty, parameter values must be drawn from this list. For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.
↳ optional
bool
If set to true, parameter is optional to purchase this Offer.
getName
Name of the parameter.
Generated from protobuf field string name = 1;
string
setName
Name of the parameter.
Generated from protobuf field string name = 1;
var
string
$this
getParameterType
Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.
Generated from protobuf field .google.cloud.channel.v1.ParameterDefinition.ParameterType parameter_type = 2;
int
setParameterType
Data type of the parameter. Minimal value, Maximum value and allowed values will use specified data type here.
Generated from protobuf field .google.cloud.channel.v1.ParameterDefinition.ParameterType parameter_type = 2;
var
int
$this
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.
Generated from protobuf field .google.cloud.channel.v1.Value min_value = 3;
hasMinValue
clearMinValue
setMinValue
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.
Generated from protobuf field .google.cloud.channel.v1.Value min_value = 3;
$this
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.
Generated from protobuf field .google.cloud.channel.v1.Value max_value = 4;
hasMaxValue
clearMaxValue
setMaxValue
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.
Generated from protobuf field .google.cloud.channel.v1.Value max_value = 4;
$this
getAllowedValues
If not empty, parameter values must be drawn from this list.
For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.
Generated from protobuf field repeated .google.cloud.channel.v1.Value allowed_values = 5;
Google\Protobuf\Internal\RepeatedField
setAllowedValues
If not empty, parameter values must be drawn from this list.
For example, [us-west1, us-west2, ...] Applicable to STRING parameter type.
Generated from protobuf field repeated .google.cloud.channel.v1.Value allowed_values = 5;
$this
getOptional
If set to true, parameter is optional to purchase this Offer.
Generated from protobuf field bool optional = 6;
bool
setOptional
If set to true, parameter is optional to purchase this Offer.
Generated from protobuf field bool optional = 6;
var
bool
$this