Class: OCI::Apigateway::Models::AnyOfRouteAuthorizationPolicy

Inherits:
RouteAuthorizationPolicy show all
Defined in:
lib/oci/apigateway/models/any_of_route_authorization_policy.rb

Overview

If authentication has been performed, validate whether the request scope (if any) applies to this route.

Constant Summary

Constants inherited from RouteAuthorizationPolicy

RouteAuthorizationPolicy::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from RouteAuthorizationPolicy

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RouteAuthorizationPolicy

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AnyOfRouteAuthorizationPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :allowed_scope (Array<String>)

    The value to assign to the #allowed_scope property



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

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

  attributes['type'] = 'ANY_OF'

  super(attributes)

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

  self.allowed_scope = attributes[:'allowedScope'] if attributes[:'allowedScope']

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

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

Instance Attribute Details

#allowed_scopeArray<String>

[Required] A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

Returns:

  • (Array<String>)


16
17
18
# File 'lib/oci/apigateway/models/any_of_route_authorization_policy.rb', line 16

def allowed_scope
  @allowed_scope
end

Class Method Details

.attribute_mapObject

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



19
20
21
22
23
24
25
26
# File 'lib/oci/apigateway/models/any_of_route_authorization_policy.rb', line 19

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'allowed_scope': :'allowedScope'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



29
30
31
32
33
34
35
36
# File 'lib/oci/apigateway/models/any_of_route_authorization_policy.rb', line 29

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'allowed_scope': :'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



69
70
71
72
73
74
75
# File 'lib/oci/apigateway/models/any_of_route_authorization_policy.rb', line 69

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

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/oci/apigateway/models/any_of_route_authorization_policy.rb', line 100

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


80
81
82
# File 'lib/oci/apigateway/models/any_of_route_authorization_policy.rb', line 80

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



89
90
91
# File 'lib/oci/apigateway/models/any_of_route_authorization_policy.rb', line 89

def hash
  [type, allowed_scope].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



133
134
135
136
137
138
139
140
141
142
# File 'lib/oci/apigateway/models/any_of_route_authorization_policy.rb', line 133

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



127
128
129
# File 'lib/oci/apigateway/models/any_of_route_authorization_policy.rb', line 127

def to_s
  to_hash.to_s
end