Class: OCI::Apigateway::Models::CustomClientAppDetails

Inherits:
ClientAppDetails show all
Defined in:
lib/oci/apigateway/models/custom_client_app_details.rb

Overview

Client App Credentials to be provided again.

Constant Summary

Constants inherited from ClientAppDetails

OCI::Apigateway::Models::ClientAppDetails::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ClientAppDetails

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ClientAppDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CustomClientAppDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



59
60
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/apigateway/models/custom_client_app_details.rb', line 59

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

  attributes['type'] = 'CUSTOM'

  super(attributes)

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

  self.client_id = attributes[:'clientId'] if attributes[:'clientId']

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

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

  self.client_secret_id = attributes[:'clientSecretId'] if attributes[:'clientSecretId']

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

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

  self.client_secret_version_number = attributes[:'clientSecretVersionNumber'] if attributes[:'clientSecretVersionNumber']

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

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

Instance Attribute Details

#client_idString

[Required] Client ID for the OAuth2/OIDC app.

Returns:

  • (String)


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

def client_id
  @client_id
end

#client_secret_idString

[Required] The OCID of the Oracle Vault Service secret resource.

Returns:

  • (String)


20
21
22
# File 'lib/oci/apigateway/models/custom_client_app_details.rb', line 20

def client_secret_id
  @client_secret_id
end

#client_secret_version_numberInteger

[Required] The version number of the client secret to use.

Returns:

  • (Integer)


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

def client_secret_version_number
  @client_secret_version_number
end

Class Method Details

.attribute_mapObject

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



27
28
29
30
31
32
33
34
35
36
# File 'lib/oci/apigateway/models/custom_client_app_details.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'client_id': :'clientId',
    'client_secret_id': :'clientSecretId',
    'client_secret_version_number': :'clientSecretVersionNumber'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
# File 'lib/oci/apigateway/models/custom_client_app_details.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'client_id': :'String',
    'client_secret_id': :'String',
    'client_secret_version_number': :'Integer'
    # 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/apigateway/models/custom_client_app_details.rb', line 95

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

  self.class == other.class &&
    type == other.type &&
    client_id == other.client_id &&
    client_secret_id == other.client_secret_id &&
    client_secret_version_number == other.client_secret_version_number
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/apigateway/models/custom_client_app_details.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/apigateway/models/custom_client_app_details.rb', line 108

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



117
118
119
# File 'lib/oci/apigateway/models/custom_client_app_details.rb', line 117

def hash
  [type, client_id, client_secret_id, client_secret_version_number].hash
end

#to_hashHash

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/apigateway/models/custom_client_app_details.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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



155
156
157
# File 'lib/oci/apigateway/models/custom_client_app_details.rb', line 155

def to_s
  to_hash.to_s
end