Class: OCI::Apigateway::Models::ApiSpecificationRequestPolicies

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

Overview

Global behavior applied to all requests received by the API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiSpecificationRequestPolicies

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 69

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.authentication = attributes[:'authentication'] if attributes[:'authentication']

  self.rate_limiting = attributes[:'rateLimiting'] if attributes[:'rateLimiting']

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

  self.rate_limiting = attributes[:'rate_limiting'] if attributes[:'rate_limiting']

  self.cors = attributes[:'cors'] if attributes[:'cors']

  self.mutual_tls = attributes[:'mutualTls'] if attributes[:'mutualTls']

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

  self.mutual_tls = attributes[:'mutual_tls'] if attributes[:'mutual_tls']

  self.usage_plans = attributes[:'usagePlans'] if attributes[:'usagePlans']

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

  self.usage_plans = attributes[:'usage_plans'] if attributes[:'usage_plans']

  self.dynamic_authentication = attributes[:'dynamicAuthentication'] if attributes[:'dynamicAuthentication']

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

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

Instance Attribute Details

#authenticationOCI::Apigateway::Models::AuthenticationPolicy



12
13
14
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 12

def authentication
  @authentication
end

#corsOCI::Apigateway::Models::CorsPolicy



18
19
20
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 18

def cors
  @cors
end

#dynamic_authenticationOCI::Apigateway::Models::DynamicAuthenticationPolicy



27
28
29
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 27

def dynamic_authentication
  @dynamic_authentication
end

#mutual_tlsOCI::Apigateway::Models::MutualTlsDetails



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

def mutual_tls
  @mutual_tls
end

#rate_limitingOCI::Apigateway::Models::RateLimitingPolicy



15
16
17
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 15

def rate_limiting
  @rate_limiting
end

#usage_plansOCI::Apigateway::Models::UsagePlansPolicy



24
25
26
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 24

def usage_plans
  @usage_plans
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'authentication': :'authentication',
    'rate_limiting': :'rateLimiting',
    'cors': :'cors',
    'mutual_tls': :'mutualTls',
    'usage_plans': :'usagePlans',
    'dynamic_authentication': :'dynamicAuthentication'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'authentication': :'OCI::Apigateway::Models::AuthenticationPolicy',
    'rate_limiting': :'OCI::Apigateway::Models::RateLimitingPolicy',
    'cors': :'OCI::Apigateway::Models::CorsPolicy',
    'mutual_tls': :'OCI::Apigateway::Models::MutualTlsDetails',
    'usage_plans': :'OCI::Apigateway::Models::UsagePlansPolicy',
    'dynamic_authentication': :'OCI::Apigateway::Models::DynamicAuthenticationPolicy'
    # 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



111
112
113
114
115
116
117
118
119
120
121
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 111

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

  self.class == other.class &&
    authentication == other.authentication &&
    rate_limiting == other.rate_limiting &&
    cors == other.cors &&
    mutual_tls == other.mutual_tls &&
    usage_plans == other.usage_plans &&
    dynamic_authentication == other.dynamic_authentication
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 146

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


126
127
128
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 126

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



135
136
137
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 135

def hash
  [authentication, rate_limiting, cors, mutual_tls, usage_plans, dynamic_authentication].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 179

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



173
174
175
# File 'lib/oci/apigateway/models/api_specification_request_policies.rb', line 173

def to_s
  to_hash.to_s
end