Class: OCI::Apigateway::Models::UsagePlansPolicy

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

Overview

Usage plan policies for this deployment

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UsagePlansPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :token_locations (Array<String>) —

    The value to assign to the #token_locations property



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

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

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

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

Instance Attribute Details

#token_locations ⇒ Array<String>

[Required] A list of context variables specifying where API tokens may be located in a request. Example locations: - "request.headers" - "request.query" - "request.auth" - "request.path"

Returns:

  • (Array<String>) 


19
20
21
 
# File 'lib/oci/apigateway/models/usage_plans_policy.rb', line 19

def token_locations
  @token_locations
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
 
# File 'lib/oci/apigateway/models/usage_plans_policy.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'token_locations': :'tokenLocations'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



31
32
33
34
35
36
37
 
# File 'lib/oci/apigateway/models/usage_plans_policy.rb', line 31

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'token_locations': :'Array<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



66
67
68
69
70
71
 
# File 'lib/oci/apigateway/models/usage_plans_policy.rb', line 66

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

  self.class == other.class &&
    token_locations == other.token_locations
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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/apigateway/models/usage_plans_policy.rb', line 96

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


76
77
78
 
# File 'lib/oci/apigateway/models/usage_plans_policy.rb', line 76

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



85
86
87
 
# File 'lib/oci/apigateway/models/usage_plans_policy.rb', line 85

def hash
  [token_locations].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/apigateway/models/usage_plans_policy.rb', line 129

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



123
124
125
 
# File 'lib/oci/apigateway/models/usage_plans_policy.rb', line 123

def to_s
  to_hash.to_s
end