Class: OCI::MarketplacePublisher::Models::ListingRevisionAttachment

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace_publisher/models/listing_revision_attachment.rb

Overview

A attachment for the listing revision. User can provide an external URL/upload a file This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

ATTACHMENT_TYPE_ENUM = 
[
  ATTACHMENT_TYPE_RELATED_DOCUMENT = 'RELATED_DOCUMENT'.freeze,
  ATTACHMENT_TYPE_SCREENSHOT = 'SCREENSHOT'.freeze,
  ATTACHMENT_TYPE_VIDEO = 'VIDEO'.freeze,
  ATTACHMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ ListingRevisionAttachment

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :listing_revision_id (String) —

    The value to assign to the #listing_revision_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :attachment_type (String) —

    The value to assign to the #attachment_type property

  • :lifecycle_state (String) —

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

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



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
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 157

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

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

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

#attachment_type ⇒ String

[Required] Possible values for the publisher listing revision attachments. The attachment type informs the type of attachment for the listing revision.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 50

def attachment_type
  @attachment_type
end

#compartment_id ⇒ String

[Required] The unique identifier for the compartment.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 33

def compartment_id
  @compartment_id
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>>) 


74
75
76
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 74

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the listing revision attachment.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 45

def description
  @description
end

#display_name ⇒ String

[Required] Name of the listing revision attachment.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 41

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


68
69
70
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 68

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique OCID identifier for the listing revision attachment.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 29

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the attachment.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 54

def lifecycle_state
  @lifecycle_state
end

#listing_revision_id ⇒ String

[Required] The unique identifier of the listing revision that the specified attachment belongs to.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 37

def listing_revision_id
  @listing_revision_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


80
81
82
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 80

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 58

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the attachment was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 62

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'listing_revision_id': :'listingRevisionId',
    'display_name': :'displayName',
    'description': :'description',
    'attachment_type': :'attachmentType',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 127

def self.get_subtype(object_hash)
  type = object_hash[:'attachmentType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::MarketplacePublisher::Models::RelatedDocumentAttachment' if type == 'RELATED_DOCUMENT'
  return 'OCI::MarketplacePublisher::Models::ScreenShotAttachment' if type == 'SCREENSHOT'
  return 'OCI::MarketplacePublisher::Models::VideoAttachment' if type == 'VIDEO'

  # TODO: Log a warning when the subtype is not found.
  'OCI::MarketplacePublisher::Models::ListingRevisionAttachment'
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'listing_revision_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'attachment_type': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 261

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    listing_revision_id == other.listing_revision_id &&
    display_name == other.display_name &&
    description == other.description &&
    attachment_type == other.attachment_type &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 302

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


282
283
284
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 282

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



291
292
293
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 291

def hash
  [id, compartment_id, listing_revision_id, display_name, description, attachment_type, lifecycle_state, time_created, time_updated, 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



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 335

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



329
330
331
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_attachment.rb', line 329

def to_s
  to_hash.to_s
end