Class: OCI::MarketplacePublisher::Models::CreateListingRevisionDetails

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

Overview

The model for an Oracle Cloud Infrastructure Marketplace Publisher listing revision. 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

LISTING_TYPE_ENUM = 
[
  LISTING_TYPE_OCI_APPLICATION = 'OCI_APPLICATION'.freeze,
  LISTING_TYPE_LEAD_GENERATION = 'LEAD_GENERATION'.freeze,
  LISTING_TYPE_SERVICE = 'SERVICE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateListingRevisionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 172

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

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

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

  self.listing_type = attributes[:'listingType'] if attributes[:'listingType']

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

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

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

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

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

  self.short_description = attributes[:'shortDescription'] if attributes[:'shortDescription']

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

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

  self.usage_information = attributes[:'usageInformation'] if attributes[:'usageInformation']

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

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

  self.long_description = attributes[:'longDescription'] if attributes[:'longDescription']

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

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

  self.content_language = attributes[:'contentLanguage'] if attributes[:'contentLanguage']

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

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

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

  self.support_contacts = attributes[:'supportContacts'] if attributes[:'supportContacts']

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

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

  self.support_links = attributes[:'supportLinks'] if attributes[:'supportLinks']

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

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

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

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

Instance Attribute Details

#content_language ⇒ OCI::MarketplacePublisher::Models::LanguageItem

Returns:



55
56
57
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 55

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


83
84
85
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 83

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The name for the listing revision.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 20

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


77
78
79
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 77

def freeform_tags
  @freeform_tags
end

#headline ⇒ String

[Required] Single line introduction for the listing revision.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 32

def headline
  @headline
end

#keywords ⇒ String

Keywords associated with the listing revision.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 40

def keywords
  @keywords
end

#listing_id ⇒ String

[Required] The unique identifier for the listing this revision belongs to.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 24

def listing_id
  @listing_id
end

#listing_type ⇒ String

[Required] The listing's type. Populated from the listing.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 28

def listing_type
  @listing_type
end

#long_description ⇒ String

A long description for the listing revision.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 52

def long_description
  @long_description
end

#short_description ⇒ String

A short description for the listing revision.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 44

def short_description
  @short_description
end

#status ⇒ String

The current status of the Listing revision.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 71

def status
  @status
end

#support_contacts ⇒ Array<OCI::MarketplacePublisher::Models::SupportContact>

Contact information to use to get support from the publisher for the listing revision.

Returns:



63
64
65
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 63

def support_contacts
  @support_contacts
end

#support_links ⇒ Array<OCI::MarketplacePublisher::Models::NamedLink>

Links to support resources for the listing revision.

Returns:



67
68
69
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 67

def support_links
  @support_links
end

#supportedlanguages ⇒ Array<OCI::MarketplacePublisher::Models::LanguageItem>

Languages supported by the publisher for the listing revision.

Returns:



59
60
61
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 59

def supportedlanguages
  @supportedlanguages
end

#tagline ⇒ String

The tagline for the listing revision.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 36

def tagline
  @tagline
end

#usage_information ⇒ String

Usage information for the listing revision.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 48

def usage_information
  @usage_information
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'listing_id': :'listingId',
    'listing_type': :'listingType',
    'headline': :'headline',
    'tagline': :'tagline',
    'keywords': :'keywords',
    'short_description': :'shortDescription',
    'usage_information': :'usageInformation',
    'long_description': :'longDescription',
    'content_language': :'contentLanguage',
    'supportedlanguages': :'supportedlanguages',
    'support_contacts': :'supportContacts',
    'support_links': :'supportLinks',
    'status': :'status',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # 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.



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 138

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

  return 'OCI::MarketplacePublisher::Models::CreateOciListingRevisionDetails' if type == 'OCI_APPLICATION'
  return 'OCI::MarketplacePublisher::Models::CreateServiceListingRevisionDetails' if type == 'SERVICE'
  return 'OCI::MarketplacePublisher::Models::CreateLeadGenListingRevisionDetails' if type == 'LEAD_GENERATION'

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

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'listing_id': :'String',
    'listing_type': :'String',
    'headline': :'String',
    'tagline': :'String',
    'keywords': :'String',
    'short_description': :'String',
    'usage_information': :'String',
    'long_description': :'String',
    'content_language': :'OCI::MarketplacePublisher::Models::LanguageItem',
    'supportedlanguages': :'Array<OCI::MarketplacePublisher::Models::LanguageItem>',
    'support_contacts': :'Array<OCI::MarketplacePublisher::Models::SupportContact>',
    'support_links': :'Array<OCI::MarketplacePublisher::Models::NamedLink>',
    'status': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 270

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

  self.class == other.class &&
    display_name == other.display_name &&
    listing_id == other.listing_id &&
    listing_type == other.listing_type &&
    headline == other.headline &&
    tagline == other.tagline &&
    keywords == other.keywords &&
    short_description == other.short_description &&
    usage_information == other.usage_information &&
    long_description == other.long_description &&
    content_language == other.content_language &&
    supportedlanguages == other.supportedlanguages &&
    support_contacts == other.support_contacts &&
    support_links == other.support_links &&
    status == other.status &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 315

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


295
296
297
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 295

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



304
305
306
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 304

def hash
  [display_name, listing_id, listing_type, headline, tagline, keywords, short_description, usage_information, long_description, content_language, supportedlanguages, support_contacts, support_links, status, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



348
349
350
351
352
353
354
355
356
357
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 348

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



342
343
344
 
# File 'lib/oci/marketplace_publisher/models/create_listing_revision_details.rb', line 342

def to_s
  to_hash.to_s
end