Class: OCI::MarketplacePublisher::Models::OciListingRevision

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

Overview

Listing revision details for listings

Constant Summary collapse

PRICING_TYPE_ENUM =
[
  PRICING_TYPE_FREE = 'FREE'.freeze,
  PRICING_TYPE_BYOL = 'BYOL'.freeze,
  PRICING_TYPE_PAYGO = 'PAYGO'.freeze,
  PRICING_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from ListingRevision

ListingRevision::LIFECYCLE_STATE_ENUM, ListingRevision::LISTING_TYPE_ENUM, ListingRevision::PACKAGE_TYPE_ENUM, ListingRevision::STATUS_ENUM

Instance Attribute Summary collapse

Attributes inherited from ListingRevision

#compartment_id, #content_language, #defined_tags, #display_name, #extended_metadata, #freeform_tags, #headline, #icon, #id, #keywords, #lifecycle_state, #listing_id, #listing_type, #long_description, #package_type, #revision_number, #short_description, #status, #status_notes, #support_contacts, #support_links, #supportedlanguages, #system_tags, #tagline, #time_created, #time_updated, #usage_information

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ListingRevision

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ OciListingRevision

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 198

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

  attributes['listingType'] = 'OCI_APPLICATION'

  super(attributes)

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

  self.version_details = attributes[:'versionDetails'] if attributes[:'versionDetails']

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

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

  self.system_requirements = attributes[:'systemRequirements'] if attributes[:'systemRequirements']

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

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

  self.pricing_type = attributes[:'pricingType'] if attributes[:'pricingType']

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

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

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

  self.pricing_plans = attributes[:'pricingPlans'] if attributes[:'pricingPlans']

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

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

  self.availability_and_pricing_policy = attributes[:'availabilityAndPricingPolicy'] if attributes[:'availabilityAndPricingPolicy']

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

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

  self.allowed_tenancies = attributes[:'allowedTenancies'] if attributes[:'allowedTenancies']

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

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

  self.vanity_url = attributes[:'vanityUrl'] if attributes[:'vanityUrl']

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

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

  self.recommended_service_provider_listing_ids = attributes[:'recommendedServiceProviderListingIds'] if attributes[:'recommendedServiceProviderListingIds']

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

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

  self.are_internal_tenancy_launch_allowed = attributes[:'areInternalTenancyLaunchAllowed'] unless attributes[:'areInternalTenancyLaunchAllowed'].nil?

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

  self.are_internal_tenancy_launch_allowed = attributes[:'are_internal_tenancy_launch_allowed'] unless attributes[:'are_internal_tenancy_launch_allowed'].nil?

  self.is_rover_exportable = attributes[:'isRoverExportable'] unless attributes[:'isRoverExportable'].nil?

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

  self.is_rover_exportable = attributes[:'is_rover_exportable'] unless attributes[:'is_rover_exportable'].nil?
end

Instance Attribute Details

#allowed_tenanciesArray<String>

Allowed tenancies provided when a listing revision is published as private.

Returns:

  • (Array<String>)


45
46
47
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 45

def allowed_tenancies
  @allowed_tenancies
end

#are_internal_tenancy_launch_allowedBOOLEAN

Identifies whether publisher allows internal tenancy launches for the listing revision.

Returns:

  • (BOOLEAN)


57
58
59
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 57

def are_internal_tenancy_launch_allowed
  @are_internal_tenancy_launch_allowed
end

#availability_and_pricing_policyString

Listing availability and Pricing Policy statement.

Returns:

  • (String)


41
42
43
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 41

def availability_and_pricing_policy
  @availability_and_pricing_policy
end

#is_rover_exportableBOOLEAN

Is this listing rover exportable

Returns:

  • (BOOLEAN)


61
62
63
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 61

def is_rover_exportable
  @is_rover_exportable
end

#pricing_plansArray<OCI::MarketplacePublisher::Models::PricingPlan>

List of Pricing Plans provided by publisher.



37
38
39
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 37

def pricing_plans
  @pricing_plans
end

#pricing_typeString

[Required] The pricing model for the listing revision.

Returns:

  • (String)


29
30
31
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 29

def pricing_type
  @pricing_type
end

#productsArray<OCI::MarketplacePublisher::Models::ListingProduct>

[Required] List of products subscribed by listing.



33
34
35
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 33

def products
  @products
end

OCIDs of service listings attached to lead gen listing

Returns:

  • (Array<String>)


53
54
55
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 53

def recommended_service_provider_listing_ids
  @recommended_service_provider_listing_ids
end

#system_requirementsString

System requirements for the listing revision.

Returns:

  • (String)


25
26
27
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 25

def system_requirements
  @system_requirements
end

#vanity_urlString

Custom link to the listing

Returns:

  • (String)


49
50
51
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 49

def vanity_url
  @vanity_url
end

#version_detailsOCI::MarketplacePublisher::Models::VersionDetails



21
22
23
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 21

def version_details
  @version_details
end

Class Method Details

.attribute_mapObject

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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/oci_listing_revision.rb', line 64

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'listing_id': :'listingId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'revision_number': :'revisionNumber',
    'headline': :'headline',
    'tagline': :'tagline',
    'keywords': :'keywords',
    'short_description': :'shortDescription',
    'usage_information': :'usageInformation',
    'long_description': :'longDescription',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'content_language': :'contentLanguage',
    'supportedlanguages': :'supportedlanguages',
    'support_contacts': :'supportContacts',
    'support_links': :'supportLinks',
    'icon': :'icon',
    'status': :'status',
    'status_notes': :'statusNotes',
    'lifecycle_state': :'lifecycleState',
    'package_type': :'packageType',
    'listing_type': :'listingType',
    'extended_metadata': :'extendedMetadata',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'version_details': :'versionDetails',
    'system_requirements': :'systemRequirements',
    'pricing_type': :'pricingType',
    'products': :'products',
    'pricing_plans': :'pricingPlans',
    'availability_and_pricing_policy': :'availabilityAndPricingPolicy',
    'allowed_tenancies': :'allowedTenancies',
    'vanity_url': :'vanityUrl',
    'recommended_service_provider_listing_ids': :'recommendedServiceProviderListingIds',
    'are_internal_tenancy_launch_allowed': :'areInternalTenancyLaunchAllowed',
    'is_rover_exportable': :'isRoverExportable'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'listing_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'revision_number': :'String',
    'headline': :'String',
    'tagline': :'String',
    'keywords': :'String',
    'short_description': :'String',
    'usage_information': :'String',
    'long_description': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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>',
    'icon': :'OCI::MarketplacePublisher::Models::ListingRevisionIconAttachment',
    'status': :'String',
    'status_notes': :'String',
    'lifecycle_state': :'String',
    'package_type': :'String',
    'listing_type': :'String',
    'extended_metadata': :'Hash<String, String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'version_details': :'OCI::MarketplacePublisher::Models::VersionDetails',
    'system_requirements': :'String',
    'pricing_type': :'String',
    'products': :'Array<OCI::MarketplacePublisher::Models::ListingProduct>',
    'pricing_plans': :'Array<OCI::MarketplacePublisher::Models::PricingPlan>',
    'availability_and_pricing_policy': :'String',
    'allowed_tenancies': :'Array<String>',
    'vanity_url': :'String',
    'recommended_service_provider_listing_ids': :'Array<String>',
    'are_internal_tenancy_launch_allowed': :'BOOLEAN',
    'is_rover_exportable': :'BOOLEAN'
    # 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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 291

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

  self.class == other.class &&
    id == other.id &&
    listing_id == other.listing_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    revision_number == other.revision_number &&
    headline == other.headline &&
    tagline == other.tagline &&
    keywords == other.keywords &&
    short_description == other.short_description &&
    usage_information == other.usage_information &&
    long_description == other.long_description &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    content_language == other.content_language &&
    supportedlanguages == other.supportedlanguages &&
    support_contacts == other.support_contacts &&
    support_links == other.support_links &&
    icon == other.icon &&
    status == other.status &&
    status_notes == other.status_notes &&
    lifecycle_state == other.lifecycle_state &&
    package_type == other.package_type &&
    listing_type == other.listing_type &&
     == other. &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    version_details == other.version_details &&
    system_requirements == other.system_requirements &&
    pricing_type == other.pricing_type &&
    products == other.products &&
    pricing_plans == other.pricing_plans &&
    availability_and_pricing_policy == other.availability_and_pricing_policy &&
    allowed_tenancies == other.allowed_tenancies &&
    vanity_url == other.vanity_url &&
    recommended_service_provider_listing_ids == other.recommended_service_provider_listing_ids &&
    are_internal_tenancy_launch_allowed == other.are_internal_tenancy_launch_allowed &&
    is_rover_exportable == other.is_rover_exportable
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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 358

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


338
339
340
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 338

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



347
348
349
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 347

def hash
  [id, listing_id, compartment_id, display_name, revision_number, headline, tagline, keywords, short_description, usage_information, long_description, time_created, time_updated, content_language, supportedlanguages, support_contacts, support_links, icon, status, status_notes, lifecycle_state, package_type, listing_type, , freeform_tags, defined_tags, system_tags, version_details, system_requirements, pricing_type, products, pricing_plans, availability_and_pricing_policy, allowed_tenancies, vanity_url, recommended_service_provider_listing_ids, are_internal_tenancy_launch_allowed, is_rover_exportable].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



391
392
393
394
395
396
397
398
399
400
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 391

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



385
386
387
# File 'lib/oci/marketplace_publisher/models/oci_listing_revision.rb', line 385

def to_s
  to_hash.to_s
end