Class: Google::Cloud::Connectors::V1::ConfigVariableTemplate

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/connectors/v1/common.rb

Overview

ConfigVariableTemplate provides metadata about a ConfigVariable that is used in a Connection.

Defined Under Namespace

Modules: State, ValueType

Instance Attribute Summary collapse

Instance Attribute Details

Returns Authorization code link options. To be populated if ValueType is AUTHORIZATION_CODE.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#description ⇒ ::String

Returns Description.

Returns:

  • (::String) —

    Description.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#display_name ⇒ ::String

Returns Display name of the parameter.

Returns:

  • (::String) —

    Display name of the parameter.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#enum_options ⇒ ::Array<::Google::Cloud::Connectors::V1::EnumOption>

Returns Enum options. To be populated if ValueType is ENUM.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#is_advanced ⇒ ::Boolean

Returns Indicates if current template is part of advanced settings.

Returns:

  • (::Boolean) —

    Indicates if current template is part of advanced settings



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#key ⇒ ::String

Returns Key of the config variable.

Returns:

  • (::String) —

    Key of the config variable.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#required ⇒ ::Boolean

Returns Flag represents that this ConfigVariable must be provided for a connection.

Returns:

  • (::Boolean) —

    Flag represents that this ConfigVariable must be provided for a connection.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#role_grant ⇒ ::Google::Cloud::Connectors::V1::RoleGrant

Returns Role grant configuration for the config variable.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#state ⇒ ::Google::Cloud::Connectors::V1::ConfigVariableTemplate::State

Returns State of the config variable.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#validation_regex ⇒ ::String

Returns Regular expression in RE2 syntax used for validating the value of a ConfigVariable.

Returns:

  • (::String) —

    Regular expression in RE2 syntax used for validating the value of a ConfigVariable.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end

#value_type ⇒ ::Google::Cloud::Connectors::V1::ConfigVariableTemplate::ValueType

Returns Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'proto_docs/google/cloud/connectors/v1/common.rb', line 94

class ConfigVariableTemplate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ValueType indicates the data type of the value.
  module ValueType
    # Value type is not specified.
    VALUE_TYPE_UNSPECIFIED = 0

    # Value type is string.
    STRING = 1

    # Value type is integer.
    INT = 2

    # Value type is boolean.
    BOOL = 3

    # Value type is secret.
    SECRET = 4

    # Value type is enum.
    ENUM = 5

    # Value type is authorization code.
    AUTHORIZATION_CODE = 6
  end

  # Indicates the state of the config variable.
  module State
    # Status is unspecified.
    STATE_UNSPECIFIED = 0

    # Config variable is active
    ACTIVE = 1

    # Config variable is deprecated.
    DEPRECATED = 2
  end
end