Class: OCI::Lockbox::Models::Lockbox

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

Overview

Description of Lockbox.

Constant Summary collapse

LOCKBOX_PARTNER_ENUM = 
[
  LOCKBOX_PARTNER_FAAAS = 'FAAAS'.freeze,
  LOCKBOX_PARTNER_CANARY = 'CANARY'.freeze,
  LOCKBOX_PARTNER_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ Lockbox

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 181

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.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.partner_id = attributes[:'partnerId'] if attributes[:'partnerId']

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

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

  self.parent_lockbox_id = attributes[:'parentLockboxId'] if attributes[:'parentLockboxId']

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

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

  self.partner_compartment_id = attributes[:'partnerCompartmentId'] if attributes[:'partnerCompartmentId']

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

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

  self.resource_id = attributes[:'resourceId'] if attributes[:'resourceId']

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

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

  self.lockbox_partner = attributes[:'lockboxPartner'] if attributes[:'lockboxPartner']

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

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

  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.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.access_context_attributes = attributes[:'accessContextAttributes'] if attributes[:'accessContextAttributes']

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

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

  self.approval_template_id = attributes[:'approvalTemplateId'] if attributes[:'approvalTemplateId']

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

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

  self.max_access_duration = attributes[:'maxAccessDuration'] if attributes[:'maxAccessDuration']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#access_context_attributes ⇒ OCI::Lockbox::Models::AccessContextAttributeCollection

Returns:



73
74
75
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 73

def access_context_attributes
  @access_context_attributes
end

#approval_template_id ⇒ String

Approval template ID

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 77

def approval_template_id
  @approval_template_id
end

#compartment_id ⇒ String

[Required] Compartment Identifier

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 38

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


97
98
99
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 97

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Lockbox Identifier, can be renamed

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 34

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


91
92
93
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 91

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 30

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 85

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Lockbox.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 70

def lifecycle_state
  @lifecycle_state
end

#lockbox_partner ⇒ String

The partner using this lockbox to lock a resource.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 58

def lockbox_partner
  @lockbox_partner
end

#max_access_duration ⇒ String

The maximum amount of time operator has access to associated resources.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 81

def max_access_duration
  @max_access_duration
end

#parent_lockbox_id ⇒ String

The unique identifier (OCID) of lockbox resource using to reference parent lockbox in hybrid oma setup

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 46

def parent_lockbox_id
  @parent_lockbox_id
end

#partner_compartment_id ⇒ String

Compartment Identifier

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 50

def partner_compartment_id
  @partner_compartment_id
end

#partner_id ⇒ String

The unique identifier (OCID) of partner resource using this lockbox to lock a resource

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 42

def partner_id
  @partner_id
end

#resource_id ⇒ String

[Required] The unique identifier (OCID) of associated resource that the lockbox is created for.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 54

def resource_id
  @resource_id
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


103
104
105
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 103

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the the Lockbox was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 62

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the Lockbox was updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 66

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'partner_id': :'partnerId',
    'parent_lockbox_id': :'parentLockboxId',
    'partner_compartment_id': :'partnerCompartmentId',
    'resource_id': :'resourceId',
    'lockbox_partner': :'lockboxPartner',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'access_context_attributes': :'accessContextAttributes',
    'approval_template_id': :'approvalTemplateId',
    'max_access_duration': :'maxAccessDuration',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 132

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'partner_id': :'String',
    'parent_lockbox_id': :'String',
    'partner_compartment_id': :'String',
    'resource_id': :'String',
    'lockbox_partner': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'access_context_attributes': :'OCI::Lockbox::Models::AccessContextAttributeCollection',
    'approval_template_id': :'String',
    'max_access_duration': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 325

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    partner_id == other.partner_id &&
    parent_lockbox_id == other.parent_lockbox_id &&
    partner_compartment_id == other.partner_compartment_id &&
    resource_id == other.resource_id &&
    lockbox_partner == other.lockbox_partner &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    access_context_attributes == other.access_context_attributes &&
    approval_template_id == other.approval_template_id &&
    max_access_duration == other.max_access_duration &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 372

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


352
353
354
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 352

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



361
362
363
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 361

def hash
  [id, display_name, compartment_id, partner_id, parent_lockbox_id, partner_compartment_id, resource_id, lockbox_partner, time_created, time_updated, lifecycle_state, access_context_attributes, approval_template_id, max_access_duration, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



405
406
407
408
409
410
411
412
413
414
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 405

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



399
400
401
 
# File 'lib/oci/lockbox/models/lockbox.rb', line 399

def to_s
  to_hash.to_s
end