Class: OCI::GoldenGate::Models::UpdateOciObjectStorageConnectionDetails

Inherits:
UpdateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb

Overview

The information to update a OCI Object Storage Connection.

Constant Summary

Constants inherited from UpdateConnectionDetails

OCI::GoldenGate::Models::UpdateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::UpdateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConnectionDetails

#connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #key_id, #nsg_ids, #routing_method, #subnet_id, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateOciObjectStorageConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :vault_id (String) —

    The value to assign to the #vault_id proprety

  • :key_id (String) —

    The value to assign to the #key_id proprety

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids proprety

  • :subnet_id (String) —

    The value to assign to the #subnet_id proprety

  • :routing_method (String) —

    The value to assign to the #routing_method proprety

  • :does_use_secret_ids (BOOLEAN) —

    The value to assign to the #does_use_secret_ids proprety

  • :tenancy_id (String) —

    The value to assign to the #tenancy_id property

  • :region (String) —

    The value to assign to the #region property

  • :user_id (String) —

    The value to assign to the #user_id property

  • :private_key_file (String) —

    The value to assign to the #private_key_file property

  • :private_key_file_secret_id (String) —

    The value to assign to the #private_key_file_secret_id property

  • :private_key_passphrase (String) —

    The value to assign to the #private_key_passphrase property

  • :private_key_passphrase_secret_id (String) —

    The value to assign to the #private_key_passphrase_secret_id property

  • :public_key_fingerprint (String) —

    The value to assign to the #public_key_fingerprint property

  • :should_use_resource_principal (BOOLEAN) —

    The value to assign to the #should_use_resource_principal property



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 149

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

  attributes['connectionType'] = 'OCI_OBJECT_STORAGE'

  super(attributes)

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

  self.tenancy_id = attributes[:'tenancyId'] if attributes[:'tenancyId']

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

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

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

  self.user_id = attributes[:'userId'] if attributes[:'userId']

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

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

  self.private_key_file = attributes[:'privateKeyFile'] if attributes[:'privateKeyFile']

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

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

  self.private_key_file_secret_id = attributes[:'privateKeyFileSecretId'] if attributes[:'privateKeyFileSecretId']

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

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

  self.private_key_passphrase = attributes[:'privateKeyPassphrase'] if attributes[:'privateKeyPassphrase']

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

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

  self.private_key_passphrase_secret_id = attributes[:'privateKeyPassphraseSecretId'] if attributes[:'privateKeyPassphraseSecretId']

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

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

  self.public_key_fingerprint = attributes[:'publicKeyFingerprint'] if attributes[:'publicKeyFingerprint']

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

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

  self.should_use_resource_principal = attributes[:'shouldUseResourcePrincipal'] unless attributes[:'shouldUseResourcePrincipal'].nil?

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

  self.should_use_resource_principal = attributes[:'should_use_resource_principal'] unless attributes[:'should_use_resource_principal'].nil?
end

Instance Attribute Details

#private_key_file ⇒ String

The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 36

def private_key_file
  @private_key_file
end

#private_key_file_secret_id ⇒ String

The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 43

def private_key_file_secret_id
  @private_key_file_secret_id
end

#private_key_passphrase ⇒ String

The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 49

def private_key_passphrase
  @private_key_passphrase
end

#private_key_passphrase_secret_id ⇒ String

The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 55

def private_key_passphrase_secret_id
  @private_key_passphrase_secret_id
end

#public_key_fingerprint ⇒ String

The fingerprint of the API Key of the user specified by the userId. See documentation: docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 61

def public_key_fingerprint
  @public_key_fingerprint
end

#region ⇒ String

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 22

def region
  @region
end

#should_use_resource_principal ⇒ BOOLEAN

Indicates that the user intents to connect to the instance through resource principal.

Returns:

  • (BOOLEAN) 


66
67
68
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 66

def should_use_resource_principal
  @should_use_resource_principal
end

#tenancy_id ⇒ String

The OCID of the related OCI tenancy.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 16

def tenancy_id
  @tenancy_id
end

#user_id ⇒ String

The OCID of the OCI user who will access the Object Storage. The user must have write access to the bucket they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 29

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'tenancy_id': :'tenancyId',
    'region': :'region',
    'user_id': :'userId',
    'private_key_file': :'privateKeyFile',
    'private_key_file_secret_id': :'privateKeyFileSecretId',
    'private_key_passphrase': :'privateKeyPassphrase',
    'private_key_passphrase_secret_id': :'privateKeyPassphraseSecretId',
    'public_key_fingerprint': :'publicKeyFingerprint',
    'should_use_resource_principal': :'shouldUseResourcePrincipal'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'vault_id': :'String',
    'key_id': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'tenancy_id': :'String',
    'region': :'String',
    'user_id': :'String',
    'private_key_file': :'String',
    'private_key_file_secret_id': :'String',
    'private_key_passphrase': :'String',
    'private_key_passphrase_secret_id': :'String',
    'public_key_fingerprint': :'String',
    'should_use_resource_principal': :'BOOLEAN'
    # 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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 217

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    tenancy_id == other.tenancy_id &&
    region == other.region &&
    user_id == other.user_id &&
    private_key_file == other.private_key_file &&
    private_key_file_secret_id == other.private_key_file_secret_id &&
    private_key_passphrase == other.private_key_passphrase &&
    private_key_passphrase_secret_id == other.private_key_passphrase_secret_id &&
    public_key_fingerprint == other.public_key_fingerprint &&
    should_use_resource_principal == other.should_use_resource_principal
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 266

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


246
247
248
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 255

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, does_use_secret_ids, tenancy_id, region, user_id, private_key_file, private_key_file_secret_id, private_key_passphrase, private_key_passphrase_secret_id, public_key_fingerprint, should_use_resource_principal].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 299

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



293
294
295
 
# File 'lib/oci/golden_gate/models/update_oci_object_storage_connection_details.rb', line 293

def to_s
  to_hash.to_s
end