class OCI::Waas::Models::AccessRuleCriteria
When defined, the parent challenge would be applied only for the requests that matched all the listed conditions.
Constants
- CONDITION_ENUM
Attributes
[Required] The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request.
-
URL_IS: Matches if the concatenation of request URL path and query is identical to the contents of the `value` field. URL must start with a `/`.
-
URL_IS_NOT: Matches if the concatenation of request URL path and query is not identical to the contents of the `value` field. URL must start with a `/`.
-
URL_STARTS_WITH: Matches if the concatenation of request URL path and query starts with the contents of the `value` field. URL must start with a `/`.
-
URL_PART_ENDS_WITH: Matches if the concatenation of request URL path and query ends with the contents of the `value` field.
-
URL_PART_CONTAINS: Matches if the concatenation of request URL path and query contains the contents of the `value` field.
-
URL_REGEX: Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (www.pcre.org).
-
URL_DOES_NOT_MATCH_REGEX: Matches if the concatenation of request URL path and query is not described by the regular expression in the `value` field. The value must be a valid regular expression recognized by the PCRE library in Nginx (www.pcre.org).
-
URL_DOES_NOT_START_WITH: Matches if the concatenation of request URL path and query does not start with the contents of the `value` field.
-
URL_PART_DOES_NOT_CONTAIN: Matches if the concatenation of request URL path and query does not contain the contents of the `value` field.
-
URL_PART_DOES_NOT_END_WITH: Matches if the concatenation of request URL path and query does not end with the contents of the `value` field.
-
IP_IS: Matches if the request originates from one of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \
Example: "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30"
-
IP_IS_NOT: Matches if the request does not originate from any of the IP addresses contained in the defined address list. The `value` in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \
Example: "1.1.1.1\ 1.1.1.2\ 1.2.2.1/30"
-
IP_IN_LIST: Matches if the request originates from one of the IP addresses contained in the referenced address list. The `value` in this case is OCID of the address list.
-
IP_NOT_IN_LIST: Matches if the request does not originate from any IP address contained in the referenced address list. The `value` field in this case is OCID of the address list.
-
HTTP_HEADER_CONTAINS: The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. `host:test.example.com` is an example of a criteria value where `host` is the header field name and `test.example.com` is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match.
Example: With a criteria value of `host:test.example.com`, where `host` is the name of the field and `test.example.com` is the value of the host field, a request with the header values, `Host: www.test.example.com` will match, where as a request with header values of `host: www.example.com` or `host: test.sub.example.com` will not match.
-
HTTP_METHOD_IS: Matches if the request method is identical to one of the values listed in field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \
The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` *Example:* \"GET\
POST"
-
HTTP_METHOD_IS_NOT: Matches if the request is not identical to any of the contents of the `value` field. The `value` in this case is string with one or multiple HTTP methods separated by new line symbol \
The list of available methods: `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` *Example:* \"GET\
POST"
-
COUNTRY_IS: Matches if the request originates from one of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \
Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/).
Example: "AL\ DZ\ AM"
-
COUNTRY_IS_NOT: Matches if the request does not originate from any of countries in the `value` field. The `value` in this case is string with one or multiple countries separated by new line symbol \
Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see [ISO's website](https://www.iso.org/obp/ui/#search/code/).
Example: "AL\ DZ\ AM"
-
USER_AGENT_IS: Matches if the requesting user agent is identical to the contents of the `value` field.
Example: `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0`
-
USER_AGENT_IS_NOT: Matches if the requesting user agent is not identical to the contents of the `value` field.
Example: `Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0` @return [String]
When enabled, the condition will be matched with case-sensitive rules. @return [BOOLEAN]
[Required] The criteria value. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/waas/models/access_rule_criteria.rb, line 99 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'condition': :'condition', 'value': :'value', 'is_case_sensitive': :'isCaseSensitive' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :condition The value to assign to the {#condition} property @option attributes [String] :value The value to assign to the {#value} property @option attributes [BOOLEAN] :is_case_sensitive The value to assign to the {#is_case_sensitive} property
# File lib/oci/waas/models/access_rule_criteria.rb, line 129 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.condition = attributes[:'condition'] if attributes[:'condition'] self.value = attributes[:'value'] if attributes[:'value'] self.is_case_sensitive = attributes[:'isCaseSensitive'] unless attributes[:'isCaseSensitive'].nil? self.is_case_sensitive = false if is_case_sensitive.nil? && !attributes.key?(:'isCaseSensitive') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isCaseSensitive and :is_case_sensitive' if attributes.key?(:'isCaseSensitive') && attributes.key?(:'is_case_sensitive') self.is_case_sensitive = attributes[:'is_case_sensitive'] unless attributes[:'is_case_sensitive'].nil? self.is_case_sensitive = false if is_case_sensitive.nil? && !attributes.key?(:'isCaseSensitive') && !attributes.key?(:'is_case_sensitive') # rubocop:disable Style/StringLiterals end
Attribute type mapping.
# File lib/oci/waas/models/access_rule_criteria.rb, line 110 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'condition': :'String', 'value': :'String', 'is_case_sensitive': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/waas/models/access_rule_criteria.rb, line 168 def ==(other) return true if equal?(other) self.class == other.class && condition == other.condition && value == other.value && is_case_sensitive == other.is_case_sensitive end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/waas/models/access_rule_criteria.rb, line 200 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
Custom attribute writer method checking allowed values (enum). @param [Object] condition Object
to be assigned
# File lib/oci/waas/models/access_rule_criteria.rb, line 152 def condition=(condition) # rubocop:disable Style/ConditionalAssignment if condition && !CONDITION_ENUM.include?(condition) OCI.logger.debug("Unknown value for 'condition' [" + condition + "]. Mapping to 'CONDITION_UNKNOWN_ENUM_VALUE'") if OCI.logger @condition = CONDITION_UNKNOWN_ENUM_VALUE else @condition = condition end # rubocop:enable Style/ConditionalAssignment end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/waas/models/access_rule_criteria.rb, line 180 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/waas/models/access_rule_criteria.rb, line 189 def hash [condition, value, is_case_sensitive].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/waas/models/access_rule_criteria.rb, line 233 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/waas/models/access_rule_criteria.rb, line 227 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/waas/models/access_rule_criteria.rb, line 250 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end