Class: OCI::MarketplacePublisher::Models::RelatedDocumentAttachment

Inherits:
ListingRevisionAttachment show all
Defined in:
lib/oci/marketplace_publisher/models/related_document_attachment.rb

Overview

Related document attachment for the listing revision.

Constant Summary collapse

DOCUMENT_CATEGORY_ENUM = 
[
  DOCUMENT_CATEGORY_CASE_STUDIES = 'CASE_STUDIES'.freeze,
  DOCUMENT_CATEGORY_CUSTOMIZATION_GUIDES = 'CUSTOMIZATION_GUIDES'.freeze,
  DOCUMENT_CATEGORY_DATA_SHEETS = 'DATA_SHEETS'.freeze,
  DOCUMENT_CATEGORY_PRESS_RELEASE = 'PRESS_RELEASE'.freeze,
  DOCUMENT_CATEGORY_PRODUCT_DOCUMENTATION = 'PRODUCT_DOCUMENTATION'.freeze,
  DOCUMENT_CATEGORY_USER_GUIDES = 'USER_GUIDES'.freeze,
  DOCUMENT_CATEGORY_WEBINARS = 'WEBINARS'.freeze,
  DOCUMENT_CATEGORY_WHITEPAPERS = 'WHITEPAPERS'.freeze,
  DOCUMENT_CATEGORY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from ListingRevisionAttachment

ListingRevisionAttachment::ATTACHMENT_TYPE_ENUM, ListingRevisionAttachment::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ListingRevisionAttachment

#attachment_type, #compartment_id, #defined_tags, #description, #display_name, #freeform_tags, #id, #lifecycle_state, #listing_revision_id, #system_tags, #time_created, #time_updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ListingRevisionAttachment

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ RelatedDocumentAttachment

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 proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id proprety

  • :listing_revision_id (String) —

    The value to assign to the #listing_revision_id proprety

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags proprety

  • :document_category (String) —

    The value to assign to the #document_category property

  • :content_url (String) —

    The value to assign to the #content_url property

  • :mime_type (String) —

    The value to assign to the #mime_type property



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['attachmentType'] = 'RELATED_DOCUMENT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.document_category = attributes[:'documentCategory'] if attributes[:'documentCategory']

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

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

  self.content_url = attributes[:'contentUrl'] if attributes[:'contentUrl']

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

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

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

Instance Attribute Details

#content_url ⇒ String

URL of the uploaded document.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 31

def content_url
  @content_url
end

#document_category ⇒ String

Possible lifecycle states.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 27

def document_category
  @document_category
end

#mime_type ⇒ String

The MIME type of the uploaded data.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 35

def mime_type
  @mime_type
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 38

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',
    'document_category': :'documentCategory',
    'content_url': :'contentUrl',
    'mime_type': :'mimeType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 61

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>>',
    'document_category': :'String',
    'content_url': :'String',
    'mime_type': :'String'
    # 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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 152

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 &&
    document_category == other.document_category &&
    content_url == other.content_url &&
    mime_type == other.mime_type
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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 196

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


176
177
178
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 176

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 185

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, document_category, content_url, mime_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 229

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



223
224
225
 
# File 'lib/oci/marketplace_publisher/models/related_document_attachment.rb', line 223

def to_s
  to_hash.to_s
end