Package com.ngrok.services

Class EdgesTcp.CreateCallBuilder

java.lang.Object

com.ngrok.services.EdgesTcp.CreateCallBuilder

Enclosing class:

EdgesTcp

public class EdgesTcp.CreateCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
EdgesTcp.CreateCallBuilder	backend(EndpointBackendMutate backend)	edge modules
EdgesTcp.CreateCallBuilder	backend(Optional<EndpointBackendMutate> backend)	edge modules
TcpEdge	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<TcpEdge>	call()	Initiates the API call asynchronously.
EdgesTcp.CreateCallBuilder	description(String description)	human-readable description of what this edge will be used for; optional, max 255 bytes.
EdgesTcp.CreateCallBuilder	description(Optional<String> description)	human-readable description of what this edge will be used for; optional, max 255 bytes.
EdgesTcp.CreateCallBuilder	hostports(List<String> hostports)	hostports served by this edge
EdgesTcp.CreateCallBuilder	hostports(Optional<List<String>> hostports)	hostports served by this edge
EdgesTcp.CreateCallBuilder	ipRestriction(EndpointIpPolicyMutate ipRestriction)	Sets the ip_restriction parameter.
EdgesTcp.CreateCallBuilder	ipRestriction(Optional<EndpointIpPolicyMutate> ipRestriction)	Sets (or unsets) the ip_restriction parameter.
EdgesTcp.CreateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this edge.
EdgesTcp.CreateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined machine-readable data of this edge.

Methods inherited from class java.lang.Object

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

Method Details

description

public EdgesTcp.CreateCallBuilder description(String description)

human-readable description of what this edge will be used for; optional, max 255 bytes.

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

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

human-readable description of what this edge will be used for; optional, max 255 bytes.

Parameters:

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

Returns:

the call builder instance

metadata

public EdgesTcp.CreateCallBuilder metadata(String metadata)

arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

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

arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

Parameters:

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

Returns:

the call builder instance

hostports

public EdgesTcp.CreateCallBuilder hostports(List<String> hostports)

hostports served by this edge

Parameters:

hostports - the value of the hostports parameter as a List of String

Returns:

the call builder instance

hostports

public EdgesTcp.CreateCallBuilder hostports(Optional<List<String>> hostports)

hostports served by this edge

Parameters:

hostports - the value of the hostports parameter as an Optional of List of String

Returns:

the call builder instance

backend

public EdgesTcp.CreateCallBuilder backend(EndpointBackendMutate backend)

edge modules

Parameters:

backend - the value of the backend parameter as a EndpointBackendMutate

Returns:

the call builder instance

backend

public EdgesTcp.CreateCallBuilder backend(Optional<EndpointBackendMutate> backend)

edge modules

Parameters:

backend - the value of the backend parameter as an Optional of EndpointBackendMutate

Returns:

the call builder instance

ipRestriction

public EdgesTcp.CreateCallBuilder ipRestriction(EndpointIpPolicyMutate ipRestriction)

Sets the ip_restriction parameter.

Parameters:

ipRestriction - the value of the ip_restriction parameter as a EndpointIpPolicyMutate

Returns:

the call builder instance

ipRestriction

public EdgesTcp.CreateCallBuilder ipRestriction(Optional<EndpointIpPolicyMutate> ipRestriction)

Sets (or unsets) the ip_restriction parameter.

Parameters:

ipRestriction - the value of the ip_restriction parameter as an Optional of EndpointIpPolicyMutate

Returns:

the call builder instance

call

public CompletionStage<TcpEdge> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of TcpEdge

blockingCall

public TcpEdge blockingCall()
                     throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

TcpEdge

Throws:

InterruptedException - if the thread was interrupted during the call