Package com.ngrok.services

Class EdgesTls.UpdateCallBuilder

java.lang.Object

com.ngrok.services.EdgesTls.UpdateCallBuilder

Enclosing class:

EdgesTls

public class EdgesTls.UpdateCallBuilder
extends Object

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

description

public EdgesTls.UpdateCallBuilder 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 EdgesTls.UpdateCallBuilder 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 EdgesTls.UpdateCallBuilder 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 EdgesTls.UpdateCallBuilder 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 EdgesTls.UpdateCallBuilder 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 EdgesTls.UpdateCallBuilder 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 EdgesTls.UpdateCallBuilder backend(EndpointBackendMutate backend)

edge modules

Parameters:

backend - the value of the backend parameter as a EndpointBackendMutate

Returns:

the call builder instance

backend

public EdgesTls.UpdateCallBuilder 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 EdgesTls.UpdateCallBuilder 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 EdgesTls.UpdateCallBuilder 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

mutualTls

public EdgesTls.UpdateCallBuilder mutualTls(EndpointMutualTlsMutate mutualTls)

Sets the mutual_tls parameter.

Parameters:

mutualTls - the value of the mutual_tls parameter as a EndpointMutualTlsMutate

Returns:

the call builder instance

mutualTls

public EdgesTls.UpdateCallBuilder mutualTls(Optional<EndpointMutualTlsMutate> mutualTls)

Sets (or unsets) the mutual_tls parameter.

Parameters:

mutualTls - the value of the mutual_tls parameter as an Optional of EndpointMutualTlsMutate

Returns:

the call builder instance

tlsTermination

public EdgesTls.UpdateCallBuilder tlsTermination(EndpointTlsTermination tlsTermination)

Sets the tls_termination parameter.

Parameters:

tlsTermination - the value of the tls_termination parameter as a EndpointTlsTermination

Returns:

the call builder instance

tlsTermination

public EdgesTls.UpdateCallBuilder tlsTermination(Optional<EndpointTlsTermination> tlsTermination)

Sets (or unsets) the tls_termination parameter.

Parameters:

tlsTermination - the value of the tls_termination parameter as an Optional of EndpointTlsTermination

Returns:

the call builder instance

call

public CompletionStage<TlsEdge> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of TlsEdge

blockingCall

public TlsEdge blockingCall()
                     throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

TlsEdge

Throws:

InterruptedException - if the thread was interrupted during the call