Package com.ngrok.services

Class Tunnels.ListCallBuilder

java.lang.Object

com.ngrok.services.Tunnels.ListCallBuilder

Enclosing class:

Tunnels

public class Tunnels.ListCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
Tunnels.ListCallBuilder	beforeId(String beforeId)	Sets the before_id parameter.
Tunnels.ListCallBuilder	beforeId(Optional<String> beforeId)	Sets (or unsets) the before_id parameter.
Page<TunnelList>	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<Page<TunnelList>>	call()	Initiates the API call asynchronously.
Tunnels.ListCallBuilder	limit(String limit)	Sets the limit parameter.
Tunnels.ListCallBuilder	limit(Optional<String> limit)	Sets (or unsets) the limit parameter.

Methods inherited from class java.lang.Object

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

Method Details

beforeId

public Tunnels.ListCallBuilder beforeId(String beforeId)

Sets the before_id parameter.

Parameters:

beforeId - the value of the before_id parameter as a String

Returns:

the call builder instance

beforeId

public Tunnels.ListCallBuilder beforeId(Optional<String> beforeId)

Sets (or unsets) the before_id parameter.

Parameters:

beforeId - the value of the before_id parameter as an Optional of String

Returns:

the call builder instance

limit

public Tunnels.ListCallBuilder limit(String limit)

Sets the limit parameter.

Parameters:

limit - the value of the limit parameter as a String

Returns:

the call builder instance

limit

public Tunnels.ListCallBuilder limit(Optional<String> limit)

Sets (or unsets) the limit parameter.

Parameters:

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

Returns:

the call builder instance

call

public CompletionStage<Page<TunnelList>> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of a Page of TunnelList

blockingCall

public Page<TunnelList> blockingCall()
                              throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

a Page of TunnelList

Throws:

InterruptedException - if the thread was interrupted during the call