Reference documentation and code samples for the Google Cloud Design Center V1 Client class ParameterSpec.
The specification of a parameter that can be configured on a cloud control or a framework.
Generated from protobuf message google.cloud.designcenter.v1.ParameterSpec
Namespace
Google \ Cloud \ DesignCenter \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ key |
string
Required. The key of the parameter, matching Parameter.key of the value supplied for it. |
↳ display_name |
string
Optional. The parameter display name, which is a user friendly name used for UI. |
↳ description |
string
Optional. The parameter description. |
↳ required |
bool
Optional. Whether a value must be provided for the parameter. |
↳ value_type |
int
Optional. The type of value that the parameter accepts. |
↳ default_value |
Google\Protobuf\Value
Optional. The default value of the parameter, used when the user does not provide one. |
↳ sub_parameter_specs |
array<ParameterSpec>
Optional. The specifications of the sub-parameters. Only set when |
getKey
Required. The key of the parameter, matching Parameter.key of the value supplied for it.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKey
Required. The key of the parameter, matching Parameter.key of the value supplied for it.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. The parameter display name, which is a user friendly name used for UI.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. The parameter display name, which is a user friendly name used for UI.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. The parameter description.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. The parameter description.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequired
Optional. Whether a value must be provided for the parameter.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRequired
Optional. Whether a value must be provided for the parameter.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValueType
Optional. The type of value that the parameter accepts.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ValueType. |
setValueType
Optional. The type of value that the parameter accepts.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ValueType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultValue
Optional. The default value of the parameter, used when the user does not provide one.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Value|null |
|
hasDefaultValue
clearDefaultValue
setDefaultValue
Optional. The default value of the parameter, used when the user does not provide one.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Value
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubParameterSpecs
Optional. The specifications of the sub-parameters. Only set when
value_type is ONEOF.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ParameterSpec> |
|
setSubParameterSpecs
Optional. The specifications of the sub-parameters. Only set when
value_type is ONEOF.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ParameterSpec>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|