Class: OCI::Oda::Models::OdaInstanceAttachment

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oda/models/oda_instance_attachment.rb

Overview

Description of an ODA instance attachment.

Constant Summary collapse

ATTACHMENT_TYPE_ENUM = 
[
  ATTACHMENT_TYPE_FUSION = 'FUSION'.freeze,
  ATTACHMENT_TYPE_MAX = 'MAX'.freeze,
  ATTACHMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ATTACHING = 'ATTACHING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DETACHING = 'DETACHING'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ OdaInstanceAttachment

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

  • :instance_id (String) —

    The value to assign to the #instance_id property

  • :attach_to_id (String) —

    The value to assign to the #attach_to_id property

  • :attachment_type (String) —

    The value to assign to the #attachment_type property

  • :attachment_metadata (String) —

    The value to assign to the #attachment_metadata property

  • :restricted_operations (Array<String>) —

    The value to assign to the #restricted_operations property

  • :owner (OCI::Oda::Models::OdaInstanceOwner) —

    The value to assign to the #owner property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_last_update (DateTime) —

    The value to assign to the #time_last_update property

  • :lifecycle_state (String) —

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



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
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
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 136

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

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

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

  self.attach_to_id = attributes[:'attachToId'] if attributes[:'attachToId']

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

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

  self.attachment_type = attributes[:'attachmentType'] if attributes[:'attachmentType']

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

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

  self.attachment_metadata = attributes[:'attachmentMetadata'] if attributes[:'attachmentMetadata']

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

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

  self.restricted_operations = attributes[:'restrictedOperations'] if attributes[:'restrictedOperations']

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

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

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

  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_last_update = attributes[:'timeLastUpdate'] if attributes[:'timeLastUpdate']

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

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

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

#attach_to_id ⇒ String

[Required] The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which the ODA instance is or is being attached.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 37

def attach_to_id
  @attach_to_id
end

#attachment_metadata ⇒ String

Attachment-specific metadata, defined by the target service.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 45

def attachment_metadata
  @attachment_metadata
end

#attachment_type ⇒ String

[Required] The type of attachment defined as an enum.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 41

def attachment_type
  @attachment_type
end

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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


76
77
78
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 76

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type, or scope. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


70
71
72
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 70

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique immutable identifier that was assigned when the ODA instance attachment was created.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 29

def id
  @id
end

#instance_id ⇒ String

[Required] The OCID of the ODA instance to which the attachment applies.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 33

def instance_id
  @instance_id
end

#lifecycle_state ⇒ String

[Required] The current state of the attachment.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 64

def lifecycle_state
  @lifecycle_state
end

#owner ⇒ OCI::Oda::Models::OdaInstanceOwner

Returns:



52
53
54
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 52

def owner
  @owner
end

#restricted_operations ⇒ Array<String>

List of operation names that are restricted while this ODA instance is attached.

Returns:

  • (Array<String>) 


49
50
51
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 49

def restricted_operations
  @restricted_operations
end

#time_created ⇒ DateTime

The time the attachment was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 56

def time_created
  @time_created
end

#time_last_update ⇒ DateTime

The time the attachment was last modified. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 60

def time_last_update
  @time_last_update
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'instance_id': :'instanceId',
    'attach_to_id': :'attachToId',
    'attachment_type': :'attachmentType',
    'attachment_metadata': :'attachmentMetadata',
    'restricted_operations': :'restrictedOperations',
    'owner': :'owner',
    'time_created': :'timeCreated',
    'time_last_update': :'timeLastUpdate',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 99

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'instance_id': :'String',
    'attach_to_id': :'String',
    'attachment_type': :'String',
    'attachment_metadata': :'String',
    'restricted_operations': :'Array<String>',
    'owner': :'OCI::Oda::Models::OdaInstanceOwner',
    'time_created': :'DateTime',
    'time_last_update': :'DateTime',
    'lifecycle_state': :'String',
    '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



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

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

  self.class == other.class &&
    id == other.id &&
    instance_id == other.instance_id &&
    attach_to_id == other.attach_to_id &&
    attachment_type == other.attachment_type &&
    attachment_metadata == other.attachment_metadata &&
    restricted_operations == other.restricted_operations &&
    owner == other.owner &&
    time_created == other.time_created &&
    time_last_update == other.time_last_update &&
    lifecycle_state == other.lifecycle_state &&
    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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 281

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


261
262
263
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 261

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



270
271
272
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 270

def hash
  [id, instance_id, attach_to_id, attachment_type, attachment_metadata, restricted_operations, owner, time_created, time_last_update, lifecycle_state, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 314

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



308
309
310
 
# File 'lib/oci/oda/models/oda_instance_attachment.rb', line 308

def to_s
  to_hash.to_s
end