Package com.ngrok.services

Class IpPolicyRules.CreateCallBuilder

java.lang.Object

com.ngrok.services.IpPolicyRules.CreateCallBuilder

Enclosing class:

IpPolicyRules

public class IpPolicyRules.CreateCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
IpPolicyRules.CreateCallBuilder	action(String action)	the action to apply to the policy rule, either allow or deny
IpPolicyRules.CreateCallBuilder	action(Optional<String> action)	the action to apply to the policy rule, either allow or deny
IpPolicyRule	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<IpPolicyRule>	call()	Initiates the API call asynchronously.
IpPolicyRules.CreateCallBuilder	description(String description)	human-readable description of the source IPs of this IP rule.
IpPolicyRules.CreateCallBuilder	description(Optional<String> description)	human-readable description of the source IPs of this IP rule.
IpPolicyRules.CreateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this IP policy rule.
IpPolicyRules.CreateCallBuilder	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.CreateCallBuilder 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.CreateCallBuilder 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.CreateCallBuilder 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.CreateCallBuilder 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

action

public IpPolicyRules.CreateCallBuilder action(String action)

the action to apply to the policy rule, either allow or deny

Parameters:

action - the value of the action parameter as a String

Returns:

the call builder instance

action

public IpPolicyRules.CreateCallBuilder action(Optional<String> action)

the action to apply to the policy rule, either allow or deny

Parameters:

action - the value of the action 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