Class: OCI::MarketplacePublisher::Models::CreateRelatedDocumentAttachmentDetails

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

Overview

Create Details of the related document attachment.

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

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

    The value to assign to the #document_category property



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 59

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

Instance Attribute Details

#document_category ⇒ String

[Required] The document category of the listing revision attachment.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 15

def document_category
  @document_category
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 18

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_category': :'documentCategory'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 33

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_category': :'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



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 83

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_category == other.document_category
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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 119

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


99
100
101
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 99

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



108
109
110
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 108

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 152

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



146
147
148
 
# File 'lib/oci/marketplace_publisher/models/create_related_document_attachment_details.rb', line 146

def to_s
  to_hash.to_s
end