Class: OCI::MarketplacePrivateOffer::Models::Attachment

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace_private_offer/models/attachment.rb

Overview

Description of Attachment.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_CONTRACT_T_AND_C = 'CONTRACT_T_AND_C'.freeze,
  TYPE_QUOTE = 'QUOTE'.freeze,
  TYPE_EULA = 'EULA'.freeze,
  TYPE_TERMS_OF_USE = 'TERMS_OF_USE'.freeze,
  TYPE_MISC = 'MISC'.freeze,
  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 = {}) ⇒ Attachment

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

  • :seller_compartment_id (String) —

    The value to assign to the #seller_compartment_id property

  • :offer_id (String) —

    The value to assign to the #offer_id property

  • :buyer_compartment_id (String) —

    The value to assign to the #buyer_compartment_id property

  • :mime_type (String) —

    The value to assign to the #mime_type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :type (String) —

    The value to assign to the #type property

  • :time_created (DateTime) —

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



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
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
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 134

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

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

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

  self.offer_id = attributes[:'offerId'] if attributes[:'offerId']

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

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

  self.buyer_compartment_id = attributes[:'buyerCompartmentId'] if attributes[:'buyerCompartmentId']

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

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

  self.mime_type = attributes[:'mimeType'] if attributes[:'mimeType']

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

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

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

#buyer_compartment_id ⇒ String

OCID of the buyer's tenancy (root compartment).

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 45

def buyer_compartment_id
  @buyer_compartment_id
end

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

[Required] 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>>) 


77
78
79
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 77

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The name used to refer to the uploaded data.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 53

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


71
72
73
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 71

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 33

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the Offer.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 65

def lifecycle_state
  @lifecycle_state
end

#mime_type ⇒ String

The MIME type of the uploaded data.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 49

def mime_type
  @mime_type
end

#offer_id ⇒ String

[Required] Unique identifier of the associated offer that is immutable on creation

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 41

def offer_id
  @offer_id
end

#seller_compartment_id ⇒ String

[Required] OCID of the seller's tenancy (root compartment).

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 37

def seller_compartment_id
  @seller_compartment_id
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


61
62
63
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 61

def time_created
  @time_created
end

#type ⇒ String

[Required] The type of offer attachment.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 57

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'seller_compartment_id': :'sellerCompartmentId',
    'offer_id': :'offerId',
    'buyer_compartment_id': :'buyerCompartmentId',
    'mime_type': :'mimeType',
    'display_name': :'displayName',
    'type': :'type',
    'time_created': :'timeCreated',
    '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
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 99

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'seller_compartment_id': :'String',
    'offer_id': :'String',
    'buyer_compartment_id': :'String',
    'mime_type': :'String',
    'display_name': :'String',
    'type': :'String',
    'time_created': :'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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 232

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

  self.class == other.class &&
    id == other.id &&
    seller_compartment_id == other.seller_compartment_id &&
    offer_id == other.offer_id &&
    buyer_compartment_id == other.buyer_compartment_id &&
    mime_type == other.mime_type &&
    display_name == other.display_name &&
    type == other.type &&
    time_created == other.time_created &&
    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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 272

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


252
253
254
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 252

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



261
262
263
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 261

def hash
  [id, seller_compartment_id, offer_id, buyer_compartment_id, mime_type, display_name, type, time_created, 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



305
306
307
308
309
310
311
312
313
314
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 305

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



299
300
301
 
# File 'lib/oci/marketplace_private_offer/models/attachment.rb', line 299

def to_s
  to_hash.to_s
end