Class: OCI::Opa::Models::OpaInstance

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

Overview

Description of OpaInstance.

Constant Summary collapse

CONSUMPTION_MODEL_ENUM = 
[
  CONSUMPTION_MODEL_UCM = 'UCM'.freeze,
  CONSUMPTION_MODEL_GOV = 'GOV'.freeze,
  CONSUMPTION_MODEL_SAAS = 'SAAS'.freeze,
  CONSUMPTION_MODEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SHAPE_NAME_ENUM = 
[
  SHAPE_NAME_DEVELOPMENT = 'DEVELOPMENT'.freeze,
  SHAPE_NAME_PRODUCTION = 'PRODUCTION'.freeze,
  SHAPE_NAME_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
METERING_TYPE_ENUM = 
[
  METERING_TYPE_EXECUTION_PACK = 'EXECUTION_PACK'.freeze,
  METERING_TYPE_USERS = 'USERS'.freeze,
  METERING_TYPE_EMPLOYEE = 'EMPLOYEE'.freeze,
  METERING_TYPE_NAMED_USER = 'NAMED_USER'.freeze,
  METERING_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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 = {}) ⇒ OpaInstance

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

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :instance_url (String) —

    The value to assign to the #instance_url property

  • :consumption_model (String) —

    The value to assign to the #consumption_model property

  • :shape_name (String) —

    The value to assign to the #shape_name property

  • :metering_type (String) —

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

  • :identity_app_guid (String) —

    The value to assign to the #identity_app_guid property

  • :identity_app_display_name (String) —

    The value to assign to the #identity_app_display_name property

  • :identity_domain_url (String) —

    The value to assign to the #identity_domain_url property

  • :identity_app_opc_service_instance_guid (String) —

    The value to assign to the #identity_app_opc_service_instance_guid property

  • :is_breakglass_enabled (BOOLEAN) —

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

  • :attachments (Array<OCI::Opa::Models::AttachmentDetails>) —

    The value to assign to the #attachments property



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/opa/models/opa_instance.rb', line 212

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

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

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

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

  self.consumption_model = attributes[:'consumptionModel'] if attributes[:'consumptionModel']

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

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

  self.shape_name = attributes[:'shapeName'] if attributes[:'shapeName']

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

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

  self.metering_type = attributes[:'meteringType'] if attributes[:'meteringType']

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

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

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

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

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

  self.identity_app_display_name = attributes[:'identityAppDisplayName'] if attributes[:'identityAppDisplayName']

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

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

  self.identity_domain_url = attributes[:'identityDomainUrl'] if attributes[:'identityDomainUrl']

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

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

  self.identity_app_opc_service_instance_guid = attributes[:'identityAppOpcServiceInstanceGuid'] if attributes[:'identityAppOpcServiceInstanceGuid']

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

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

  self.is_breakglass_enabled = attributes[:'isBreakglassEnabled'] unless attributes[:'isBreakglassEnabled'].nil?

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

  self.is_breakglass_enabled = attributes[:'is_breakglass_enabled'] unless attributes[:'is_breakglass_enabled'].nil?

  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']

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

Instance Attribute Details

#attachments ⇒ Array<OCI::Opa::Models::AttachmentDetails>

A list of associated attachments to other services

Returns:



128
129
130
 
# File 'lib/oci/opa/models/opa_instance.rb', line 128

def attachments
  @attachments
end

#compartment_id ⇒ String

[Required] Compartment Identifier

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/opa/models/opa_instance.rb', line 57

def compartment_id
  @compartment_id
end

#consumption_model ⇒ String

The entitlement used for billing purposes

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/opa/models/opa_instance.rb', line 65

def consumption_model
  @consumption_model
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>>) 


117
118
119
 
# File 'lib/oci/opa/models/opa_instance.rb', line 117

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the Process Automation instance.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/opa/models/opa_instance.rb', line 53

def description
  @description
end

#display_name ⇒ String

[Required] OpaInstance Identifier, can be renamed

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/opa/models/opa_instance.rb', line 49

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


111
112
113
 
# File 'lib/oci/opa/models/opa_instance.rb', line 111

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/opa/models/opa_instance.rb', line 45

def id
  @id
end

#identity_app_display_name ⇒ String

This property specifies the name of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/opa/models/opa_instance.rb', line 93

def identity_app_display_name
  @identity_app_display_name
end

#identity_app_guid ⇒ String

This property specifies the GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user role mappings to grant access to this OPA instance for users within the identity domain.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/opa/models/opa_instance.rb', line 89

def identity_app_guid
  @identity_app_guid
end

#identity_app_opc_service_instance_guid ⇒ String

This property specifies the OPC Service Instance GUID of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/opa/models/opa_instance.rb', line 101

def identity_app_opc_service_instance_guid
  @identity_app_opc_service_instance_guid
end

#identity_domain_url ⇒ String

This property specifies the domain url of the Identity Application instance OPA has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this OPA instance for users within the identity domain.

Returns:

  • (String) 


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

def identity_domain_url
  @identity_domain_url
end

#instance_url ⇒ String

OPA Instance URL

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/opa/models/opa_instance.rb', line 61

def instance_url
  @instance_url
end

#is_breakglass_enabled ⇒ BOOLEAN

indicates if breakGlass is enabled for the opa instance.

Returns:

  • (BOOLEAN) 


105
106
107
 
# File 'lib/oci/opa/models/opa_instance.rb', line 105

def is_breakglass_enabled
  @is_breakglass_enabled
end

#lifecycle_state ⇒ String

[Required] The current state of the OpaInstance.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#metering_type ⇒ String

MeteringType Identifier

Returns:

  • (String) 


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

def metering_type
  @metering_type
end

#shape_name ⇒ String

[Required] Shape of the instance.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/opa/models/opa_instance.rb', line 69

def shape_name
  @shape_name
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>>) 


