Class: OCI::GoldenGate::Models::CreateOciObjectStorageConnectionDetails

Inherits:
CreateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb

Overview

The information about a new OCI Object Storage Connection.

Constant Summary

Constants inherited from CreateConnectionDetails

OCI::GoldenGate::Models::CreateConnectionDetails::CONNECTION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateConnectionDetails

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #freeform_tags, #key_id, #nsg_ids, #subnet_id, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateOciObjectStorageConnectionDetails

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id 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

  • :technology_type (String) —

    The value to assign to the #technology_type property

  • :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_passphrase (String) —

    The value to assign to the #private_key_passphrase property

  • :public_key_fingerprint (String) —

    The value to assign to the #public_key_fingerprint property



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
163
164
165
166
167
168
169
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 122

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

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

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

  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_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.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']
end

Instance Attribute Details

#private_key_file ⇒ String

[Required] 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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 37

def private_key_file
  @private_key_file
end

#private_key_passphrase ⇒ String

The passphrase of the private key.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 42

def private_key_passphrase
  @private_key_passphrase
end

#public_key_fingerprint ⇒ String

[Required] 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) 


48
49
50
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 48

def public_key_fingerprint
  @public_key_fingerprint
end

#region ⇒ String

The name of the region. e.g.: us-ashburn-1

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 25

def region
  @region
end

#technology_type ⇒ String

[Required] The OCI Object Storage technology type.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 15

def technology_type
  @technology_type
end

#tenancy_id ⇒ String

The OCID of the related OCI tenancy.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 20

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.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 31

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'technology_type': :'technologyType',
    'tenancy_id': :'tenancyId',
    'region': :'region',
    'user_id': :'userId',
    'private_key_file': :'privateKeyFile',
    'private_key_passphrase': :'privateKeyPassphrase',
    'public_key_fingerprint': :'publicKeyFingerprint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'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',
    'technology_type': :'String',
    'tenancy_id': :'String',
    'region': :'String',
    'user_id': :'String',
    'private_key_file': :'String',
    'private_key_passphrase': :'String',
    'public_key_fingerprint': :'String'
    # 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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 178

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    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 &&
    technology_type == other.technology_type &&
    tenancy_id == other.tenancy_id &&
    region == other.region &&
    user_id == other.user_id &&
    private_key_file == other.private_key_file &&
    private_key_passphrase == other.private_key_passphrase &&
    public_key_fingerprint == other.public_key_fingerprint
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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 224

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


204
205
206
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 204

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 213

def hash
  [connection_type, display_name, description, compartment_id, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, technology_type, tenancy_id, region, user_id, private_key_file, private_key_passphrase, public_key_fingerprint].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



257
258
259
260
261
262
263
264
265
266
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 257

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



251
252
253
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_connection_details.rb', line 251

def to_s
  to_hash.to_s
end