Class: OCI::GoldenGate::Models::PolarisIcebergCatalog

Inherits:
IcebergCatalog
  • Object
show all
Defined in:
lib/oci/golden_gate/models/polaris_iceberg_catalog.rb

Overview

Represents a Polaris catalog used in the Iceberg connection.

Constant Summary

Constants inherited from IcebergCatalog

IcebergCatalog::CATALOG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from IcebergCatalog

#catalog_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from IcebergCatalog

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ PolarisIcebergCatalog

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :uri (String) —

    The value to assign to the #uri property

  • :name (String) —

    The value to assign to the #name property

  • :client_id (String) —

    The value to assign to the #client_id property

  • :client_secret_secret_id (String) —

    The value to assign to the #client_secret_secret_id property

  • :principal_role (String) —

    The value to assign to the #principal_role property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 75

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

  attributes['catalogType'] = 'POLARIS'

  super(attributes)

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

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

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

  self.client_id = attributes[:'clientId'] if attributes[:'clientId']

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

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

  self.client_secret_secret_id = attributes[:'clientSecretSecretId'] if attributes[:'clientSecretSecretId']

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

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

  self.principal_role = attributes[:'principalRole'] if attributes[:'principalRole']

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

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

Instance Attribute Details

#client_id ⇒ String

[Required] The OAuth client ID used for authentication.

Returns:

  • (String) 


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

def client_id
  @client_id
end

#client_secret_secret_id ⇒ String

The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 30

def client_secret_secret_id
  @client_secret_secret_id
end

#name ⇒ String

[Required] The catalog name within Polaris where Iceberg tables are registered.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 21

def name
  @name
end

#principal_role ⇒ String

[Required] The Snowflake role used to access Polaris.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 34

def principal_role
  @principal_role
end

#uri ⇒ String

[Required] The URL endpoint for the Polaris API. e.g.: '

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 17

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'catalog_type': :'catalogType',
    'uri': :'uri',
    'name': :'name',
    'client_id': :'clientId',
    'client_secret_secret_id': :'clientSecretSecretId',
    'principal_role': :'principalRole'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'catalog_type': :'String',
    'uri': :'String',
    'name': :'String',
    'client_id': :'String',
    'client_secret_secret_id': :'String',
    'principal_role': :'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



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 115

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

  self.class == other.class &&
    catalog_type == other.catalog_type &&
    uri == other.uri &&
    name == other.name &&
    client_id == other.client_id &&
    client_secret_secret_id == other.client_secret_secret_id &&
    principal_role == other.principal_role
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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 150

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


130
131
132
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 130

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



139
140
141
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 139

def hash
  [catalog_type, uri, name, client_id, client_secret_secret_id, principal_role].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 183

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



177
178
179
 
# File 'lib/oci/golden_gate/models/polaris_iceberg_catalog.rb', line 177

def to_s
  to_hash.to_s
end