Class: OCI::Apigateway::Models::Entitlement

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apigateway/models/entitlement.rb

Overview

A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Entitlement

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 71

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

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

  self.rate_limit = attributes[:'rateLimit'] if attributes[:'rateLimit']

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

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

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

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

Instance Attribute Details

#description ⇒ String

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 21

def description
  @description
end

#name ⇒ String

[Required] An entitlement name, unique within a usage plan.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 15

def name
  @name
end

#quota ⇒ OCI::Apigateway::Models::Quota

Returns:



27
28
29
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 27

def quota
  @quota
end

#rate_limit ⇒ OCI::Apigateway::Models::RateLimit

Returns:



24
25
26
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 24

def rate_limit
  @rate_limit
end

#targets ⇒ Array<OCI::Apigateway::Models::EntitlementTarget>

A collection of targeted deployments that the entitlement will be applied to.

Returns:



32
33
34
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 32

def targets
  @targets
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'rate_limit': :'rateLimit',
    'quota': :'quota',
    'targets': :'targets'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'rate_limit': :'OCI::Apigateway::Models::RateLimit',
    'quota': :'OCI::Apigateway::Models::Quota',
    'targets': :'Array<OCI::Apigateway::Models::EntitlementTarget>'
    # 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



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 99

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    rate_limit == other.rate_limit &&
    quota == other.quota &&
    targets == other.targets
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



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

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


113
114
115
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



122
123
124
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 122

def hash
  [name, description, rate_limit, quota, targets].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 166

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



160
161
162
 
# File 'lib/oci/apigateway/models/entitlement.rb', line 160

def to_s
  to_hash.to_s
end