Class: OCI::Bds::Models::UpstConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/upst_configuration.rb

Overview

Information about the UPST configuration.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpstConfiguration

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/oci/bds/models/upst_configuration.rb', line 107

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.vault_id = attributes[:'vaultId'] if attributes[:'vaultId']

  raise 'You cannot provide both :vaultId and :vault_id' if attributes.key?(:'vaultId') && attributes.key?(:'vault_id')

  self.vault_id = attributes[:'vault_id'] if attributes[:'vault_id']

  self.master_encryption_key_id = attributes[:'masterEncryptionKeyId'] if attributes[:'masterEncryptionKeyId']

  raise 'You cannot provide both :masterEncryptionKeyId and :master_encryption_key_id' if attributes.key?(:'masterEncryptionKeyId') && attributes.key?(:'master_encryption_key_id')

  self.master_encryption_key_id = attributes[:'master_encryption_key_id'] if attributes[:'master_encryption_key_id']

  self.secret_id = attributes[:'secretId'] if attributes[:'secretId']

  raise 'You cannot provide both :secretId and :secret_id' if attributes.key?(:'secretId') && attributes.key?(:'secret_id')

  self.secret_id = attributes[:'secret_id'] if attributes[:'secret_id']

  self.time_token_exchange_keytab_last_refreshed = attributes[:'timeTokenExchangeKeytabLastRefreshed'] if attributes[:'timeTokenExchangeKeytabLastRefreshed']

  raise 'You cannot provide both :timeTokenExchangeKeytabLastRefreshed and :time_token_exchange_keytab_last_refreshed' if attributes.key?(:'timeTokenExchangeKeytabLastRefreshed') && attributes.key?(:'time_token_exchange_keytab_last_refreshed')

  self.time_token_exchange_keytab_last_refreshed = attributes[:'time_token_exchange_keytab_last_refreshed'] if attributes[:'time_token_exchange_keytab_last_refreshed']

  self.token_exchange_principal_name = attributes[:'tokenExchangePrincipalName'] if attributes[:'tokenExchangePrincipalName']

  raise 'You cannot provide both :tokenExchangePrincipalName and :token_exchange_principal_name' if attributes.key?(:'tokenExchangePrincipalName') && attributes.key?(:'token_exchange_principal_name')

  self.token_exchange_principal_name = attributes[:'token_exchange_principal_name'] if attributes[:'token_exchange_principal_name']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.keytab_content = attributes[:'keytabContent'] if attributes[:'keytabContent']

  raise 'You cannot provide both :keytabContent and :keytab_content' if attributes.key?(:'keytabContent') && attributes.key?(:'keytab_content')

  self.keytab_content = attributes[:'keytab_content'] if attributes[:'keytab_content']
end

Instance Attribute Details

#keytab_contentString

[Required] The kerberos keytab content used for creating identity propagation trust config, in base64 format

Returns:

  • (String)


56
57
58
# File 'lib/oci/bds/models/upst_configuration.rb', line 56

def keytab_content
  @keytab_content
end

#lifecycle_stateString

[Required] Lifecycle state of the UPST config

Returns:

  • (String)


44
45
46
# File 'lib/oci/bds/models/upst_configuration.rb', line 44

def lifecycle_state
  @lifecycle_state
end

#master_encryption_key_idString

[Required] Master Encryption key used for encrypting token exchange keytab.

Returns:

  • (String)


28
29
30
# File 'lib/oci/bds/models/upst_configuration.rb', line 28

def master_encryption_key_id
  @master_encryption_key_id
end

#secret_idString

[Required] Secret ID for token exchange keytab

Returns:

  • (String)


32
33
34
# File 'lib/oci/bds/models/upst_configuration.rb', line 32

def secret_id
  @secret_id
end

#time_createdDateTime

[Required] Time when this UPST config was created, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime)


48
49
50
# File 'lib/oci/bds/models/upst_configuration.rb', line 48

def time_created
  @time_created
end

#time_token_exchange_keytab_last_refreshedDateTime

[Required] Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime)


36
37
38
# File 'lib/oci/bds/models/upst_configuration.rb', line 36

def time_token_exchange_keytab_last_refreshed
  @time_token_exchange_keytab_last_refreshed
end

#time_updatedDateTime

[Required] Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime)


52
53
54
# File 'lib/oci/bds/models/upst_configuration.rb', line 52

def time_updated
  @time_updated
end

#token_exchange_principal_nameString

Token exchange kerberos Principal name in cluster

Returns:

  • (String)


40
41
42
# File 'lib/oci/bds/models/upst_configuration.rb', line 40

def token_exchange_principal_name
  @token_exchange_principal_name
end

#vault_idString

[Required] The instance OCID of the node, which is the resource from which the node backup was acquired.

Returns:

  • (String)


24
25
26
# File 'lib/oci/bds/models/upst_configuration.rb', line 24

def vault_id
  @vault_id
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/oci/bds/models/upst_configuration.rb', line 59

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'vault_id': :'vaultId',
    'master_encryption_key_id': :'masterEncryptionKeyId',
    'secret_id': :'secretId',
    'time_token_exchange_keytab_last_refreshed': :'timeTokenExchangeKeytabLastRefreshed',
    'token_exchange_principal_name': :'tokenExchangePrincipalName',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'keytab_content': :'keytabContent'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/oci/bds/models/upst_configuration.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'vault_id': :'String',
    'master_encryption_key_id': :'String',
    'secret_id': :'String',
    'time_token_exchange_keytab_last_refreshed': :'DateTime',
    'token_exchange_principal_name': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'keytab_content': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/oci/bds/models/upst_configuration.rb', line 188

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    vault_id == other.vault_id &&
    master_encryption_key_id == other.master_encryption_key_id &&
    secret_id == other.secret_id &&
    time_token_exchange_keytab_last_refreshed == other.time_token_exchange_keytab_last_refreshed &&
    token_exchange_principal_name == other.token_exchange_principal_name &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    keytab_content == other.keytab_content
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/oci/bds/models/upst_configuration.rb', line 226

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
# File 'lib/oci/bds/models/upst_configuration.rb', line 206

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



215
216
217
# File 'lib/oci/bds/models/upst_configuration.rb', line 215

def hash
  [vault_id, master_encryption_key_id, secret_id, time_token_exchange_keytab_last_refreshed, token_exchange_principal_name, lifecycle_state, time_created, time_updated, keytab_content].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



259
260
261
262
263
264
265
266
267
268
# File 'lib/oci/bds/models/upst_configuration.rb', line 259

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



253
254
255
# File 'lib/oci/bds/models/upst_configuration.rb', line 253

def to_s
  to_hash.to_s
end