Class: OCI::Apiaccesscontrol::Models::PrivilegedApiRequestSummary

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

Overview

Summary of access request.

Constant Summary collapse

SEVERITY_ENUM = 
[
  SEVERITY_SEV_1 = 'SEV_1'.freeze,
  SEVERITY_SEV_2 = 'SEV_2'.freeze,
  SEVERITY_SEV_3 = 'SEV_3'.freeze,
  SEVERITY_SEV_4 = 'SEV_4'.freeze,
  SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PrivilegedApiRequestSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 206

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

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

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

  self.reason_summary = attributes[:'reasonSummary'] if attributes[:'reasonSummary']

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

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

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

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

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

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

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

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

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

  self.privileged_operation_list = attributes[:'privilegedOperationList'] if attributes[:'privilegedOperationList']

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

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

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

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

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

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

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

  self.time_requested_for_future_access = attributes[:'timeRequestedForFutureAccess'] if attributes[:'timeRequestedForFutureAccess']

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

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

  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

#compartment_id ⇒ String

The OCID of the compartment that contains the privilegedApi request.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 39

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


112
113
114
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 112

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Name of the privilegedApi control. The name must be unique.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 26

def display_name
  @display_name
end

#duration_in_hrs ⇒ Integer

Duration in hours for which access is sought on the target resource.

Returns:

  • (Integer) 


87
88
89
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 87

def duration_in_hrs
  @duration_in_hrs
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


104
105
106
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 104

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the access request.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 22

def id
  @id
end

#lifecycle_details ⇒ String

More in detail about the lifeCycleState.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the PrivilegedApiRequest.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 69

def lifecycle_state
  @lifecycle_state
end

#privileged_operation_list ⇒ Array<OCI::Apiaccesscontrol::Models::PrivilegedApiRequestOperationDetails>

List of api names, attributes for which approval is sought by the user.

Returns:



61
62
63
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 61

def privileged_operation_list
  @privileged_operation_list
end

#reason_summary ⇒ String

[Required] Comment associated with the privilegedApi request.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 35

def reason_summary
  @reason_summary
end

#request_id ⇒ String

This is a system-generated identifier to identity a Request in human readable form in the form of REQYYYYMMDD<number>.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 31

def request_id
  @request_id
end

#resource_id ⇒ String

[Required] The OCID of the target resource associated with the privilegedApi request. The operator raises an privilegedApi request to get approval to access the target resource.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 48

def resource_id
  @resource_id
end

#resource_name ⇒ String

resourceName for which the PrivilegedApiRequest is applicable

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 43

def resource_name
  @resource_name
end

#resource_type ⇒ String

resourceType for which the PrivilegedApiRequest is applicable

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 56

def resource_type
  @resource_type
end

#severity ⇒ String

Priority assigned to the privilegedApi request by the operator

Returns:

  • (String) 


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

def severity
  @severity
end

#state ⇒ String

The current state of the Access Request.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 65

def state
  @state
end

#sub_resource_name_list ⇒ Array<String>

The subresource names requested for approval.

Returns:

  • (Array<String>) 


52
53
54
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 52

def sub_resource_name_list
  @sub_resource_name_list
end

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

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


119
120
121
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 119

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Time when the privilegedApi request was created by the operator user in RFC 3339 timestamp format.Example: '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 78

def time_created
  @time_created
end

#time_requested_for_future_access ⇒ DateTime

Time in future when the user for the access request needs to be created in 3339[https://tools.ietf.org/html/rfc3339]timestamp format. Example: '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime) 


96
97
98
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 96

def time_requested_for_future_access
  @time_requested_for_future_access
end

#time_updated ⇒ DateTime

Time when the privilegedApi request was last modified in RFC 3339 timestamp format.Example: '2020-05-22T21:10:29.600Z'

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 83

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 122

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'request_id': :'requestId',
    'reason_summary': :'reasonSummary',
    'compartment_id': :'compartmentId',
    'resource_name': :'resourceName',
    'resource_id': :'resourceId',
    'sub_resource_name_list': :'subResourceNameList',
    'resource_type': :'resourceType',
    'privileged_operation_list': :'privilegedOperationList',
    'state': :'state',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'duration_in_hrs': :'durationInHrs',
    'severity': :'severity',
    'time_requested_for_future_access': :'timeRequestedForFutureAccess',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 151

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'request_id': :'String',
    'reason_summary': :'String',
    'compartment_id': :'String',
    'resource_name': :'String',
    'resource_id': :'String',
    'sub_resource_name_list': :'Array<String>',
    'resource_type': :'String',
    'privileged_operation_list': :'Array<OCI::Apiaccesscontrol::Models::PrivilegedApiRequestOperationDetails>',
    'state': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'duration_in_hrs': :'Integer',
    'severity': :'String',
    'time_requested_for_future_access': :'DateTime',
    '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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 347

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    request_id == other.request_id &&
    reason_summary == other.reason_summary &&
    compartment_id == other.compartment_id &&
    resource_name == other.resource_name &&
    resource_id == other.resource_id &&
    sub_resource_name_list == other.sub_resource_name_list &&
    resource_type == other.resource_type &&
    privileged_operation_list == other.privileged_operation_list &&
    state == other.state &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    duration_in_hrs == other.duration_in_hrs &&
    severity == other.severity &&
    time_requested_for_future_access == other.time_requested_for_future_access &&
    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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 397

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


377
378
379
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 377

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



386
387
388
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 386

def hash
  [id, display_name, request_id, reason_summary, compartment_id, resource_name, resource_id, sub_resource_name_list, resource_type, privileged_operation_list, state, lifecycle_state, lifecycle_details, time_created, time_updated, duration_in_hrs, severity, time_requested_for_future_access, 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



430
431
432
433
434
435
436
437
438
439
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 430

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



424
425
426
 
# File 'lib/oci/apiaccesscontrol/models/privileged_api_request_summary.rb', line 424

def to_s
  to_hash.to_s
end