Class: OCI::DatabaseManagement::Models::CreateNamedCredentialDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/create_named_credential_details.rb

Overview

The details required to create a named credential.

Constant Summary collapse

SCOPE_ENUM = 
[
  SCOPE_RESOURCE = 'RESOURCE'.freeze,
  SCOPE_GLOBAL = 'GLOBAL'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_ORACLE_DB = 'ORACLE_DB'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateNamedCredentialDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 119

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

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

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.associated_resource = attributes[:'associatedResource'] if attributes[:'associatedResource']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#associated_resource ⇒ String

The OCID of the resource that is associated to the named credential.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 54

def associated_resource
  @associated_resource
end

#compartment_id ⇒ String

[Required] The OCID of the compartment in which the named credential resides.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 48

def compartment_id
  @compartment_id
end

#content ⇒ OCI::DatabaseManagement::Models::NamedCredentialContent

This attribute is required.

Returns:



42
43
44
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 42

def content
  @content
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


68
69
70
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 68

def defined_tags
  @defined_tags
end

#description ⇒ String

The information specified by the user about the named credential.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 30

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


61
62
63
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 61

def freeform_tags
  @freeform_tags
end

#name ⇒ String

[Required] The name of the named credential. Valid characters are uppercase or lowercase letters, numbers, and "_". The name of the named credential cannot be modified. It must be unique in the compartment and must begin with an alphabetic character.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 26

def name
  @name
end

#scope ⇒ String

[Required] The scope of the named credential.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 34

def scope
  @scope
end

#type ⇒ String

[Required] The type of resource associated with the named credential.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 38

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 71

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'scope': :'scope',
    'type': :'type',
    'content': :'content',
    'compartment_id': :'compartmentId',
    'associated_resource': :'associatedResource',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'scope': :'String',
    'type': :'String',
    'content': :'OCI::DatabaseManagement::Models::NamedCredentialContent',
    'compartment_id': :'String',
    'associated_resource': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 183

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    scope == other.scope &&
    type == other.type &&
    content == other.content &&
    compartment_id == other.compartment_id &&
    associated_resource == other.associated_resource &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 221

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


201
202
203
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 201

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 210

def hash
  [name, description, scope, type, content, compartment_id, associated_resource, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 254

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



248
249
250
 
# File 'lib/oci/database_management/models/create_named_credential_details.rb', line 248

def to_s
  to_hash.to_s
end