# Google Cloud Security Compliance V1 Client - Class ParameterSpec (0.4.0)

0.4.0 (latest) 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class ParameterSpec.

The parameter specification for the cloud control.

Generated from protobuf message `google.cloud.cloudsecuritycompliance.v1.ParameterSpec`

## Namespace

Google \\ Cloud \\ CloudSecurityCompliance \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Required. The name of the parameter. |
| `↳ display_name` | `string` Optional. The friendly name of the parameter. The maximum length is 200 characters. |
| `↳ description` | `string` Optional. The description of the parameter. The maximum length is 2000 characters. |
| `↳ is_required` | `bool` Required. Whether the parameter is required. |
| `↳ value_type` | `int` Required. The parameter value type. |
| `↳ default_value` | `https://docs.cloud.google.com/php/docs/reference/cloud-securitycompliance/latest/V1.ParamValue` Optional. The default value of the parameter. |
| `↳ substitution_rules` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-securitycompliance/latest/V1.ParameterSubstitutionRule>` Optional. The list of parameter substitutions. |
| `↳ sub_parameters` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-securitycompliance/latest/V1.ParameterSpec>` Optional. The parameter specification for `oneOf` attributes. |
| `↳ validation` | `https://docs.cloud.google.com/php/docs/reference/cloud-securitycompliance/latest/V1.Validation` Optional. The permitted set of values for the parameter. |

### getName

Required. The name of the parameter.

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

### setName

Required. The name of the parameter.

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

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

### getDisplayName

Optional. The friendly name of the parameter. The maximum length is 200
characters.

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

### setDisplayName

Optional. The friendly name of the parameter. The maximum length is 200
characters.

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

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

### getDescription

Optional. The description of the parameter. The maximum length is 2000
characters.

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

### setDescription

Optional. The description of the parameter. The maximum length is 2000
characters.

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

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

### getIsRequired

Required. Whether the parameter is required.

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

### setIsRequired

Required. Whether the parameter is required.

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

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

### getValueType

Required. The parameter value type.

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

### setValueType

Required. The parameter value type.

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

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

### getDefaultValue

Optional. The default value of the parameter.

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

### hasDefaultValue

### clearDefaultValue

### setDefaultValue

Optional. The default value of the parameter.

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

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

### getSubstitutionRules

Optional. The list of parameter substitutions.

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

### setSubstitutionRules

Optional. The list of parameter substitutions.

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

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

### getSubParameters

Optional. The parameter specification for `oneOf` attributes.

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

### setSubParameters

Optional. The parameter specification for `oneOf` attributes.

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

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

### getValidation

Optional. The permitted set of values for the parameter.

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

### hasValidation

### clearValidation

### setValidation

Optional. The permitted set of values for the parameter.

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

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