Package com.ngrok.services

Class IpPolicyRules.UpdateCallBuilder

java.lang.Object

com.ngrok.services.IpPolicyRules.UpdateCallBuilder

Enclosing class:

IpPolicyRules

public class IpPolicyRules.UpdateCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
IpPolicyRule	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<IpPolicyRule>	call()	Initiates the API call asynchronously.
IpPolicyRules.UpdateCallBuilder	cidr(String cidr)	an IP or IP range specified in CIDR notation.
IpPolicyRules.UpdateCallBuilder	cidr(Optional<String> cidr)	an IP or IP range specified in CIDR notation.
IpPolicyRules.UpdateCallBuilder	description(String description)	human-readable description of the source IPs of this IP rule.
IpPolicyRules.UpdateCallBuilder	description(Optional<String> description)	human-readable description of the source IPs of this IP rule.
IpPolicyRules.UpdateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this IP policy rule.
IpPolicyRules.UpdateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined machine-readable data of this IP policy rule.

Methods inherited from class java.lang.Object

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

Method Details

description

public IpPolicyRules.UpdateCallBuilder description(String description)

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

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

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

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

Parameters:

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

Returns:

the call builder instance

metadata

public IpPolicyRules.UpdateCallBuilder metadata(String metadata)

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

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

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

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

Parameters:

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

Returns:

the call builder instance

cidr

public IpPolicyRules.UpdateCallBuilder cidr(String cidr)

an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.

Parameters:

cidr - the value of the cidr parameter as a String

Returns:

the call builder instance

cidr

public IpPolicyRules.UpdateCallBuilder cidr(Optional<String> cidr)

an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.

Parameters:

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

Returns:

the call builder instance

call

public CompletionStage<IpPolicyRule> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of IpPolicyRule

blockingCall

public IpPolicyRule blockingCall()
                          throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

IpPolicyRule

Throws:

InterruptedException - if the thread was interrupted during the call