Class: OCI::Opa::Models::OpaInstanceSummary

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

Overview

Summary of the OpaInstance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpaInstanceSummary

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

  • :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



144
145
146
147
148
149
150
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
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
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 144

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment Identifier

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 25

def compartment_id
  @compartment_id
end

#consumption_model ⇒ String

Parameter specifying which entitlement to use for billing purposes

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 33

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the Process Automation instance.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 21

def description
  @description
end

#display_name ⇒ String

[Required] OpaInstance Identifier, can be renamed

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 17

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


63
64
65
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 63

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 13

def id
  @id
end

#instance_url ⇒ String

OPA Instance URL

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 29

def instance_url
  @instance_url
end

#is_breakglass_enabled ⇒ BOOLEAN

indicates if breakGlass is enabled for the opa instance.

Returns:

  • (BOOLEAN) 


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

def is_breakglass_enabled
  @is_breakglass_enabled
end

#lifecycle_state ⇒ String

[Required] The current state of the OpaInstance.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#metering_type ⇒ String

MeteringType Identifier

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 41

def metering_type
  @metering_type
end

#shape_name ⇒ String

[Required] Shape of the instance.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 37

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


75
76
77
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 75

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 78

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',
    'is_breakglass_enabled': :'isBreakglassEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 101

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',
    'is_breakglass_enabled': :'BOOLEAN',
    '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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 240

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 &&
    is_breakglass_enabled == other.is_breakglass_enabled &&
    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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 284

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


264
265
266
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 264

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



273
274
275
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 273

def hash
  [id, display_name, description, compartment_id, instance_url, consumption_model, shape_name, metering_type, time_created, time_updated, lifecycle_state, is_breakglass_enabled, 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



317
318
319
320
321
322
323
324
325
326
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 317

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



311
312
313
 
# File 'lib/oci/opa/models/opa_instance_summary.rb', line 311

def to_s
  to_hash.to_s
end