Class: OCI::Marketplace::Models::ThirdPartyPaidListingEligibility

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb

Overview

Tenant eligibility for using third party paid listings

Constant Summary collapse

ELIGIBILITY_REASON_ENUM = 
[
  ELIGIBILITY_REASON_ELIGIBLE = 'ELIGIBLE'.freeze,
  ELIGIBILITY_REASON_INELIGIBLE_ACCOUNT_COUNTRY = 'INELIGIBLE_ACCOUNT_COUNTRY'.freeze,
  ELIGIBILITY_REASON_INELIGIBLE_REGION = 'INELIGIBLE_REGION'.freeze,
  ELIGIBILITY_REASON_INELIGIBLE_ACCOUNT_BLACKLISTED = 'INELIGIBLE_ACCOUNT_BLACKLISTED'.freeze,
  ELIGIBILITY_REASON_INELIGIBLE_ACCOUNT_FEATURE_DISABLED = 'INELIGIBLE_ACCOUNT_FEATURE_DISABLED'.freeze,
  ELIGIBILITY_REASON_INELIGIBLE_ACCOUNT_CURRENCY = 'INELIGIBLE_ACCOUNT_CURRENCY'.freeze,
  ELIGIBILITY_REASON_INELIGIBLE_ACCOUNT_NOT_PAID = 'INELIGIBLE_ACCOUNT_NOT_PAID'.freeze,
  ELIGIBILITY_REASON_INELIGIBLE_ACCOUNT_INTERNAL = 'INELIGIBLE_ACCOUNT_INTERNAL'.freeze,
  ELIGIBILITY_REASON_INELIGIBLE_ACCOUNT_GOV_SUBSCRIPTION = 'INELIGIBLE_ACCOUNT_GOV_SUBSCRIPTION'.freeze,
  ELIGIBILITY_REASON_NOT_AUTHORIZED = 'NOT_AUTHORIZED'.freeze,
  ELIGIBILITY_REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ThirdPartyPaidListingEligibility

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 69

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.is_paid_listing_eligible = attributes[:'isPaidListingEligible'] unless attributes[:'isPaidListingEligible'].nil?

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

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

  self.is_paid_listing_throttled = attributes[:'isPaidListingThrottled'] unless attributes[:'isPaidListingThrottled'].nil?

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

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

  self.eligibility_reason = attributes[:'eligibilityReason'] if attributes[:'eligibilityReason']

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

  self.eligibility_reason = attributes[:'eligibility_reason'] if attributes[:'eligibility_reason']
end

Instance Attribute Details

#eligibility_reason ⇒ String

[Required] Reason the account is ineligible to launch paid listings

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 36

def eligibility_reason
  @eligibility_reason
end

#is_paid_listing_eligible ⇒ BOOLEAN

[Required] Whether the tenant is permitted to use paid listings

Returns:

  • (BOOLEAN) 


28
29
30
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 28

def is_paid_listing_eligible
  @is_paid_listing_eligible
end

#is_paid_listing_throttled ⇒ BOOLEAN

[Required] Whether the tenant is currently prevented from using paid listings because of throttling

Returns:

  • (BOOLEAN) 


32
33
34
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 32

def is_paid_listing_throttled
  @is_paid_listing_throttled
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_paid_listing_eligible': :'isPaidListingEligible',
    'is_paid_listing_throttled': :'isPaidListingThrottled',
    'eligibility_reason': :'eligibilityReason'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 50

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_paid_listing_eligible': :'BOOLEAN',
    'is_paid_listing_throttled': :'BOOLEAN',
    'eligibility_reason': :'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



114
115
116
117
118
119
120
121
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 114

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

  self.class == other.class &&
    is_paid_listing_eligible == other.is_paid_listing_eligible &&
    is_paid_listing_throttled == other.is_paid_listing_throttled &&
    eligibility_reason == other.eligibility_reason
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 146

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


126
127
128
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



135
136
137
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 135

def hash
  [is_paid_listing_eligible, is_paid_listing_throttled, eligibility_reason].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 179

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



173
174
175
 
# File 'lib/oci/marketplace/models/third_party_paid_listing_eligibility.rb', line 173

def to_s
  to_hash.to_s
end