Class: OCI::DatabaseTools::Models::CreateDatabaseToolsIdentityDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_tools/models/create_database_tools_identity_details.rb

Overview

Details for the new Database Tools identity. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_ORACLE_DATABASE_RESOURCE_PRINCIPAL = 'ORACLE_DATABASE_RESOURCE_PRINCIPAL'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDatabaseToolsIdentityDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



106
107
108
109
110
111
112
113
114
115
116
117
118
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
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 106

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

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

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

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

  self.database_tools_connection_id = attributes[:'databaseToolsConnectionId'] if attributes[:'databaseToolsConnectionId']

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

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

  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']

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the Database Tools identity.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 22

def compartment_id
  @compartment_id
end

#database_tools_connection_id ⇒ String

[Required] The OCID of the related Database Tools connection.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 30

def database_tools_connection_id
  @database_tools_connection_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


36
37
38
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 36

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 26

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


42
43
44
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 42

def freeform_tags
  @freeform_tags
end

#locks ⇒ Array<OCI::DatabaseTools::Models::ResourceLock>

Locks associated with this resource.

Returns:



46
47
48
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 46

def locks
  @locks
end

#type ⇒ String

[Required] The Database Tools identity type.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 18

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'database_tools_connection_id': :'databaseToolsConnectionId',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



83
84
85
86
87
88
89
90
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 83

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DatabaseTools::Models::CreateDatabaseToolsIdentityOracleDatabaseResourcePrincipalDetails' if type == 'ORACLE_DATABASE_RESOURCE_PRINCIPAL'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DatabaseTools::Models::CreateDatabaseToolsIdentityDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'database_tools_connection_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>'
    # 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



162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 162

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

  self.class == other.class &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    database_tools_connection_id == other.database_tools_connection_id &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    locks == other.locks
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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 198

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


178
179
180
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 178

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



187
188
189
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 187

def hash
  [type, compartment_id, display_name, database_tools_connection_id, defined_tags, freeform_tags, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 231

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



225
226
227
 
# File 'lib/oci/database_tools/models/create_database_tools_identity_details.rb', line 225

def to_s
  to_hash.to_s
end