class OCI::Apigateway::Models::SetQueryParameterPolicyItem
Set will add a new query parameter if it was not in the original request. If the parameter already exists on the request, you can choose to override, append, or skip it.
Constants
- IF_EXISTS_ENUM
Attributes
If a query parameter with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
@return [String]
[Required] The case-sensitive name of the query parameter. This name must be unique across transformation policies.
@return [String]
[Required] A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
@return [Array<String>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/apigateway/models/set_query_parameter_policy_item.rb, line 38 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'values': :'values', 'if_exists': :'ifExists' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {#name} property @option attributes [Array<String>] :values The value to assign to the {#values} property @option attributes [String] :if_exists The value to assign to the {#if_exists} property
# File lib/oci/apigateway/models/set_query_parameter_policy_item.rb, line 68 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.name = attributes[:'name'] if attributes[:'name'] self.values = attributes[:'values'] if attributes[:'values'] self.if_exists = attributes[:'ifExists'] if attributes[:'ifExists'] self.if_exists = "OVERWRITE" if if_exists.nil? && !attributes.key?(:'ifExists') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :ifExists and :if_exists' if attributes.key?(:'ifExists') && attributes.key?(:'if_exists') self.if_exists = attributes[:'if_exists'] if attributes[:'if_exists'] self.if_exists = "OVERWRITE" if if_exists.nil? && !attributes.key?(:'ifExists') && !attributes.key?(:'if_exists') # rubocop:disable Style/StringLiterals end
Attribute type mapping.
# File lib/oci/apigateway/models/set_query_parameter_policy_item.rb, line 49 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'values': :'Array<String>', 'if_exists': :'String' # 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/set_query_parameter_policy_item.rb, line 107 def ==(other) return true if equal?(other) self.class == other.class && name == other.name && values == other.values && if_exists == other.if_exists 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/set_query_parameter_policy_item.rb, line 139 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/set_query_parameter_policy_item.rb, line 119 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/apigateway/models/set_query_parameter_policy_item.rb, line 128 def hash [name, values, if_exists].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] if_exists
Object
to be assigned
# File lib/oci/apigateway/models/set_query_parameter_policy_item.rb, line 91 def if_exists=(if_exists) # rubocop:disable Style/ConditionalAssignment if if_exists && !IF_EXISTS_ENUM.include?(if_exists) OCI.logger.debug("Unknown value for 'if_exists' [" + if_exists + "]. Mapping to 'IF_EXISTS_UNKNOWN_ENUM_VALUE'") if OCI.logger @if_exists = IF_EXISTS_UNKNOWN_ENUM_VALUE else @if_exists = if_exists 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/set_query_parameter_policy_item.rb, line 172 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/set_query_parameter_policy_item.rb, line 166 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/set_query_parameter_policy_item.rb, line 189 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