Class: NgrokAPI::Services::EventDestinationsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/services/event_destinations_client.rb

Overview

https://ngrok.com/docs/api#api-event-destinations

Constant Summary collapse

PATH =

The API path for the requests

'/event_destinations'
LIST_PROPERTY =

The List Property from the resulting API for list calls

'event_destinations'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ EventDestinationsClient

Returns a new instance of EventDestinationsClient.



17
18
19
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 17

def initialize(client:)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



15
16
17
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 15

def client
  @client
end

Instance Method Details

#create(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination

Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription.

https://ngrok.com/docs/api#api-event-destinations-create

Parameters:

  • metadata (string) (defaults to: "") —

    Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.

  • description (string) (defaults to: "") —

    Human-readable description of the Event Destination. Optional, max 255 bytes.

  • format (string) (defaults to: "") —

    The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.

  • target (EventTarget) (defaults to: nil) —

    An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.

Returns:



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 32

def create(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil)
  path = '/event_destinations'
  replacements = {
  }
  data = {}
  data[:metadata] = metadata if metadata
  data[:description] = description if description
  data[:format] = format if format
  data[:target] = target if target
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
end

#create!(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination

Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription. Throws an exception if API error.

https://ngrok.com/docs/api#api-event-destinations-create

Parameters:

  • metadata (string) (defaults to: "") —

    Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.

  • description (string) (defaults to: "") —

    Human-readable description of the Event Destination. Optional, max 255 bytes.

  • format (string) (defaults to: "") —

    The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.

  • target (EventTarget) (defaults to: nil) —

    An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 57

def create!(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil)
  path = '/event_destinations'
  replacements = {
  }
  data = {}
  data[:metadata] = metadata if metadata
  data[:description] = description if description
  data[:format] = format if format
  data[:target] = target if target
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
end

#delete(id: "") ⇒ NgrokAPI::Models::Empty

Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.

https://ngrok.com/docs/api#api-event-destinations-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



78
79
80
81
82
83
84
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 78

def delete(id: "")
  path = '/event_destinations/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end

#delete!(id: "") ⇒ NgrokAPI::Models::Empty

Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription. Throws an exception if API error.

https://ngrok.com/docs/api#api-event-destinations-delete

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:

  • (NgrokAPI::Models::Empty) —

    result from the API request



95
96
97
98
99
100
101
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 95

def delete!(id: "")
  path = '/event_destinations/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end

#get(id: "") ⇒ NgrokAPI::Models::EventDestination

Get detailed information about an Event Destination by ID.

https://ngrok.com/docs/api#api-event-destinations-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



110
111
112
113
114
115
116
117
118
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 110

def get(id: "")
  path = '/event_destinations/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
end

#get!(id: "") ⇒ NgrokAPI::Models::EventDestination

Get detailed information about an Event Destination by ID. Throws an exception if API error.

https://ngrok.com/docs/api#api-event-destinations-get

Parameters:

  • id (string) (defaults to: "") —

    a resource identifier

Returns:



128
129
130
131
132
133
134
135
136
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 128

def get!(id: "")
  path = '/event_destinations/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
end

#list(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all Event Destinations on this account.

https://ngrok.com/docs/api#api-event-destinations-list

Parameters:

  • before_id (string) (defaults to: nil) —

    Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.

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

    Constrains the number of results in the dataset. See the API Overview <https://ngrok.com/docs/api/index#pagination>_ for details.

  • filter (string) (defaults to: nil) —

    A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>_.

  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 148

def list(
  before_id: nil,
  limit: nil,
  filter: nil,
  url: nil
)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    filter: filter,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::EventDestination
  )
end

#list!(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable

List all Event Destinations on this account. Throws an exception if API error.

https://ngrok.com/docs/api#api-event-destinations-list

Parameters:

  • before_id (string) (defaults to: nil) —

    Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.

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

    Constrains the number of results in the dataset. See the API Overview <https://ngrok.com/docs/api/index#pagination>_ for details.

  • filter (string) (defaults to: nil) —

    A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as id, metadata, created_at, and more. See ngrok API Filtering for syntax and field details: https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering>_.

  • url (string) (defaults to: nil) —

    optional and mutually exclusive from before_id and limit

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 181

def list!(
  before_id: nil,
  limit: nil,
  filter: nil,
  url: nil
)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    filter: filter,
    danger: true,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::EventDestination,
    danger: true
  )
end

#update(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination

Update attributes of an Event Destination.

https://ngrok.com/docs/api#api-event-destinations-update

Parameters:

  • id (string) (defaults to: "") —

    Unique identifier for this Event Destination.

  • metadata (string) (defaults to: nil) —

    Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.

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

    Human-readable description of the Event Destination. Optional, max 255 bytes.

  • format (string) (defaults to: nil) —

    The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.

  • target (EventTarget) (defaults to: nil) —

    An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 216

def update(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil)
  path = '/event_destinations/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:metadata] = metadata if metadata
  data[:description] = description if description
  data[:format] = format if format
  data[:target] = target if target
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
end

#update!(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination

Update attributes of an Event Destination. Throws an exception if API error.

https://ngrok.com/docs/api#api-event-destinations-update

Parameters:

  • id (string) (defaults to: "") —

    Unique identifier for this Event Destination.

  • metadata (string) (defaults to: nil) —

    Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.

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

    Human-readable description of the Event Destination. Optional, max 255 bytes.

  • format (string) (defaults to: nil) —

    The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.

  • target (EventTarget) (defaults to: nil) —

    An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.

Returns:



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/ngrokapi/services/event_destinations_client.rb', line 242

def update!(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil)
  path = '/event_destinations/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:metadata] = metadata if metadata
  data[:description] = description if description
  data[:format] = format if format
  data[:target] = target if target
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::EventDestination.new(client: self, attrs: result)
end