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

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

Overview

Summary of the 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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LockboxSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :lockbox_partner (String) —

    The value to assign to the #lockbox_partner property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :partner_id (String) —

    The value to assign to the #partner_id property

  • :partner_compartment_id (String) —

    The value to assign to the #partner_compartment_id property

  • :resource_id (String) —

    The value to assign to the #resource_id property

  • :approval_template_id (String) —

    The value to assign to the #approval_template_id property

  • :max_access_duration (String) —

    The value to assign to the #max_access_duration property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
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
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 158

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.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.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.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.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.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.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

#approval_template_id ⇒ String

Approval template ID

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 48

def approval_template_id
  @approval_template_id
end

#compartment_id ⇒ String

[Required] Compartment Identifier

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 32

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>>) 


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Lockbox Identifier, can be renamed

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 24

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>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 20

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) 


68
69
70
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 68

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Lockbox.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 64

def lifecycle_state
  @lifecycle_state
end

#lockbox_partner ⇒ String

The partner using this lockbox to lock a resource.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 28

def lockbox_partner
  @lockbox_partner
end

#max_access_duration ⇒ String

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

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 52

def max_access_duration
  @max_access_duration
end

#partner_compartment_id ⇒ String

Compartment Identifier

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 40

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) 


36
37
38
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 36

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) 


44
45
46
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 44

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>>) 


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 56

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 60

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 89

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

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'lockbox_partner': :'String',
    'compartment_id': :'String',
    'partner_id': :'String',
    'partner_compartment_id': :'String',
    'resource_id': :'String',
    'approval_template_id': :'String',
    'max_access_duration': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 277

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

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



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

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


302
303
304
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 302

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



311
312
313
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 311

def hash
  [id, display_name, lockbox_partner, compartment_id, partner_id, partner_compartment_id, resource_id, approval_template_id, max_access_duration, time_created, time_updated, lifecycle_state, 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



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 355

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



349
350
351
 
# File 'lib/oci/lockbox/models/lockbox_summary.rb', line 349

def to_s
  to_hash.to_s
end