Reference documentation and code samples for the Google Cloud Api Hub V1 Client class ConfigVariableTemplate.
ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
Generated from protobuf message google.cloud.apihub.v1.ConfigVariableTemplate
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
Required. ID of the config variable. Must be unique within the configuration. |
↳ value_type |
int
Required. Type of the parameter: string, int, bool etc. |
↳ description |
string
Optional. Description. |
↳ validation_regex |
string
Optional. Regular expression in RE2 syntax used for validating the |
↳ required |
bool
Optional. Flag represents that this |
↳ enum_options |
array<ConfigValueOption>
Optional. Enum options. To be populated if |
↳ multi_select_options |
array<ConfigValueOption>
Optional. Multi select options. To be populated if |
getId
Required. ID of the config variable. Must be unique within the configuration.
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
Required. ID of the config variable. Must be unique within the configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValueType
Required. Type of the parameter: string, int, bool etc.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ValueType. |
setValueType
Required. Type of the parameter: string, int, bool etc.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ValueType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidationRegex
Optional. Regular expression in RE2 syntax used for validating the value
of a ConfigVariable.
| Returns | |
|---|---|
| Type | Description |
string |
|
setValidationRegex
Optional. Regular expression in RE2 syntax used for validating the value
of a ConfigVariable.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequired
Optional. Flag represents that this ConfigVariable must be provided for a
PluginInstance.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRequired
Optional. Flag represents that this ConfigVariable must be provided for a
PluginInstance.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnumOptions
Optional. Enum options. To be populated if ValueType is ENUM.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEnumOptions
Optional. Enum options. To be populated if ValueType is ENUM.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ConfigValueOption>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMultiSelectOptions
Optional. Multi select options. To be populated if ValueType is
MULTI_SELECT.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMultiSelectOptions
Optional. Multi select options. To be populated if ValueType is
MULTI_SELECT.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ConfigValueOption>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|