Package com.ngrok.services

Class EndpointConfigurations.UpdateCallBuilder

java.lang.Object

com.ngrok.services.EndpointConfigurations.UpdateCallBuilder

Enclosing class:

EndpointConfigurations

public class EndpointConfigurations.UpdateCallBuilder
extends Object

A builder object encapsulating state for an unsent Update 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.UpdateCallBuilder	circuitBreaker(EndpointCircuitBreaker circuitBreaker)	circuit breaker module configuration or null
EndpointConfigurations.UpdateCallBuilder	circuitBreaker(Optional<EndpointCircuitBreaker> circuitBreaker)	circuit breaker module configuration or null
EndpointConfigurations.UpdateCallBuilder	compression(EndpointCompression compression)	compression module configuration or null
EndpointConfigurations.UpdateCallBuilder	compression(Optional<EndpointCompression> compression)	compression module configuration or null
EndpointConfigurations.UpdateCallBuilder	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.UpdateCallBuilder	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.UpdateCallBuilder	ipPolicy(EndpointIpPolicyMutate ipPolicy)	ip policy module configuration or null
EndpointConfigurations.UpdateCallBuilder	ipPolicy(Optional<EndpointIpPolicyMutate> ipPolicy)	ip policy module configuration or null
EndpointConfigurations.UpdateCallBuilder	logging(EndpointLoggingMutate logging)	logging module configuration or null
EndpointConfigurations.UpdateCallBuilder	logging(Optional<EndpointLoggingMutate> logging)	logging module configuration or null
EndpointConfigurations.UpdateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this endpoint configuration.
EndpointConfigurations.UpdateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined machine-readable data of this endpoint configuration.
EndpointConfigurations.UpdateCallBuilder	mutualTls(EndpointMutualTlsMutate mutualTls)	mutual TLS module configuration or null
EndpointConfigurations.UpdateCallBuilder	mutualTls(Optional<EndpointMutualTlsMutate> mutualTls)	mutual TLS module configuration or null
EndpointConfigurations.UpdateCallBuilder	oauth(EndpointOAuth oauth)	oauth module configuration or null
EndpointConfigurations.UpdateCallBuilder	oauth(Optional<EndpointOAuth> oauth)	oauth module configuration or null
EndpointConfigurations.UpdateCallBuilder	oidc(EndpointOidc oidc)	oidc module configuration or null
EndpointConfigurations.UpdateCallBuilder	oidc(Optional<EndpointOidc> oidc)	oidc module configuration or null
EndpointConfigurations.UpdateCallBuilder	requestHeaders(EndpointRequestHeaders requestHeaders)	request headers module configuration or null
EndpointConfigurations.UpdateCallBuilder	requestHeaders(Optional<EndpointRequestHeaders> requestHeaders)	request headers module configuration or null
EndpointConfigurations.UpdateCallBuilder	responseHeaders(EndpointResponseHeaders responseHeaders)	response headers module configuration or null
EndpointConfigurations.UpdateCallBuilder	responseHeaders(Optional<EndpointResponseHeaders> responseHeaders)	response headers module configuration or null
EndpointConfigurations.UpdateCallBuilder	saml(EndpointSamlMutate saml)	saml module configuration or null
EndpointConfigurations.UpdateCallBuilder	saml(Optional<EndpointSamlMutate> saml)	saml module configuration or null
EndpointConfigurations.UpdateCallBuilder	tlsTermination(EndpointTlsTermination tlsTermination)	TLS termination module configuration or null
EndpointConfigurations.UpdateCallBuilder	tlsTermination(Optional<EndpointTlsTermination> tlsTermination)	TLS termination module configuration or null
EndpointConfigurations.UpdateCallBuilder	webhookValidation(EndpointWebhookValidation webhookValidation)	webhook validation module configuration or null
EndpointConfigurations.UpdateCallBuilder	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

description

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