Class: OCI::GoldenGate::Models::CreateOciObjectStorageS3ApiIcebergStorageDetails

Inherits:
CreateIcebergStorageDetails show all
Defined in:
lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb

Overview

The information to create the OCI Object Storage (S3 Compatibility API) configuration used by the Iceberg connection.

Constant Summary

Constants inherited from CreateIcebergStorageDetails

OCI::GoldenGate::Models::CreateIcebergStorageDetails::STORAGE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateIcebergStorageDetails

#storage_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateIcebergStorageDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateOciObjectStorageS3ApiIcebergStorageDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :endpoint (String) —

    The value to assign to the #endpoint property

  • :access_key_id (String) —

    The value to assign to the #access_key_id property

  • :secret_access_key_secret_id (String) —

    The value to assign to the #secret_access_key_secret_id property

  • :secret_access_key (String) —

    The value to assign to the #secret_access_key property

  • :bucket (String) —

    The value to assign to the #bucket property



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 88

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

  attributes['storageType'] = 'OCI_OBJECT_STORAGE_S3_API'

  super(attributes)

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

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

  self.access_key_id = attributes[:'accessKeyId'] if attributes[:'accessKeyId']

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

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

  self.secret_access_key_secret_id = attributes[:'secretAccessKeySecretId'] if attributes[:'secretAccessKeySecretId']

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

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

  self.secret_access_key = attributes[:'secretAccessKey'] if attributes[:'secretAccessKey']

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

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

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

Instance Attribute Details

#access_key_id ⇒ String

[Required] Access Key ID from the OCI IAM user's Customer Secret Key pair used to authenticate to OCI Object Storage via the S3 Compatibility API.

Note: Despite the "Id" suffix, this value is not an OCI OCID.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 27

def access_key_id
  @access_key_id
end

#bucket ⇒ String

[Required] Target OCI Object Storage bucket name where Iceberg stores table metadata and data files.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 47

def bucket
  @bucket
end

#endpoint ⇒ String

[Required] OCI Object Storage S3 Compatibility API endpoint URL. Format: ".compat.objectstorage..>" Example: "mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com"

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 19

def endpoint
  @endpoint
end

#secret_access_key ⇒ String

Secret Access Key from the OCI IAM user's Customer Secret Key pair used to authenticate to OCI Object Storage via the S3 Compatibility API. Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 41

def secret_access_key
  @secret_access_key
end

#secret_access_key_secret_id ⇒ String

The OCID of the Secret where the Secret Access Key used for OCI Object Storage S3 Compatibility authentication.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 32

def secret_access_key_secret_id
  @secret_access_key_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'storage_type': :'storageType',
    'endpoint': :'endpoint',
    'access_key_id': :'accessKeyId',
    'secret_access_key_secret_id': :'secretAccessKeySecretId',
    'secret_access_key': :'secretAccessKey',
    'bucket': :'bucket'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'storage_type': :'String',
    'endpoint': :'String',
    'access_key_id': :'String',
    'secret_access_key_secret_id': :'String',
    'secret_access_key': :'String',
    'bucket': :'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



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 128

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

  self.class == other.class &&
    storage_type == other.storage_type &&
    endpoint == other.endpoint &&
    access_key_id == other.access_key_id &&
    secret_access_key_secret_id == other.secret_access_key_secret_id &&
    secret_access_key == other.secret_access_key &&
    bucket == other.bucket
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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 163

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


143
144
145
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 152

def hash
  [storage_type, endpoint, access_key_id, secret_access_key_secret_id, secret_access_key, bucket].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 196

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



190
191
192
 
# File 'lib/oci/golden_gate/models/create_oci_object_storage_s3_api_iceberg_storage_details.rb', line 190

def to_s
  to_hash.to_s
end