Class: OCI::IdentityDataPlane::Models::OnBehalfOfRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_data_plane/models/on_behalf_of_request.rb

Overview

OnBehalfOfRequest model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OnBehalfOfRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :request_headers (Hash<String, Array<String>>) —

    The value to assign to the #request_headers property

  • :target_service_name (String) —

    The value to assign to the #target_service_name property

  • :obo_token (String) —

    The value to assign to the #obo_token property

  • :expiration (String) —

    The value to assign to the #expiration property



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 61

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

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

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

  self.target_service_name = attributes[:'targetServiceName'] if attributes[:'targetServiceName']

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

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

  self.obo_token = attributes[:'oboToken'] if attributes[:'oboToken']

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

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

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

Instance Attribute Details

#expiration ⇒ String

A duration for which the obo token is requested to be valid.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 25

def expiration
  @expiration
end

#obo_token ⇒ String

If you have an obo token already, exchange that for a new obo token.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 21

def obo_token
  @obo_token
end

#request_headers ⇒ Hash<String, Array<String>>

[Required] The signed headers of the customer call.

Returns:

  • (Hash<String, Array<String>>) 


13
14
15
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 13

def request_headers
  @request_headers
end

#target_service_name ⇒ String

[Required] The name of the target service.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 17

def target_service_name
  @target_service_name
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'request_headers': :'requestHeaders',
    'target_service_name': :'targetServiceName',
    'obo_token': :'oboToken',
    'expiration': :'expiration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'request_headers': :'Hash<String, Array<String>>',
    'target_service_name': :'String',
    'obo_token': :'String',
    'expiration': :'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



95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 95

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

  self.class == other.class &&
    request_headers == other.request_headers &&
    target_service_name == other.target_service_name &&
    obo_token == other.obo_token &&
    expiration == other.expiration
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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 128

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


108
109
110
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 117

def hash
  [request_headers, target_service_name, obo_token, expiration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 161

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



155
156
157
 
# File 'lib/oci/identity_data_plane/models/on_behalf_of_request.rb', line 155

def to_s
  to_hash.to_s
end