Class: OCI::MarketplacePublisher::Models::CreateReviewSupportDocumentAttachment

Inherits:
CreateListingRevisionAttachmentDetails show all
Defined in:
lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb

Overview

Reviewsupport document attachment for the listing revision.

Instance Attribute Summary collapse

Attributes inherited from CreateListingRevisionAttachmentDetails

#attachment_type, #defined_tags, #description, #display_name, #freeform_tags, #listing_revision_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateListingRevisionAttachmentDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateReviewSupportDocumentAttachment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

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

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

  • :document_name (String) —

    The value to assign to the #document_name property

  • :template_code (String) —

    The value to assign to the #template_code property



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb', line 65

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

Instance Attribute Details

#document_name ⇒ String

[Required] Name of the review support document

Returns:

  • (String) 


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

def document_name
  @document_name
end

#template_code ⇒ String

[Required] Type of review support document

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/marketplace_publisher/models/create_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.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb', line 21

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'listing_revision_id': :'listingRevisionId',
    'display_name': :'displayName',
    'description': :'description',
    'attachment_type': :'attachmentType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'document_name': :'documentName',
    'template_code': :'templateCode'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'listing_revision_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'attachment_type': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'document_name': :'String',
    'template_code': :'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



95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb', line 95

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

  self.class == other.class &&
    listing_revision_id == other.listing_revision_id &&
    display_name == other.display_name &&
    description == other.description &&
    attachment_type == other.attachment_type &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    document_name == other.document_name &&
    template_code == other.template_code
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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb', line 132

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


112
113
114
 
# File 'lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb', line 112

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb', line 121

def hash
  [listing_revision_id, display_name, description, attachment_type, freeform_tags, defined_tags, document_name, template_code].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb', line 165

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



159
160
161
 
# File 'lib/oci/marketplace_publisher/models/create_review_support_document_attachment.rb', line 159

def to_s
  to_hash.to_s
end