Class: Svix::RedshiftConfigIn

Inherits:
Object
  • Object
show all
Defined in:
lib/svix/models/redshift_config_in.rb

Overview

Configuration parameters for defining a Redshift sink.

For provisioned clusters, set cluster_identifier and db_user. For Redshift Serverless, set workgroup_name.

Direct Known Subclasses

StreamSinkInConfig::Redshift

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RedshiftConfigIn

Returns a new instance of RedshiftConfigIn.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/svix/models/redshift_config_in.rb', line 54

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail(ArgumentError, "The input argument (attributes) must be a hash in `Svix::RedshiftConfigIn` new method")
  end

  attributes.each do |k, v|
    unless ALL_FIELD.include?(k.to_s)
      fail(ArgumentError, "The field #{k} is not part of Svix::RedshiftConfigIn")
    end

    instance_variable_set("@#{k}", v)
    instance_variable_set("@__#{k}_is_defined", true)
  end
end

Instance Attribute Details

#access_key_id ⇒ Object

Access key ID.

Currently a required field, but marked as optional because we may add different authentication in the future.



13
14
15
 
# File 'lib/svix/models/redshift_config_in.rb', line 13

def access_key_id
  @access_key_id
end

#cluster_identifier ⇒ Object

Required for provisioned clusters.



23
24
25
 
# File 'lib/svix/models/redshift_config_in.rb', line 23

def cluster_identifier
  @cluster_identifier
end

#db_name ⇒ Object

Database name.

Only required if not using transformations.



31
32
33
 
# File 'lib/svix/models/redshift_config_in.rb', line 31

def db_name
  @db_name
end

#db_user ⇒ Object

Required for provisioned clusters.



25
26
27
 
# File 'lib/svix/models/redshift_config_in.rb', line 25

def db_user
  @db_user
end

#region ⇒ Object

The region of the Redshift DB.

Currently a required field, but marked as optional because we may infer it from other fields in the future.



21
22
23
 
# File 'lib/svix/models/redshift_config_in.rb', line 21

def region
  @region
end

#schema_name ⇒ Object

Schema name.

Only used if not using transformations.



35
36
37
 
# File 'lib/svix/models/redshift_config_in.rb', line 35

def schema_name
  @schema_name
end

#secret_access_key ⇒ Object

Secret access key.

Currently a required field, but marked as optional because we may add different authentication in the future.



17
18
19
 
# File 'lib/svix/models/redshift_config_in.rb', line 17

def secret_access_key
  @secret_access_key
end

#table_name ⇒ Object

Table name.

Only required if not using transformations.



39
40
41
 
# File 'lib/svix/models/redshift_config_in.rb', line 39

def table_name
  @table_name
end

#workgroup_name ⇒ Object

Required for Redshift Serverless.



27
28
29
 
# File 'lib/svix/models/redshift_config_in.rb', line 27

def workgroup_name
  @workgroup_name
end

Class Method Details

.deserialize(attributes = {}) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/svix/models/redshift_config_in.rb', line 69

def self.deserialize(attributes = {})
  attributes = attributes.transform_keys(&:to_s)
  attrs = Hash.new
  attrs["access_key_id"] = attributes["accessKeyId"]
  attrs["secret_access_key"] = attributes["secretAccessKey"]
  attrs["region"] = attributes["region"]
  attrs["cluster_identifier"] = attributes["clusterIdentifier"]
  attrs["db_user"] = attributes["dbUser"]
  attrs["workgroup_name"] = attributes["workgroupName"]
  attrs["db_name"] = attributes["dbName"]
  attrs["schema_name"] = attributes["schemaName"]
  attrs["table_name"] = attributes["tableName"]
  new(attrs)
end

Instance Method Details

#serialize ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/svix/models/redshift_config_in.rb', line 84

def serialize
  out = Hash.new
  out["accessKeyId"] = Svix::serialize_primitive(@access_key_id) if @access_key_id
  out["secretAccessKey"] = Svix::serialize_primitive(@secret_access_key) if @secret_access_key
  out["region"] = Svix::serialize_primitive(@region) if @region
  out["clusterIdentifier"] = Svix::serialize_primitive(@cluster_identifier) if @cluster_identifier
  out["dbUser"] = Svix::serialize_primitive(@db_user) if @db_user
  out["workgroupName"] = Svix::serialize_primitive(@workgroup_name) if @workgroup_name
  out["dbName"] = Svix::serialize_primitive(@db_name) if @db_name
  out["schemaName"] = Svix::serialize_primitive(@schema_name) if @schema_name
  out["tableName"] = Svix::serialize_primitive(@table_name) if @table_name
  out
end

#to_json ⇒ Object

Serializes the object to a json string

Returns:

  • String



100
101
102
 
# File 'lib/svix/models/redshift_config_in.rb', line 100

def to_json
  JSON.dump(serialize)
end