Class: OCI::Apigateway::Models::RouteAuthorizationPolicy
- Inherits:
-
Object
- Object
- OCI::Apigateway::Models::RouteAuthorizationPolicy
- Defined in:
- lib/oci/apigateway/models/route_authorization_policy.rb
Overview
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Direct Known Subclasses
AnonymousRouteAuthorizationPolicy, AnyOfRouteAuthorizationPolicy, AuthenticationOnlyRouteAuthorizationPolicy
Constant Summary collapse
- TYPE_ENUM =
[ TYPE_ANONYMOUS = 'ANONYMOUS'.freeze, TYPE_ANY_OF = 'ANY_OF'.freeze, TYPE_AUTHENTICATION_ONLY = 'AUTHENTICATION_ONLY'.freeze, TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#type ⇒ String
Indicates how authorization should be applied.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RouteAuthorizationPolicy
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ RouteAuthorizationPolicy
Initializes the object
72 73 74 75 76 77 78 79 80 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 72 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.type = attributes[:'type'] if attributes[:'type'] self.type = "AUTHENTICATION_ONLY" if type.nil? && !attributes.key?(:'type') # rubocop:disable Style/StringLiterals end |
Instance Attribute Details
#type ⇒ String
Indicates how authorization should be applied. For a type of ANY_OF, an "allowedScope" property must also be specified. Otherwise, only a type is required. For a type of ANONYMOUS, an authenticated API must have the "isAnonymousAccessAllowed" property set to "true" in the authentication policy.
28 29 30 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 28 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
31 32 33 34 35 36 37 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 31 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'type': :'type' # rubocop:enable Style/SymbolLiteral } end |
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
53 54 55 56 57 58 59 60 61 62 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 53 def self.get_subtype(object_hash) type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral return 'OCI::Apigateway::Models::AnyOfRouteAuthorizationPolicy' if type == 'ANY_OF' return 'OCI::Apigateway::Models::AnonymousRouteAuthorizationPolicy' if type == 'ANONYMOUS' return 'OCI::Apigateway::Models::AuthenticationOnlyRouteAuthorizationPolicy' if type == 'AUTHENTICATION_ONLY' # TODO: Log a warning when the subtype is not found. 'OCI::Apigateway::Models::RouteAuthorizationPolicy' end |
.swagger_types ⇒ Object
Attribute type mapping.
40 41 42 43 44 45 46 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 40 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'type': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
102 103 104 105 106 107 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 102 def ==(other) return true if equal?(other) self.class == other.class && type == other.type end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 132 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
112 113 114 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 112 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
121 122 123 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 121 def hash [type].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
165 166 167 168 169 170 171 172 173 174 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 165 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
159 160 161 |
# File 'lib/oci/apigateway/models/route_authorization_policy.rb', line 159 def to_s to_hash.to_s end |