Class: OCI::Apigateway::Models::DynamicSelectionKey

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apigateway/models/dynamic_selection_key.rb

Overview

Base policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating requests. 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

AnyOfSelectionKey, WildcardSelectionKey

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_ANY_OF = 'ANY_OF'.freeze,
  TYPE_WILDCARD = 'WILDCARD'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DynamicSelectionKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :is_default (BOOLEAN) —

    The value to assign to the #is_default property

  • :name (String) —

    The value to assign to the #name property



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 78

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 = "ANY_OF" if type.nil? && !attributes.key?(:'type') # rubocop:disable Style/StringLiterals

  self.is_default = attributes[:'isDefault'] unless attributes[:'isDefault'].nil?
  self.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') # rubocop:disable Style/StringLiterals

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

  self.is_default = attributes[:'is_default'] unless attributes[:'is_default'].nil?
  self.is_default = false if is_default.nil? && !attributes.key?(:'isDefault') && !attributes.key?(:'is_default') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#is_default ⇒ BOOLEAN

Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests.

Returns:

  • (BOOLEAN) 


25
26
27
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 25

def is_default
  @is_default
end

#name ⇒ String

[Required] Name assigned to the branch.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 29

def name
  @name
end

#type ⇒ String

Type of the selection key.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 21

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'is_default': :'isDefault',
    'name': :'name'
    # 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.



58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 58

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Apigateway::Models::WildcardSelectionKey' if type == 'WILDCARD'
  return 'OCI::Apigateway::Models::AnyOfSelectionKey' if type == 'ANY_OF'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Apigateway::Models::DynamicSelectionKey'
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 43

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



118
119
120
121
122
123
124
125
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 118

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

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 150

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


130
131
132
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 130

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



139
140
141
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 139

def hash
  [type, is_default, name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 183

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

Returns:

  • (String) —

    String presentation of the object



177
178
179
 
# File 'lib/oci/apigateway/models/dynamic_selection_key.rb', line 177

def to_s
  to_hash.to_s
end