Reference documentation and code samples for the Google Cloud Design Center V1 Client class DisplayVariable.
Additional display specific Template pertaining to a particular input variable.
Generated from protobuf message google.cloud.designcenter.v1.DisplayVariable
Namespace
Google \ Cloud \ DesignCenter \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The variable name from the corresponding standard Template file. |
↳ title |
string
Required. Visible title for the variable on the UI. |
↳ alternate_defaults |
array<AlternateDefaultInput>
Optional. Alternate defaults for the input. |
↳ regex_validation |
string
Optional. Regex based validation rules for the variable. |
↳ min |
float
Optional. Minimum value for numeric types. |
↳ max |
float
Optional. Maximum value for numeric types. |
↳ validation |
string
Optional. Text describing the validation rules for the property. Typically shown after an invalid input. Optional. UTF-8 text. No markup. At most 128 characters. |
↳ enum_value_labels |
array<ValueLabelInput>
Optional. Labels for enum values. Values must be UTF-8 text with no markup, and at most 64 characters. |
↳ level |
int
Optional. Indicates the "advanced" level of the input property. Level 0 (default) will always be shown. Level 1 corresponds to one expansion (user clicks "show advanced options" or "more options"). Higher levels correspond to further expansions, or they may be collapsed to level 1 by the UI implementation. Optional. |
↳ subtext |
string
Optional. Property subtext, displayed below the title. |
↳ properties |
array|Google\Protobuf\Internal\MapField
Optional. properties is a map defining all the fields of the input variable. |
getName
Required. The variable name from the corresponding standard Template file.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The variable name from the corresponding standard Template file.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTitle
Required. Visible title for the variable on the UI.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTitle
Required. Visible title for the variable on the UI.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAlternateDefaults
Optional. Alternate defaults for the input.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<AlternateDefaultInput> |
|
setAlternateDefaults
Optional. Alternate defaults for the input.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AlternateDefaultInput>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegexValidation
Optional. Regex based validation rules for the variable.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRegexValidation
Optional. Regex based validation rules for the variable.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMin
Optional. Minimum value for numeric types.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasMin
clearMin
setMin
Optional. Minimum value for numeric types.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMax
Optional. Maximum value for numeric types.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasMax
clearMax
setMax
Optional. Maximum value for numeric types.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidation
Optional. Text describing the validation rules for the property. Typically shown after an invalid input. Optional. UTF-8 text. No markup. At most 128 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setValidation
Optional. Text describing the validation rules for the property. Typically shown after an invalid input. Optional. UTF-8 text. No markup. At most 128 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnumValueLabels
Optional. Labels for enum values.
Values must be UTF-8 text with no markup, and at most 64 characters.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ValueLabelInput> |
|
setEnumValueLabels
Optional. Labels for enum values.
Values must be UTF-8 text with no markup, and at most 64 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ValueLabelInput>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLevel
Optional. Indicates the "advanced" level of the input property. Level 0 (default) will always be shown. Level 1 corresponds to one expansion (user clicks "show advanced options" or "more options"). Higher levels correspond to further expansions, or they may be collapsed to level 1 by the UI implementation.
Optional.
| Returns | |
|---|---|
| Type | Description |
int |
|
setLevel
Optional. Indicates the "advanced" level of the input property. Level 0 (default) will always be shown. Level 1 corresponds to one expansion (user clicks "show advanced options" or "more options"). Higher levels correspond to further expansions, or they may be collapsed to level 1 by the UI implementation.
Optional.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubtext
Optional. Property subtext, displayed below the title.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSubtext
Optional. Property subtext, displayed below the title.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProperties
Optional. properties is a map defining all the fields of the input variable.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setProperties
Optional. properties is a map defining all the fields of the input variable.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|