Package com.ngrok.services

Class AgentIngresses.CreateCallBuilder

java.lang.Object

com.ngrok.services.AgentIngresses.CreateCallBuilder

Enclosing class:

AgentIngresses

public class AgentIngresses.CreateCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
AgentIngress	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<AgentIngress>	call()	Initiates the API call asynchronously.
AgentIngresses.CreateCallBuilder	description(String description)	human-readable description of the use of this Agent Ingress.
AgentIngresses.CreateCallBuilder	description(Optional<String> description)	human-readable description of the use of this Agent Ingress.
AgentIngresses.CreateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this Agent Ingress.
AgentIngresses.CreateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined machine-readable data of this Agent Ingress.

Methods inherited from class java.lang.Object

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

Method Details

description

public AgentIngresses.CreateCallBuilder description(String description)

human-readable description of the use of this Agent Ingress. optional, max 255 bytes.

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

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

human-readable description of the use of this Agent Ingress. optional, max 255 bytes.

Parameters:

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

Returns:

the call builder instance

metadata

public AgentIngresses.CreateCallBuilder metadata(String metadata)

arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

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

arbitrary user-defined machine-readable data of this Agent Ingress. 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<AgentIngress> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of AgentIngress

blockingCall

public AgentIngress blockingCall()
                          throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

AgentIngress

Throws:

InterruptedException - if the thread was interrupted during the call