class OCI::Apigateway::Models::ApiSpecificationRoute
A single route that forwards requests to a particular backend and may contain some additional policies.
Constants
- METHODS_ENUM
Attributes
This attribute is required. @return [OCI::Apigateway::Models::ApiSpecificationRouteBackend]
@return [OCI::Apigateway::Models::ApiSpecificationLoggingPolicies]
A list of allowed methods on this route.
@return [Array<String>]
[Required] A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
@return [String]
@return [OCI::Apigateway::Models::ApiSpecificationRouteRequestPolicies]
@return [OCI::Apigateway::Models::ApiSpecificationRouteResponsePolicies]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/apigateway/models/api_specification_route.rb, line 49 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'path': :'path', 'methods': :'methods', 'request_policies': :'requestPolicies', 'response_policies': :'responsePolicies', 'logging_policies': :'loggingPolicies', 'backend': :'backend' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :path The value to assign to the {#path} property @option attributes [Array<String>] :methods The value to assign to the {#methods} property @option attributes [OCI::Apigateway::Models::ApiSpecificationRouteRequestPolicies] :request_policies The value to assign to the {#request_policies} property @option attributes [OCI::Apigateway::Models::ApiSpecificationRouteResponsePolicies] :response_policies The value to assign to the {#response_policies} property @option attributes [OCI::Apigateway::Models::ApiSpecificationLoggingPolicies] :logging_policies The value to assign to the {#logging_policies} property @option attributes [OCI::Apigateway::Models::ApiSpecificationRouteBackend] :backend The value to assign to the {#backend} property
# File lib/oci/apigateway/models/api_specification_route.rb, line 88 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.path = attributes[:'path'] if attributes[:'path'] self.methods = attributes[:'methods'] if attributes[:'methods'] self.request_policies = attributes[:'requestPolicies'] if attributes[:'requestPolicies'] raise 'You cannot provide both :requestPolicies and :request_policies' if attributes.key?(:'requestPolicies') && attributes.key?(:'request_policies') self.request_policies = attributes[:'request_policies'] if attributes[:'request_policies'] self.response_policies = attributes[:'responsePolicies'] if attributes[:'responsePolicies'] raise 'You cannot provide both :responsePolicies and :response_policies' if attributes.key?(:'responsePolicies') && attributes.key?(:'response_policies') self.response_policies = attributes[:'response_policies'] if attributes[:'response_policies'] self.logging_policies = attributes[:'loggingPolicies'] if attributes[:'loggingPolicies'] raise 'You cannot provide both :loggingPolicies and :logging_policies' if attributes.key?(:'loggingPolicies') && attributes.key?(:'logging_policies') self.logging_policies = attributes[:'logging_policies'] if attributes[:'logging_policies'] self.backend = attributes[:'backend'] if attributes[:'backend'] end
Attribute type mapping.
# File lib/oci/apigateway/models/api_specification_route.rb, line 63 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'path': :'String', 'methods': :'Array<String>', 'request_policies': :'OCI::Apigateway::Models::ApiSpecificationRouteRequestPolicies', 'response_policies': :'OCI::Apigateway::Models::ApiSpecificationRouteResponsePolicies', 'logging_policies': :'OCI::Apigateway::Models::ApiSpecificationLoggingPolicies', 'backend': :'OCI::Apigateway::Models::ApiSpecificationRouteBackend' # 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/apigateway/models/api_specification_route.rb, line 146 def ==(other) return true if equal?(other) self.class == other.class && path == other.path && methods == other.methods && request_policies == other.request_policies && response_policies == other.response_policies && logging_policies == other.logging_policies && backend == other.backend 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/apigateway/models/api_specification_route.rb, line 181 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/apigateway/models/api_specification_route.rb, line 161 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/apigateway/models/api_specification_route.rb, line 170 def hash [path, methods, request_policies, response_policies, logging_policies, backend].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] methods Object
to be assigned
# File lib/oci/apigateway/models/api_specification_route.rb, line 123 def methods=(methods) # rubocop:disable Style/ConditionalAssignment if methods.nil? @methods = nil else @methods = methods.collect do |item| if METHODS_ENUM.include?(item) item else OCI.logger.debug("Unknown value for 'methods' [#{item}]. Mapping to 'METHODS_UNKNOWN_ENUM_VALUE'") if OCI.logger METHODS_UNKNOWN_ENUM_VALUE end end end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/apigateway/models/api_specification_route.rb, line 214 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/apigateway/models/api_specification_route.rb, line 208 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/apigateway/models/api_specification_route.rb, line 231 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