Class: OCI::Opa::Models::CreateOpaInstanceDetails

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

Overview

The information about new OpaInstance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOpaInstanceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

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

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

  • :idcs_at (String)

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 107

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

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

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

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

Instance Attribute Details

#compartment_idString

[Required] Compartment Identifier

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#consumption_modelString

Parameter specifying which entitlement to use for billing purposes

Returns:

  • (String)


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

def consumption_model
  @consumption_model
end

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


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

def defined_tags
  @defined_tags
end

#descriptionString

Description of the Oracle Process Automation instance.

Returns:

  • (String)


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

def description
  @description
end

#display_nameString

[Required] OpaInstance Identifier. User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.

Returns:

  • (String)


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

def display_name
  @display_name
end

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


47
48
49
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 47

def freeform_tags
  @freeform_tags
end

#idcs_atString

IDCS Authentication token. This is required for all realms with IDCS. This property is optional, as it is not required for non-IDCS realms.

Returns:

  • (String)


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

def idcs_at
  @idcs_at
end

#is_breakglass_enabledBOOLEAN

indicates if breakGlass is enabled for the opa instance.

Returns:

  • (BOOLEAN)


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

def is_breakglass_enabled
  @is_breakglass_enabled
end

#metering_typeString

MeteringType Identifier

Returns:

  • (String)


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

def metering_type
  @metering_type
end

#shape_nameString

[Required] Shape of the instance.

Returns:

  • (String)


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

def shape_name
  @shape_name
end

Class Method Details

.attribute_mapObject

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 56

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'consumption_model': :'consumptionModel',
    'shape_name': :'shapeName',
    'metering_type': :'meteringType',
    'idcs_at': :'idcsAt',
    'is_breakglass_enabled': :'isBreakglassEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 74

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'consumption_model': :'String',
    'shape_name': :'String',
    'metering_type': :'String',
    'idcs_at': :'String',
    'is_breakglass_enabled': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 177

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    consumption_model == other.consumption_model &&
    shape_name == other.shape_name &&
    metering_type == other.metering_type &&
    idcs_at == other.idcs_at &&
    is_breakglass_enabled == other.is_breakglass_enabled &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 216

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


196
197
198
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 196

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



205
206
207
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 205

def hash
  [display_name, description, compartment_id, consumption_model, shape_name, metering_type, idcs_at, is_breakglass_enabled, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



249
250
251
252
253
254
255
256
257
258
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 249

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



243
244
245
# File 'lib/oci/opa/models/create_opa_instance_details.rb', line 243

def to_s
  to_hash.to_s
end