Class: OCI::GoldenGate::Models::AmazonS3IcebergStorage

Inherits:
IcebergStorage
  • Object
show all
Defined in:
lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb

Overview

Represents an Amazon S3 storage used in the Iceberg connection.

Constant Summary collapse

SCHEME_TYPE_ENUM = 
[
  SCHEME_TYPE_S3 = 'S3'.freeze,
  SCHEME_TYPE_S3_A = 'S3A'.freeze,
  SCHEME_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from IcebergStorage

IcebergStorage::STORAGE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from IcebergStorage

#storage_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from IcebergStorage

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AmazonS3IcebergStorage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :scheme_type (String) —

    The value to assign to the #scheme_type property

  • :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

  • :region (String) —

    The value to assign to the #region property

  • :bucket (String) —

    The value to assign to the #bucket property



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
120
121
122
123
124
125
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 92

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

  attributes['storageType'] = 'AMAZON_S3'

  super(attributes)

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

  self.scheme_type = attributes[:'schemeType'] if attributes[:'schemeType']

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

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

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

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

Instance Attribute Details

#access_key_id ⇒ String

[Required] Access key ID to access the Amazon S3 bucket.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 33

def access_key_id
  @access_key_id
end

#bucket ⇒ String

[Required] S3 bucket where Iceberg stores metadata and data files.

Returns:

  • (String) 


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

def bucket
  @bucket
end

#endpoint ⇒ String

The endpoint URL of the Amazon S3 storage service. e.g.: 's3.amazonaws.com'

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 28

def endpoint
  @endpoint
end

#region ⇒ String

[Required] The AMAZON region where the S3 bucket is hosted. e.g.: 'us-east-2'

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 44

def region
  @region
end

#scheme_type ⇒ String

[Required] The scheme of the storage.

Returns:

  • (String) 


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

def scheme_type
  @scheme_type
end

#secret_access_key_secret_id ⇒ String

The OCID of the Secret where the Secret Access Key is stored.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 38

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.



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

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

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 66

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



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 147

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

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 183

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


163
164
165
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 163

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 172

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 216

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



210
211
212
 
# File 'lib/oci/golden_gate/models/amazon_s3_iceberg_storage.rb', line 210

def to_s
  to_hash.to_s
end