Class: Twilio::REST::Events::V1::SinkList

Inherits:
ListResource show all
Defined in:
lib/twilio-ruby/rest/events/v1/sink.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SinkList

Initialize the SinkList

Parameters:

  • version (Version) —

    Version that contains the resource



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 25

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/Sinks"
    
end

Instance Method Details

#create(description: nil, sink_configuration: nil, sink_type: nil) ⇒ SinkInstance

Create the SinkInstance

Parameters:

  • description (String) (defaults to: nil) —

    A human readable description for the Sink **This value should not contain PII.**

  • sink_configuration (Object) (defaults to: nil) —

    The information required for Twilio to connect to the provided Sink encoded as JSON.

  • sink_type (SinkType) (defaults to: nil)

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 38

def create(
    description: nil, 
    sink_configuration: nil, 
    sink_type: nil
)

    data = Twilio::Values.of({
        'Description' => description,
        'SinkConfiguration' => Twilio.serialize_object(sink_configuration),
        'SinkType' => sink_type,
    })

    payload = @version.create('POST', @uri, data: data)
    SinkInstance.new(
        @version,
        payload,
    )
end

#each ⇒ Object

When passed a block, yields SinkInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 108

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of SinkInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of SinkInstance



146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 146

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
SinkPage.new(@version, response, @solution)
end

#list(in_use: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

Lists SinkInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • in_use (Boolean) (defaults to: :unset) —

    A boolean query parameter filtering the results to return sinks used/not used by a subscription.

  • status (String) (defaults to: :unset) —

    A String query parameter filtering the results by status ‘initialized`, `validating`, `active` or `failed`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



71
72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 71

def list(in_use: :unset, status: :unset, limit: nil, page_size: nil)
    self.stream(
        in_use: in_use,
        status: status,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(in_use: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of SinkInstance records from the API. Request is executed immediately.

Parameters:

  • in_use (Boolean) (defaults to: :unset) —

    A boolean query parameter filtering the results to return sinks used/not used by a subscription.

  • status (String) (defaults to: :unset) —

    A String query parameter filtering the results by status ‘initialized`, `validating`, `active` or `failed`.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of SinkInstance



127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 127

def page(in_use: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'InUse' => in_use,
        'Status' => status,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

    response = @version.page('GET', @uri, params: params)

    SinkPage.new(@version, response, @solution)
end

#stream(in_use: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • in_use (Boolean) (defaults to: :unset) —

    A boolean query parameter filtering the results to return sinks used/not used by a subscription.

  • status (String) (defaults to: :unset) —

    A String query parameter filtering the results by status ‘initialized`, `validating`, `active` or `failed`.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 93

def stream(in_use: :unset, status: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        in_use: in_use,
        status: status,
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



157
158
159
 
# File 'lib/twilio-ruby/rest/events/v1/sink.rb', line 157

def to_s
    '#<Twilio.Events.V1.SinkList>'
end