Package com.ngrok.services

Class EventSubscriptions.UpdateCallBuilder

java.lang.Object

com.ngrok.services.EventSubscriptions.UpdateCallBuilder

Enclosing class:

EventSubscriptions

public class EventSubscriptions.UpdateCallBuilder
extends Object

A builder object encapsulating state for an unsent Update API call.

Method Summary

Modifier and Type	Method	Description
EventSubscription	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<EventSubscription>	call()	Initiates the API call asynchronously.
EventSubscriptions.UpdateCallBuilder	description(String description)	Arbitrary customer supplied information intended to be human readable.
EventSubscriptions.UpdateCallBuilder	description(Optional<String> description)	Arbitrary customer supplied information intended to be human readable.
EventSubscriptions.UpdateCallBuilder	destinationIds(List<String> destinationIds)	A list of Event Destination IDs which should be used for this Event Subscription.
EventSubscriptions.UpdateCallBuilder	destinationIds(Optional<List<String>> destinationIds)	A list of Event Destination IDs which should be used for this Event Subscription.
EventSubscriptions.UpdateCallBuilder	metadata(String metadata)	Arbitrary customer supplied information intended to be machine readable.
EventSubscriptions.UpdateCallBuilder	metadata(Optional<String> metadata)	Arbitrary customer supplied information intended to be machine readable.
EventSubscriptions.UpdateCallBuilder	sources(List<EventSourceReplace> sources)	Sources containing the types for which this event subscription will trigger
EventSubscriptions.UpdateCallBuilder	sources(Optional<List<EventSourceReplace>> sources)	Sources containing the types for which this event subscription will trigger

Methods inherited from class java.lang.Object

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

Method Details

metadata

public EventSubscriptions.UpdateCallBuilder metadata(String metadata)

Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

public EventSubscriptions.UpdateCallBuilder metadata(Optional<String> metadata)

Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.

Parameters:

metadata - the value of the metadata parameter as an Optional of String

Returns:

the call builder instance

description

public EventSubscriptions.UpdateCallBuilder description(String description)

Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

public EventSubscriptions.UpdateCallBuilder description(Optional<String> description)

Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.

Parameters:

description - the value of the description parameter as an Optional of String

Returns:

the call builder instance

sources

public EventSubscriptions.UpdateCallBuilder sources(List<EventSourceReplace> sources)

Sources containing the types for which this event subscription will trigger

Parameters:

sources - the value of the sources parameter as a List of EventSourceReplace

Returns:

the call builder instance

sources

public EventSubscriptions.UpdateCallBuilder sources(Optional<List<EventSourceReplace>> sources)

Sources containing the types for which this event subscription will trigger

Parameters:

sources - the value of the sources parameter as an Optional of List of EventSourceReplace

Returns:

the call builder instance

destinationIds

public EventSubscriptions.UpdateCallBuilder destinationIds(List<String> destinationIds)

A list of Event Destination IDs which should be used for this Event Subscription.

Parameters:

destinationIds - the value of the destination_ids parameter as a List of String

Returns:

the call builder instance

destinationIds

public EventSubscriptions.UpdateCallBuilder destinationIds(Optional<List<String>> destinationIds)

A list of Event Destination IDs which should be used for this Event Subscription.

Parameters:

destinationIds - the value of the destination_ids parameter as an Optional of List of String

Returns:

the call builder instance

call

public CompletionStage<EventSubscription> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of EventSubscription

blockingCall

public EventSubscription blockingCall()
                               throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

EventSubscription

Throws:

InterruptedException - if the thread was interrupted during the call