Package com.ngrok.services

Class IpWhitelist.UpdateCallBuilder

java.lang.Object

com.ngrok.services.IpWhitelist.UpdateCallBuilder

Enclosing class:

IpWhitelist

public class IpWhitelist.UpdateCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
IpWhitelistEntry	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<IpWhitelistEntry>	call()	Initiates the API call asynchronously.
IpWhitelist.UpdateCallBuilder	description(String description)	human-readable description of the source IPs for this IP whitelist entry.
IpWhitelist.UpdateCallBuilder	description(Optional<String> description)	human-readable description of the source IPs for this IP whitelist entry.
IpWhitelist.UpdateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this IP whitelist entry.
IpWhitelist.UpdateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined machine-readable data of this IP whitelist entry.

Methods inherited from class java.lang.Object

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

Method Details

description

public IpWhitelist.UpdateCallBuilder description(String description)

human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

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

human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.

Parameters:

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

Returns:

the call builder instance

metadata

public IpWhitelist.UpdateCallBuilder metadata(String metadata)

arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

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

arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.

Parameters:

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

Returns:

the call builder instance

call

public CompletionStage<IpWhitelistEntry> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of IpWhitelistEntry

blockingCall

public IpWhitelistEntry blockingCall()
                              throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

IpWhitelistEntry

Throws:

InterruptedException - if the thread was interrupted during the call