Package com.ngrok.services

Class EndpointConfigurations.CreateCallBuilder

java.lang.Object

com.ngrok.services.EndpointConfigurations.CreateCallBuilder

Enclosing class:

EndpointConfigurations

public class EndpointConfigurations.CreateCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
EndpointConfiguration	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<EndpointConfiguration>	call()	Initiates the API call asynchronously.
EndpointConfigurations.CreateCallBuilder	circuitBreaker(EndpointCircuitBreaker circuitBreaker)	circuit breaker module configuration or null
EndpointConfigurations.CreateCallBuilder	circuitBreaker(Optional<EndpointCircuitBreaker> circuitBreaker)	circuit breaker module configuration or null
EndpointConfigurations.CreateCallBuilder	compression(EndpointCompression compression)	compression module configuration or null
EndpointConfigurations.CreateCallBuilder	compression(Optional<EndpointCompression> compression)	compression module configuration or null
EndpointConfigurations.CreateCallBuilder	description(String description)	human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to.
EndpointConfigurations.CreateCallBuilder	description(Optional<String> description)	human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to.
EndpointConfigurations.CreateCallBuilder	ipPolicy(EndpointIpPolicyMutate ipPolicy)	ip policy module configuration or null
EndpointConfigurations.CreateCallBuilder	ipPolicy(Optional<EndpointIpPolicyMutate> ipPolicy)	ip policy module configuration or null
EndpointConfigurations.CreateCallBuilder	logging(EndpointLoggingMutate logging)	logging module configuration or null
EndpointConfigurations.CreateCallBuilder	logging(Optional<EndpointLoggingMutate> logging)	logging module configuration or null
EndpointConfigurations.CreateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this endpoint configuration.
EndpointConfigurations.CreateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined machine-readable data of this endpoint configuration.
EndpointConfigurations.CreateCallBuilder	mutualTls(EndpointMutualTlsMutate mutualTls)	mutual TLS module configuration or null
EndpointConfigurations.CreateCallBuilder	mutualTls(Optional<EndpointMutualTlsMutate> mutualTls)	mutual TLS module configuration or null
EndpointConfigurations.CreateCallBuilder	oauth(EndpointOAuth oauth)	oauth module configuration or null
EndpointConfigurations.CreateCallBuilder	oauth(Optional<EndpointOAuth> oauth)	oauth module configuration or null
EndpointConfigurations.CreateCallBuilder	oidc(EndpointOidc oidc)	oidc module configuration or null
EndpointConfigurations.CreateCallBuilder	oidc(Optional<EndpointOidc> oidc)	oidc module configuration or null
EndpointConfigurations.CreateCallBuilder	requestHeaders(EndpointRequestHeaders requestHeaders)	request headers module configuration or null
EndpointConfigurations.CreateCallBuilder	requestHeaders(Optional<EndpointRequestHeaders> requestHeaders)	request headers module configuration or null
EndpointConfigurations.CreateCallBuilder	responseHeaders(EndpointResponseHeaders responseHeaders)	response headers module configuration or null
EndpointConfigurations.CreateCallBuilder	responseHeaders(Optional<EndpointResponseHeaders> responseHeaders)	response headers module configuration or null
EndpointConfigurations.CreateCallBuilder	saml(EndpointSamlMutate saml)	saml module configuration or null
EndpointConfigurations.CreateCallBuilder	saml(Optional<EndpointSamlMutate> saml)	saml module configuration or null
EndpointConfigurations.CreateCallBuilder	tlsTermination(EndpointTlsTermination tlsTermination)	TLS termination module configuration or null
EndpointConfigurations.CreateCallBuilder	tlsTermination(Optional<EndpointTlsTermination> tlsTermination)	TLS termination module configuration or null
EndpointConfigurations.CreateCallBuilder	type(String type)	they type of traffic this endpoint configuration can be applied to.
EndpointConfigurations.CreateCallBuilder	type(Optional<String> type)	they type of traffic this endpoint configuration can be applied to.
EndpointConfigurations.CreateCallBuilder	webhookValidation(EndpointWebhookValidation webhookValidation)	webhook validation module configuration or null
EndpointConfigurations.CreateCallBuilder	webhookValidation(Optional<EndpointWebhookValidation> webhookValidation)	webhook validation module configuration or null

