Class: OCI::LogAnalytics::Models::EndpointCredentials

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/endpoint_credentials.rb

Overview

An object containing credential details to authenticate/authorize a REST request.

Constant Summary collapse

CREDENTIAL_TYPE_ENUM = 
[
  CREDENTIAL_TYPE_NONE = 'NONE'.freeze,
  CREDENTIAL_TYPE_BASIC_AUTH = 'BASIC_AUTH'.freeze,
  CREDENTIAL_TYPE_STATIC_TOKEN = 'STATIC_TOKEN'.freeze,
  CREDENTIAL_TYPE_DYNAMIC_TOKEN = 'DYNAMIC_TOKEN'.freeze,
  CREDENTIAL_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 = {}) ⇒ EndpointCredentials

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 65

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.credential_type = attributes[:'credentialType'] if attributes[:'credentialType']
  self.credential_type = "NONE" if credential_type.nil? && !attributes.key?(:'credentialType') # rubocop:disable Style/StringLiterals

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

  self.credential_type = attributes[:'credential_type'] if attributes[:'credential_type']
  self.credential_type = "NONE" if credential_type.nil? && !attributes.key?(:'credentialType') && !attributes.key?(:'credential_type') # rubocop:disable Style/StringLiterals

  self.credential_name = attributes[:'credentialName'] if attributes[:'credentialName']

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

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

  self.credential_endpoint = attributes[:'credentialEndpoint'] if attributes[:'credentialEndpoint']

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

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

Instance Attribute Details

#credential_endpoint ⇒ OCI::LogAnalytics::Models::CredentialEndpoint

Returns:



32
33
34
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 32

def credential_endpoint
  @credential_endpoint
end

#credential_name ⇒ String

The named credential name on the management agent.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 29

def credential_name
  @credential_name
end

#credential_type ⇒ String

The credential type. NONE indicates credentials are not needed to access the endpoint. BASIC_AUTH represents a username and password based model. TOKEN could be static or dynamic. In case of dynamic tokens, also specify the endpoint from which the token must be fetched.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 25

def credential_type
  @credential_type
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_type': :'credentialType',
    'credential_name': :'credentialName',
    'credential_endpoint': :'credentialEndpoint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'credential_type': :'String',
    'credential_name': :'String',
    'credential_endpoint': :'OCI::LogAnalytics::Models::CredentialEndpoint'
    # 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



112
113
114
115
116
117
118
119
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 112

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

  self.class == other.class &&
    credential_type == other.credential_type &&
    credential_name == other.credential_name &&
    credential_endpoint == other.credential_endpoint
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



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

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


124
125
126
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 133

def hash
  [credential_type, credential_name, credential_endpoint].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 177

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



171
172
173
 
# File 'lib/oci/log_analytics/models/endpoint_credentials.rb', line 171

def to_s
  to_hash.to_s
end