Class: Svix::SnsConfigIn

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

Overview

Configuration for a SNS sink.

Direct Known Subclasses

Svix::StreamSinkInConfig::Sns

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SnsConfigIn

Returns a new instance of SnsConfigIn.



26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/svix/models/sns_config_in.rb', line 26

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail(ArgumentError, "The input argument (attributes) must be a hash in `Svix::SnsConfigIn` 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::SnsConfigIn")
    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.



16
17
18
 
# File 'lib/svix/models/sns_config_in.rb', line 16

def access_key_id
  @access_key_id
end

#endpoint_url ⇒ Object

Returns the value of attribute endpoint_url.



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

def endpoint_url
  @endpoint_url
end

#region ⇒ Object

The region of the SNS instance.

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



12
13
14
 
# File 'lib/svix/models/sns_config_in.rb', line 12

def region
  @region
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.



20
21
22
 
# File 'lib/svix/models/sns_config_in.rb', line 20

def secret_access_key
  @secret_access_key
end

#topic_arn ⇒ Object

Returns the value of attribute topic_arn.



8
9
10
 
# File 'lib/svix/models/sns_config_in.rb', line 8

def topic_arn
  @topic_arn
end

Class Method Details

.deserialize(attributes = {}) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/svix/models/sns_config_in.rb', line 41

def self.deserialize(attributes = {})
  attributes = attributes.transform_keys(&:to_s)
  attrs = Hash.new
  attrs["topic_arn"] = attributes["topicArn"]
  attrs["region"] = attributes["region"]
  attrs["access_key_id"] = attributes["accessKeyId"]
  attrs["secret_access_key"] = attributes["secretAccessKey"]
  attrs["endpoint_url"] = attributes["endpointUrl"]
  new(attrs)
end

Instance Method Details

#serialize ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'lib/svix/models/sns_config_in.rb', line 52

def serialize
  out = Hash.new
  out["topicArn"] = Svix::serialize_primitive(@topic_arn) if @topic_arn
  out["region"] = Svix::serialize_primitive(@region) if @region
  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["endpointUrl"] = Svix::serialize_primitive(@endpoint_url) if @endpoint_url
  out
end

#to_json ⇒ Object

Serializes the object to a json string

Returns:

  • String



64
65
66
 
# File 'lib/svix/models/sns_config_in.rb', line 64

def to_json
  JSON.dump(serialize)
end