Class: OCI::Apigateway::Models::OAuth2LogoutBackend

Inherits:
ApiSpecificationRouteBackend show all
Defined in:
lib/oci/apigateway/models/o_auth2_logout_backend.rb

Overview

Backend which when called triggers OAuth2 logout.

Constant Summary

Constants inherited from ApiSpecificationRouteBackend

ApiSpecificationRouteBackend::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ApiSpecificationRouteBackend

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiSpecificationRouteBackend

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ OAuth2LogoutBackend

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 51

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'OAUTH2_LOGOUT_BACKEND'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.allowed_post_logout_uris = attributes[:'allowedPostLogoutUris'] if attributes[:'allowedPostLogoutUris']

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

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

  self.post_logout_state = attributes[:'postLogoutState'] if attributes[:'postLogoutState']

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

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

Instance Attribute Details

#allowed_post_logout_uris ⇒ Array<String>

Returns:

  • (Array<String>) 


14
15
16
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 14

def allowed_post_logout_uris
  @allowed_post_logout_uris
end

#post_logout_state ⇒ String

Defines a state that should be shared on redirecting to postLogout URL.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 19

def post_logout_state
  @post_logout_state
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'allowed_post_logout_uris': :'allowedPostLogoutUris',
    'post_logout_state': :'postLogoutState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



81
82
83
84
85
86
87
88
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 81

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

  self.class == other.class &&
    type == other.type &&
    allowed_post_logout_uris == other.allowed_post_logout_uris &&
    post_logout_state == other.post_logout_state
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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 113

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


93
94
95
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 93

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



102
103
104
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 102

def hash
  [type, allowed_post_logout_uris, post_logout_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 146

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



140
141
142
 
# File 'lib/oci/apigateway/models/o_auth2_logout_backend.rb', line 140

def to_s
  to_hash.to_s
end