Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class ParameterSpec.
A parameter spec of the cloud control.
Generated from protobuf message google.cloud.cloudsecuritycompliance.v1.ParameterSpec
Namespace
Google \ Cloud \ CloudSecurityCompliance \ V1Methods
__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 display 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. if the parameter is required |
↳ value_type |
int
Required. Parameter value type. |
↳ default_value |
ParamValue
Optional. The default value of the parameter. |
↳ substitution_rules |
array<ParameterSubstitutionRule>
Optional. List of parameter substitutions. |
↳ sub_parameters |
array<ParameterSpec>
Optional. ParameterSpec for oneof attributes. |
↳ validation |
Validation
Optional. The allowed 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 display name of the parameter. The maximum length is 200 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. The display 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. if the parameter is required
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsRequired
Required. if the parameter is required
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValueType
Required. Parameter value type.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ValueType. |
setValueType
Required. Parameter value type.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ValueType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultValue
Optional. The default value of the parameter.
| Returns | |
|---|---|
| Type | Description |
ParamValue|null |
|
hasDefaultValue
clearDefaultValue
setDefaultValue
Optional. The default value of the parameter.
| Parameter | |
|---|---|
| Name | Description |
var |
ParamValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubstitutionRules
Optional. List of parameter substitutions.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSubstitutionRules
Optional. List of parameter substitutions.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ParameterSubstitutionRule>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubParameters
Optional. ParameterSpec for oneof attributes.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSubParameters
Optional. ParameterSpec for oneof attributes.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ParameterSpec>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidation
Optional. The allowed set of values for the parameter.
| Returns | |
|---|---|
| Type | Description |
Validation|null |
|
hasValidation
clearValidation
setValidation
Optional. The allowed set of values for the parameter.
| Parameter | |
|---|---|
| Name | Description |
var |
Validation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|