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

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

Overview

Summary information for an access request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccessRequestSummary

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

  • :lockbox_id (String) —

    The value to assign to the #lockbox_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :requestor_id (String) —

    The value to assign to the #requestor_id property

  • :requestor_location (String) —

    The value to assign to the #requestor_location property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :access_duration (String) —

    The value to assign to the #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

  • :time_expired (DateTime) —

    The value to assign to the #time_expired property

  • :ticket_number (String) —

    The value to assign to the #ticket_number 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



155
156
157
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
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 155

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

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

  self.lockbox_id = attributes[:'lockbox_id'] if attributes[:'lockbox_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.description = attributes[:'description'] if attributes[:'description']

  self.requestor_id = attributes[:'requestorId'] if attributes[:'requestorId']

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

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

  self.requestor_location = attributes[:'requestorLocation'] if attributes[:'requestorLocation']

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

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

  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_duration = attributes[:'accessDuration'] if attributes[:'accessDuration']

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

  self.access_duration = attributes[:'access_duration'] if attributes[:'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.time_expired = attributes[:'timeExpired'] if attributes[:'timeExpired']

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

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

  self.ticket_number = attributes[:'ticketNumber'] if attributes[:'ticketNumber']

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

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

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

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

Returns:

  • (String) 


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

def access_duration
  @access_duration
end

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

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/access_request_summary.rb', line 80

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The rationale for requesting the access request.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 26

def description
  @description
end

#display_name ⇒ String

[Required] The name of the access request.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 22

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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/access_request_summary.rb', line 74

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The unique identifier (OCID) of the access request, which can't be changed after creation.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 14

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the access request.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#lockbox_id ⇒ String

[Required] The unique identifier (OCID) of the lockbox box that the access request is associated with, which can't be changed after creation.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 18

def lockbox_id
  @lockbox_id
end

#requestor_id ⇒ String

[Required] The unique identifier of the requestor.

Returns:

  • (String) 


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

def requestor_id
  @requestor_id
end

#requestor_location ⇒ String

The two-char country code of the requestor while creating the access request Example: US

Returns:

  • (String) 


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

def requestor_location
  @requestor_location
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/access_request_summary.rb', line 86

def system_tags
  @system_tags
end

#ticket_number ⇒ String

The ticket number raised by external customers Example: 3-37509643121

Returns:

  • (String) 


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

def ticket_number
  @ticket_number
end

#time_created ⇒ DateTime

[Required] The time the access request was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_expired ⇒ DateTime

[Required] The time the access request expired. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:

  • (DateTime) 


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

def time_expired
  @time_expired
end

#time_updated ⇒ DateTime

[Required] The time the access request was last updated. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

Returns:

  • (DateTime) 


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

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
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 89

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'lockbox_id': :'lockboxId',
    'display_name': :'displayName',
    'description': :'description',
    'requestor_id': :'requestorId',
    'requestor_location': :'requestorLocation',
    'lifecycle_state': :'lifecycleState',
    'access_duration': :'accessDuration',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_expired': :'timeExpired',
    'ticket_number': :'ticketNumber',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'lockbox_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'requestor_id': :'String',
    'requestor_location': :'String',
    'lifecycle_state': :'String',
    'access_duration': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_expired': :'DateTime',
    'ticket_number': :'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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 251

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

  self.class == other.class &&
    id == other.id &&
    lockbox_id == other.lockbox_id &&
    display_name == other.display_name &&
    description == other.description &&
    requestor_id == other.requestor_id &&
    requestor_location == other.requestor_location &&
    lifecycle_state == other.lifecycle_state &&
    access_duration == other.access_duration &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_expired == other.time_expired &&
    ticket_number == other.ticket_number &&
    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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 295

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


275
276
277
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 275

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



284
285
286
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 284

def hash
  [id, lockbox_id, display_name, description, requestor_id, requestor_location, lifecycle_state, access_duration, time_created, time_updated, time_expired, ticket_number, 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



328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 328

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



322
323
324
 
# File 'lib/oci/lockbox/models/access_request_summary.rb', line 322

def to_s
  to_hash.to_s
end