Package com.ngrok.services

Class IpRestrictions.CreateCallBuilder

java.lang.Object

com.ngrok.services.IpRestrictions.CreateCallBuilder

Enclosing class:

IpRestrictions

public class IpRestrictions.CreateCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
IpRestriction	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<IpRestriction>	call()	Initiates the API call asynchronously.
IpRestrictions.CreateCallBuilder	description(String description)	human-readable description of this IP restriction.
IpRestrictions.CreateCallBuilder	description(Optional<String> description)	human-readable description of this IP restriction.
IpRestrictions.CreateCallBuilder	enforced(boolean enforced)	true if the IP restriction will be enforced.
IpRestrictions.CreateCallBuilder	enforced(Optional<Boolean> enforced)	true if the IP restriction will be enforced.
IpRestrictions.CreateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this IP restriction.
IpRestrictions.CreateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined machine-readable data of this IP restriction.

Methods inherited from class java.lang.Object

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

Method Details

description

public IpRestrictions.CreateCallBuilder description(String description)

human-readable description of this IP restriction. optional, max 255 bytes.

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

public IpRestrictions.CreateCallBuilder description(Optional<String> description)

human-readable description of this IP restriction. optional, max 255 bytes.

Parameters:

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

Returns:

the call builder instance

metadata

public IpRestrictions.CreateCallBuilder metadata(String metadata)

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

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

public IpRestrictions.CreateCallBuilder metadata(Optional<String> metadata)

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

Parameters:

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

Returns:

the call builder instance

enforced

public IpRestrictions.CreateCallBuilder enforced(boolean enforced)

true if the IP restriction will be enforced. if false, only warnings will be issued

Parameters:

enforced - the value of the enforced parameter as a boolean

Returns:

the call builder instance

enforced

public IpRestrictions.CreateCallBuilder enforced(Optional<Boolean> enforced)

true if the IP restriction will be enforced. if false, only warnings will be issued

Parameters:

enforced - the value of the enforced parameter as an Optional of boolean

Returns:

the call builder instance

call

public CompletionStage<IpRestriction> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of IpRestriction

blockingCall

public IpRestriction blockingCall()
                           throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

IpRestriction

Throws:

InterruptedException - if the thread was interrupted during the call