123
124
125
 
# File 'lib/oci/opa/models/opa_instance.rb', line 123

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time when OpaInstance was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/opa/models/opa_instance.rb', line 131

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'instance_url': :'instanceUrl',
    'consumption_model': :'consumptionModel',
    'shape_name': :'shapeName',
    'metering_type': :'meteringType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'identity_app_guid': :'identityAppGuid',
    'identity_app_display_name': :'identityAppDisplayName',
    'identity_domain_url': :'identityDomainUrl',
    'identity_app_opc_service_instance_guid': :'identityAppOpcServiceInstanceGuid',
    'is_breakglass_enabled': :'isBreakglassEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'attachments': :'attachments'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/opa/models/opa_instance.rb', line 159

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'instance_url': :'String',
    'consumption_model': :'String',
    'shape_name': :'String',
    'metering_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'identity_app_guid': :'String',
    'identity_app_display_name': :'String',
    'identity_domain_url': :'String',
    'identity_app_opc_service_instance_guid': :'String',
    'is_breakglass_enabled': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'attachments': :'Array<OCI::Opa::Models::AttachmentDetails>'
    # 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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/oci/opa/models/opa_instance.rb', line 386

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    instance_url == other.instance_url &&
    consumption_model == other.consumption_model &&
    shape_name == other.shape_name &&
    metering_type == other.metering_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    identity_app_guid == other.identity_app_guid &&
    identity_app_display_name == other.identity_app_display_name &&
    identity_domain_url == other.identity_domain_url &&
    identity_app_opc_service_instance_guid == other.identity_app_opc_service_instance_guid &&
    is_breakglass_enabled == other.is_breakglass_enabled &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    attachments == other.attachments
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



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/oci/opa/models/opa_instance.rb', line 435

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


415
416
417
 
# File 'lib/oci/opa/models/opa_instance.rb', line 415

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



424
425
426
 
# File 'lib/oci/opa/models/opa_instance.rb', line 424

def hash
  [id, display_name, description, compartment_id, instance_url, consumption_model, shape_name, metering_type, time_created, time_updated, lifecycle_state, identity_app_guid, identity_app_display_name, identity_domain_url, identity_app_opc_service_instance_guid, is_breakglass_enabled, freeform_tags, defined_tags, system_tags, attachments].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



468
469
470
471
472
473
474
475
476
477
 
# File 'lib/oci/opa/models/opa_instance.rb', line 468

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



462
463
464
 
# File 'lib/oci/opa/models/opa_instance.rb', line 462

def to_s
  to_hash.to_s
end