# Google Cloud Channel V1 Client - Class ParameterDefinition (2.4.1)

2.4.1 (latest) 2.4.0 2.3.1 2.2.1 2.1.4 2.0.0 1.9.5 1.8.2 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.1 1.1.1 1.0.1 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`

## Namespace

Google \\ Cloud \\ Channel \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `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` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/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` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/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<https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Name of the parameter.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getParameterType

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ParameterType](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.ParameterDefinition.ParameterType). |

### setParameterType

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ParameterType](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.ParameterDefinition.ParameterType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Value|null` |   |

### 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Value` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Value|null` |   |

### 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Value` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAllowedValues

If not empty, parameter values must be drawn from this list.

For example, \[us-west1, us-west2, ...\]
Applicable to STRING parameter type.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Value>` |   |

### setAllowedValues

If not empty, parameter values must be drawn from this list.

For example, \[us-west1, us-west2, ...\]
Applicable to STRING parameter type.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Value>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOptional

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setOptional

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |