Class: Svix::IngestEndpointIn

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IngestEndpointIn

Returns a new instance of IngestEndpointIn.



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

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

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

Instance Attribute Details

#descriptionObject

Returns the value of attribute description.



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

def description
  @description
end

#disabledObject

Returns the value of attribute disabled.



15
16
17
# File 'lib/svix/models/ingest_endpoint_in.rb', line 15

def disabled
  @disabled
end

#metadataObject

Returns the value of attribute metadata.



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

def 
  @metadata
end

#secretObject

The endpoint's verification secret.

Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.



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

def secret
  @secret
end

#throttle_rateObject

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.



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

def throttle_rate
  @throttle_rate
end

#uidObject

Optional unique identifier for the endpoint.



14
15
16
# File 'lib/svix/models/ingest_endpoint_in.rb', line 14

def uid
  @uid
end

#urlObject

Returns the value of attribute url.



7
8
9
# File 'lib/svix/models/ingest_endpoint_in.rb', line 7

def url
  @url
end

Class Method Details

.deserialize(attributes = {}) ⇒ Object



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

def self.deserialize(attributes = {})
  attributes = attributes.transform_keys(&:to_s)
  attrs = Hash.new
  attrs["url"] = attributes["url"]
  attrs["description"] = attributes["description"]
  attrs["throttle_rate"] = attributes["throttleRate"]
  attrs["uid"] = attributes["uid"]
  attrs["disabled"] = attributes["disabled"]
  attrs["secret"] = attributes["secret"]
  attrs["metadata"] = attributes["metadata"]
  new(attrs)
end

Instance Method Details

#serializeObject



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

def serialize
  out = Hash.new
  out["url"] = Svix::serialize_primitive(@url) if @url
  out["description"] = Svix::serialize_primitive(@description) if @description
  out["throttleRate"] = Svix::serialize_primitive(@throttle_rate) if @throttle_rate
  out["uid"] = Svix::serialize_primitive(@uid) if @uid
  out["disabled"] = Svix::serialize_primitive(@disabled) if @disabled
  out["secret"] = Svix::serialize_primitive(@secret) if @secret
  out["metadata"] = Svix::serialize_primitive(@metadata) if @metadata
  out
end

#to_jsonObject

Serializes the object to a json string

Returns:

  • String



68
69
70
# File 'lib/svix/models/ingest_endpoint_in.rb', line 68

def to_json
  JSON.dump(serialize)
end