Reference documentation and code samples for the Connectors V1 API class Google::Cloud::Connectors::V1::ConfigVariableTemplate.
ConfigVariableTemplate provides metadata about a ConfigVariable
that is
used in a Connection.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#authorization_code_link
def authorization_code_link() -> ::Google::Cloud::Connectors::V1::AuthorizationCodeLink
Returns
-
(::Google::Cloud::Connectors::V1::AuthorizationCodeLink) — Authorization code link options. To be populated if
ValueType
isAUTHORIZATION_CODE
#authorization_code_link=
def authorization_code_link=(value) -> ::Google::Cloud::Connectors::V1::AuthorizationCodeLink
Parameter
-
value (::Google::Cloud::Connectors::V1::AuthorizationCodeLink) — Authorization code link options. To be populated if
ValueType
isAUTHORIZATION_CODE
Returns
-
(::Google::Cloud::Connectors::V1::AuthorizationCodeLink) — Authorization code link options. To be populated if
ValueType
isAUTHORIZATION_CODE
#description
def description() -> ::String
Returns
- (::String) — Description.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Description.
Returns
- (::String) — Description.
#display_name
def display_name() -> ::String
Returns
- (::String) — Display name of the parameter.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Display name of the parameter.
Returns
- (::String) — Display name of the parameter.
#enum_options
def enum_options() -> ::Array<::Google::Cloud::Connectors::V1::EnumOption>
Returns
-
(::Array<::Google::Cloud::Connectors::V1::EnumOption>) — Enum options. To be populated if
ValueType
isENUM
#enum_options=
def enum_options=(value) -> ::Array<::Google::Cloud::Connectors::V1::EnumOption>
Parameter
-
value (::Array<::Google::Cloud::Connectors::V1::EnumOption>) — Enum options. To be populated if
ValueType
isENUM
Returns
-
(::Array<::Google::Cloud::Connectors::V1::EnumOption>) — Enum options. To be populated if
ValueType
isENUM
#is_advanced
def is_advanced() -> ::Boolean
Returns
- (::Boolean) — Indicates if current template is part of advanced settings
#is_advanced=
def is_advanced=(value) -> ::Boolean
Parameter
- value (::Boolean) — Indicates if current template is part of advanced settings
Returns
- (::Boolean) — Indicates if current template is part of advanced settings
#key
def key() -> ::String
Returns
- (::String) — Key of the config variable.
#key=
def key=(value) -> ::String
Parameter
- value (::String) — Key of the config variable.
Returns
- (::String) — Key of the config variable.
#required
def required() -> ::Boolean
Returns
-
(::Boolean) — Flag represents that this
ConfigVariable
must be provided for a connection.
#required=
def required=(value) -> ::Boolean
Parameter
-
value (::Boolean) — Flag represents that this
ConfigVariable
must be provided for a connection.
Returns
-
(::Boolean) — Flag represents that this
ConfigVariable
must be provided for a connection.
#role_grant
def role_grant() -> ::Google::Cloud::Connectors::V1::RoleGrant
Returns
- (::Google::Cloud::Connectors::V1::RoleGrant) — Role grant configuration for the config variable.
#role_grant=
def role_grant=(value) -> ::Google::Cloud::Connectors::V1::RoleGrant
Parameter
- value (::Google::Cloud::Connectors::V1::RoleGrant) — Role grant configuration for the config variable.
Returns
- (::Google::Cloud::Connectors::V1::RoleGrant) — Role grant configuration for the config variable.
#state
def state() -> ::Google::Cloud::Connectors::V1::ConfigVariableTemplate::State
Returns
- (::Google::Cloud::Connectors::V1::ConfigVariableTemplate::State) — State of the config variable.
#state=
def state=(value) -> ::Google::Cloud::Connectors::V1::ConfigVariableTemplate::State
Parameter
- value (::Google::Cloud::Connectors::V1::ConfigVariableTemplate::State) — State of the config variable.
Returns
- (::Google::Cloud::Connectors::V1::ConfigVariableTemplate::State) — State of the config variable.
#validation_regex
def validation_regex() -> ::String
Returns
-
(::String) — Regular expression in RE2 syntax used for validating the
value
of aConfigVariable
.
#validation_regex=
def validation_regex=(value) -> ::String
Parameter
-
value (::String) — Regular expression in RE2 syntax used for validating the
value
of aConfigVariable
.
Returns
-
(::String) — Regular expression in RE2 syntax used for validating the
value
of aConfigVariable
.
#value_type
def value_type() -> ::Google::Cloud::Connectors::V1::ConfigVariableTemplate::ValueType
Returns
- (::Google::Cloud::Connectors::V1::ConfigVariableTemplate::ValueType) — Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
#value_type=
def value_type=(value) -> ::Google::Cloud::Connectors::V1::ConfigVariableTemplate::ValueType
Parameter
- value (::Google::Cloud::Connectors::V1::ConfigVariableTemplate::ValueType) — Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
Returns
- (::Google::Cloud::Connectors::V1::ConfigVariableTemplate::ValueType) — Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.