Class: OCI::Oda::Models::CreateOdaInstanceAttachmentDetails

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

Overview

Properties required to create an ODA instance attachment.

Constant Summary collapse

ATTACHMENT_TYPE_ENUM = 
[
  ATTACHMENT_TYPE_FUSION = 'FUSION'.freeze,
  ATTACHMENT_TYPE_MAX = 'MAX'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOdaInstanceAttachmentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 91

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.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.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 this ODA instance is being attached.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 18

def attach_to_id
  @attach_to_id
end

#attachment_metadata ⇒ String

Attachment specific metadata. Defined by the target service.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 26

def attachment_metadata
  @attachment_metadata
end

#attachment_type ⇒ String

[Required] The type of target instance which this ODA instance is being attached.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 22

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


46
47
48
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 46

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


40
41
42
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 40

def freeform_tags
  @freeform_tags
end

#owner ⇒ OCI::Oda::Models::OdaInstanceAttachmentOwner

This attribute is required.

Returns:



34
35
36
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 34

def owner
  @owner
end

#restricted_operations ⇒ Array<String>

List of operations that are restricted while this instance is attached.

Returns:

  • (Array<String>) 


30
31
32
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 30

def restricted_operations
  @restricted_operations
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'attach_to_id': :'attachToId',
    'attachment_type': :'attachmentType',
    'attachment_metadata': :'attachmentMetadata',
    'restricted_operations': :'restrictedOperations',
    'owner': :'owner',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 64

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



151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 151

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

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 187

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


167
168
169
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 167

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



176
177
178
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 176

def hash
  [attach_to_id, attachment_type, attachment_metadata, restricted_operations, owner, 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



220
221
222
223
224
225
226
227
228
229
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 220

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



214
215
216
 
# File 'lib/oci/oda/models/create_oda_instance_attachment_details.rb', line 214

def to_s
  to_hash.to_s
end