Methods inherited from class java.lang.Object

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

Method Details

type

public EndpointConfigurations.CreateCallBuilder type(String type)

they type of traffic this endpoint configuration can be applied to. one of: http, https, tcp

Parameters:

type - the value of the type parameter as a String

Returns:

the call builder instance

type

public EndpointConfigurations.CreateCallBuilder type(Optional<String> type)

they type of traffic this endpoint configuration can be applied to. one of: http, https, tcp

Parameters:

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

Returns:

the call builder instance

description

public EndpointConfigurations.CreateCallBuilder description(String description)

human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

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

human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes

Parameters:

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

Returns:

the call builder instance

metadata

public EndpointConfigurations.CreateCallBuilder metadata(String metadata)

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

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

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

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

Parameters:

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

Returns:

the call builder instance

circuitBreaker

public EndpointConfigurations.CreateCallBuilder circuitBreaker(EndpointCircuitBreaker circuitBreaker)

circuit breaker module configuration or null

Parameters:

circuitBreaker - the value of the circuit_breaker parameter as a EndpointCircuitBreaker

Returns:

the call builder instance

circuitBreaker

public EndpointConfigurations.CreateCallBuilder circuitBreaker(Optional<EndpointCircuitBreaker> circuitBreaker)

circuit breaker module configuration or null

Parameters:

circuitBreaker - the value of the circuit_breaker parameter as an Optional of EndpointCircuitBreaker

Returns:

the call builder instance

compression

public EndpointConfigurations.CreateCallBuilder compression(EndpointCompression compression)

compression module configuration or null

Parameters:

compression - the value of the compression parameter as a EndpointCompression

Returns:

the call builder instance

compression

public EndpointConfigurations.CreateCallBuilder compression(Optional<EndpointCompression> compression)

compression module configuration or null

Parameters:

compression - the value of the compression parameter as an Optional of EndpointCompression

Returns:

the call builder instance

requestHeaders

public EndpointConfigurations.CreateCallBuilder requestHeaders(EndpointRequestHeaders requestHeaders)

request headers module configuration or null

Parameters:

requestHeaders - the value of the request_headers parameter as a EndpointRequestHeaders

Returns:

the call builder instance

requestHeaders

public EndpointConfigurations.CreateCallBuilder requestHeaders(Optional<EndpointRequestHeaders> requestHeaders)

request headers module configuration or null

Parameters:

requestHeaders - the value of the request_headers parameter as an Optional of EndpointRequestHeaders

Returns:

the call builder instance

responseHeaders

public EndpointConfigurations.CreateCallBuilder responseHeaders(EndpointResponseHeaders responseHeaders)

response headers module configuration or null

Parameters:

responseHeaders - the value of the response_headers parameter as a EndpointResponseHeaders

Returns:

the call builder instance

responseHeaders

public EndpointConfigurations.CreateCallBuilder responseHeaders(Optional<EndpointResponseHeaders> responseHeaders)

response headers module configuration or null

Parameters:

responseHeaders - the value of the response_headers parameter as an Optional of EndpointResponseHeaders

Returns:

the call builder instance

ipPolicy

public EndpointConfigurations.CreateCallBuilder ipPolicy(EndpointIpPolicyMutate ipPolicy)

ip policy module configuration or null

Parameters:

ipPolicy - the value of the ip_policy parameter as a EndpointIpPolicyMutate

Returns:

the call builder instance

ipPolicy

public EndpointConfigurations.CreateCallBuilder ipPolicy(Optional<EndpointIpPolicyMutate> ipPolicy)

ip policy module configuration or null

Parameters:

