Class: OCI::DataSafe::Models::CreateTargetDatabaseDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/create_target_database_details.rb

Overview

The details used to register the database in Data Safe and to create the Data Safe target database.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTargetDatabaseDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



105
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 105

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

  self.database_details = attributes[:'databaseDetails'] if attributes[:'databaseDetails']

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

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

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

  self.tls_config = attributes[:'tlsConfig'] if attributes[:'tlsConfig']

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

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

  self.connection_option = attributes[:'connectionOption'] if attributes[:'connectionOption']

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

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

  self.peer_target_database_details = attributes[:'peerTargetDatabaseDetails'] if attributes[:'peerTargetDatabaseDetails']

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

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

  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

#compartment_id ⇒ String

[Required] The OCID of the compartment in which to create the Data Safe target database.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 13

def compartment_id
  @compartment_id
end

#connection_option ⇒ OCI::DataSafe::Models::ConnectionOption

Returns:



34
35
36
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 34

def connection_option
  @connection_option
end

#credentials ⇒ OCI::DataSafe::Models::Credentials

Returns:



28
29
30
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 28

def credentials
  @credentials
end

#database_details ⇒ OCI::DataSafe::Models::DatabaseDetails

This attribute is required.

Returns:



25
26
27
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 25

def database_details
  @database_details
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>>) 


51
52
53
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 51

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the target database in Data Safe.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 21

def description
  @description
end

#display_name ⇒ String

The display name of the target database in Data Safe. The name is modifiable and does not need to be unique.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 17

def display_name
  @display_name
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>) 


45
46
47
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 45

def freeform_tags
  @freeform_tags
end

#peer_target_database_details ⇒ Array<OCI::DataSafe::Models::CreatePeerTargetDatabaseDetails>

The details of the database to be registered as a peer target database.

Returns:



38
39
40
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 38

def peer_target_database_details
  @peer_target_database_details
end

#tls_config ⇒ OCI::DataSafe::Models::TlsConfig

Returns:



31
32
33
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 31

def tls_config
  @tls_config
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 54

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'database_details': :'databaseDetails',
    'credentials': :'credentials',
    'tls_config': :'tlsConfig',
    'connection_option': :'connectionOption',
    'peer_target_database_details': :'peerTargetDatabaseDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'database_details': :'OCI::DataSafe::Models::DatabaseDetails',
    'credentials': :'OCI::DataSafe::Models::Credentials',
    'tls_config': :'OCI::DataSafe::Models::TlsConfig',
    'connection_option': :'OCI::DataSafe::Models::ConnectionOption',
    'peer_target_database_details': :'Array<OCI::DataSafe::Models::CreatePeerTargetDatabaseDetails>',
    '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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 171

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    database_details == other.database_details &&
    credentials == other.credentials &&
    tls_config == other.tls_config &&
    connection_option == other.connection_option &&
    peer_target_database_details == other.peer_target_database_details &&
    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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 210

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


190
191
192
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 190

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 199

def hash
  [compartment_id, display_name, description, database_details, credentials, tls_config, connection_option, peer_target_database_details, 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



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 243

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



237
238
239
 
# File 'lib/oci/data_safe/models/create_target_database_details.rb', line 237

def to_s
  to_hash.to_s
end