Class: OCI::MarketplacePublisher::Models::ReviewSupportDocumentAttachment

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

Overview

Review document attachment for the listing revision.

Constant Summary

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 = {}) ⇒ ReviewSupportDocumentAttachment

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_name (String) —

    The value to assign to the #document_name property

  • :template_code (String) —

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



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

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

  attributes['attachmentType'] = 'REVIEW_SUPPORT_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_name = attributes[:'documentName'] if attributes[:'documentName']

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

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

  self.template_code = attributes[:'templateCode'] if attributes[:'templateCode']

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

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

  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) 


22
23
24
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 22

def content_url
  @content_url
end

#document_name ⇒ String

[Required] Name of the review support document

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 14

def document_name
  @document_name
end

#mime_type ⇒ String

The MIME type of the uploaded data.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 26

def mime_type
  @mime_type
end

#template_code ⇒ String

[Required] Template code for the uploaded document

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 18

def template_code
  @template_code
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 29

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_name': :'documentName',
    'template_code': :'templateCode',
    'content_url': :'contentUrl',
    'mime_type': :'mimeType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 53

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_name': :'String',
    'template_code': :'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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 139

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_name == other.document_name &&
    template_code == other.template_code &&
    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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 184

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


164
165
166
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 164

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 173

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_name, template_code, 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



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 217

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



211
212
213
 
# File 'lib/oci/marketplace_publisher/models/review_support_document_attachment.rb', line 211

def to_s
  to_hash.to_s
end