Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::ConfigVariableTemplate.
ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#description
def description() -> ::String
Returns
- (::String) — Optional. Description.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Description.
Returns
- (::String) — Optional. Description.
#enum_options
def enum_options() -> ::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>
Returns
-
(::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>) — Optional. Enum options. To be populated if
ValueType
isENUM
.
#enum_options=
def enum_options=(value) -> ::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>
Parameter
-
value (::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>) — Optional. Enum options. To be populated if
ValueType
isENUM
.
Returns
-
(::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>) — Optional. Enum options. To be populated if
ValueType
isENUM
.
#id
def id() -> ::String
Returns
- (::String) — Required. ID of the config variable. Must be unique within the configuration.
#id=
def id=(value) -> ::String
Parameter
- value (::String) — Required. ID of the config variable. Must be unique within the configuration.
Returns
- (::String) — Required. ID of the config variable. Must be unique within the configuration.
#multi_select_options
def multi_select_options() -> ::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>
Returns
-
(::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>) — Optional. Multi select options. To be populated if
ValueType
isMULTI_SELECT
.
#multi_select_options=
def multi_select_options=(value) -> ::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>
Parameter
-
value (::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>) — Optional. Multi select options. To be populated if
ValueType
isMULTI_SELECT
.
Returns
-
(::Array<::Google::Cloud::ApiHub::V1::ConfigValueOption>) — Optional. Multi select options. To be populated if
ValueType
isMULTI_SELECT
.
#required
def required() -> ::Boolean
Returns
-
(::Boolean) — Optional. Flag represents that this
ConfigVariable
must be provided for a PluginInstance.
#required=
def required=(value) -> ::Boolean
Parameter
-
value (::Boolean) — Optional. Flag represents that this
ConfigVariable
must be provided for a PluginInstance.
Returns
-
(::Boolean) — Optional. Flag represents that this
ConfigVariable
must be provided for a PluginInstance.
#validation_regex
def validation_regex() -> ::String
Returns
-
(::String) — Optional. Regular expression in RE2 syntax used for validating the
value
of aConfigVariable
.
#validation_regex=
def validation_regex=(value) -> ::String
Parameter
-
value (::String) — Optional. Regular expression in RE2 syntax used for validating the
value
of aConfigVariable
.
Returns
-
(::String) — Optional. Regular expression in RE2 syntax used for validating the
value
of aConfigVariable
.
#value_type
def value_type() -> ::Google::Cloud::ApiHub::V1::ConfigVariableTemplate::ValueType
Returns
- (::Google::Cloud::ApiHub::V1::ConfigVariableTemplate::ValueType) — Required. Type of the parameter: string, int, bool etc.
#value_type=
def value_type=(value) -> ::Google::Cloud::ApiHub::V1::ConfigVariableTemplate::ValueType
Parameter
- value (::Google::Cloud::ApiHub::V1::ConfigVariableTemplate::ValueType) — Required. Type of the parameter: string, int, bool etc.
Returns
- (::Google::Cloud::ApiHub::V1::ConfigVariableTemplate::ValueType) — Required. Type of the parameter: string, int, bool etc.