Package com.ngrok.services

Class EventStreams

java.lang.Object

com.ngrok.services.EventStreams

public class EventStreams
extends Object

An API client for EventStreams. See also https://ngrok.com/docs/api#api-event-streams.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	EventStreams.CreateCallBuilder	A builder object encapsulating state for an unsent Create API call.
class	EventStreams.DeleteCallBuilder	A builder object encapsulating state for an unsent Delete API call.
class	EventStreams.GetCallBuilder	A builder object encapsulating state for an unsent Get API call.
class	EventStreams.ListCallBuilder	A builder object encapsulating state for an unsent List API call.
class	EventStreams.UpdateCallBuilder	A builder object encapsulating state for an unsent Update API call.

Constructor Summary

Constructors

Constructor	Description
EventStreams(NgrokApiClient apiClient)	Creates a new sub-client for EventStreams.

Method Summary

Modifier and Type	Method	Description
EventStreams.CreateCallBuilder	create()	Create a new Event Stream.
EventStreams.DeleteCallBuilder	delete(String id)	Delete an Event Stream.
EventStreams.GetCallBuilder	get(String id)	Get detailed information about an Event Stream by ID.
EventStreams.ListCallBuilder	list()	List all Event Streams available on this account.
EventStreams.UpdateCallBuilder	update(String id)	Update attributes of an Event Stream by ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EventStreams

public EventStreams(NgrokApiClient apiClient)

Creates a new sub-client for EventStreams.

Parameters:

apiClient - an instance of NgrokApiClient

Method Details

create

public EventStreams.CreateCallBuilder create()

Create a new Event Stream. It will not apply to anything until you associate it with one or more Endpoint Configs. See also https://ngrok.com/docs/api#api-event-streams-create.

Returns:

a call builder for this API call

delete

public EventStreams.DeleteCallBuilder delete(String id)

Delete an Event Stream. Associated Event Destinations will be preserved. See also https://ngrok.com/docs/api#api-event-streams-delete.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

get

public EventStreams.GetCallBuilder get(String id)

Get detailed information about an Event Stream by ID. See also https://ngrok.com/docs/api#api-event-streams-get.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

list

public EventStreams.ListCallBuilder list()

List all Event Streams available on this account. See also https://ngrok.com/docs/api#api-event-streams-list.

Returns:

a call builder for this API call

update

public EventStreams.UpdateCallBuilder update(String id)

Update attributes of an Event Stream by ID. See also https://ngrok.com/docs/api#api-event-streams-update.

Parameters:

id - Unique identifier for this Event Stream.

Returns:

a call builder for this API call