ipPolicy - the value of the ip_policy parameter as an Optional of EndpointIpPolicyMutate

Returns:

the call builder instance

mutualTls

public EndpointConfigurations.CreateCallBuilder mutualTls(EndpointMutualTlsMutate mutualTls)

mutual TLS module configuration or null

Parameters:

mutualTls - the value of the mutual_tls parameter as a EndpointMutualTlsMutate

Returns:

the call builder instance

mutualTls

public EndpointConfigurations.CreateCallBuilder mutualTls(Optional<EndpointMutualTlsMutate> mutualTls)

mutual TLS module configuration or null

Parameters:

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

Returns:

the call builder instance

tlsTermination

public EndpointConfigurations.CreateCallBuilder tlsTermination(EndpointTlsTermination tlsTermination)

TLS termination module configuration or null

Parameters:

tlsTermination - the value of the tls_termination parameter as a EndpointTlsTermination

Returns:

the call builder instance

tlsTermination

public EndpointConfigurations.CreateCallBuilder tlsTermination(Optional<EndpointTlsTermination> tlsTermination)

TLS termination module configuration or null

Parameters:

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

Returns:

the call builder instance

webhookValidation

public EndpointConfigurations.CreateCallBuilder webhookValidation(EndpointWebhookValidation webhookValidation)

webhook validation module configuration or null

Parameters:

webhookValidation - the value of the webhook_validation parameter as a EndpointWebhookValidation

Returns:

the call builder instance

webhookValidation

public EndpointConfigurations.CreateCallBuilder webhookValidation(Optional<EndpointWebhookValidation> webhookValidation)

webhook validation module configuration or null

Parameters:

webhookValidation - the value of the webhook_validation parameter as an Optional of EndpointWebhookValidation

Returns:

the call builder instance

oauth

public EndpointConfigurations.CreateCallBuilder oauth(EndpointOAuth oauth)

oauth module configuration or null

Parameters:

oauth - the value of the oauth parameter as a EndpointOAuth

Returns:

the call builder instance

oauth

public EndpointConfigurations.CreateCallBuilder oauth(Optional<EndpointOAuth> oauth)

oauth module configuration or null

Parameters:

oauth - the value of the oauth parameter as an Optional of EndpointOAuth

Returns:

the call builder instance

logging

public EndpointConfigurations.CreateCallBuilder logging(EndpointLoggingMutate logging)

logging module configuration or null

Parameters:

logging - the value of the logging parameter as a EndpointLoggingMutate

Returns:

the call builder instance

logging

public EndpointConfigurations.CreateCallBuilder logging(Optional<EndpointLoggingMutate> logging)

logging module configuration or null

Parameters:

logging - the value of the logging parameter as an Optional of EndpointLoggingMutate

Returns:

the call builder instance

saml

public EndpointConfigurations.CreateCallBuilder saml(EndpointSamlMutate saml)

saml module configuration or null

Parameters:

saml - the value of the saml parameter as a EndpointSamlMutate

Returns:

the call builder instance

saml

public EndpointConfigurations.CreateCallBuilder saml(Optional<EndpointSamlMutate> saml)

saml module configuration or null

Parameters:

saml - the value of the saml parameter as an Optional of EndpointSamlMutate

Returns:

the call builder instance

oidc

public EndpointConfigurations.CreateCallBuilder oidc(EndpointOidc oidc)

oidc module configuration or null

Parameters:

oidc - the value of the oidc parameter as a EndpointOidc

Returns:

the call builder instance

oidc

public EndpointConfigurations.CreateCallBuilder oidc(Optional<EndpointOidc> oidc)

oidc module configuration or null

Parameters:

oidc - the value of the oidc parameter as an Optional of EndpointOidc

Returns:

the call builder instance

call

public CompletionStage<EndpointConfiguration> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of EndpointConfiguration

blockingCall

public EndpointConfiguration blockingCall()
                                   throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

EndpointConfiguration

Throws:

InterruptedException - if the thread was interrupted during the call