Package com.ngrok.definitions

Class EndpointConfiguration

java.lang.Object

com.ngrok.definitions.EndpointConfiguration

public class EndpointConfiguration
extends Object

A class encapsulating the EndpointConfiguration resource.

Constructor Summary

Constructors

Constructor

Description

EndpointConfiguration(String id, String type, String description, String metadata, OffsetDateTime createdAt, URI uri, Optional<EndpointCircuitBreaker> circuitBreaker, Optional<EndpointCompression> compression, Optional<EndpointRequestHeaders> requestHeaders, Optional<EndpointResponseHeaders> responseHeaders, Optional<EndpointIpPolicy> ipPolicy, Optional<EndpointMutualTls> mutualTls, Optional<EndpointTlsTermination> tlsTermination, Optional<EndpointWebhookValidation> webhookValidation, Optional<EndpointOAuth> oauth, Optional<EndpointLogging> logging, Optional<EndpointSaml> saml, Optional<EndpointOidc> oidc)

Creates a new instance of EndpointConfiguration.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Optional<EndpointCircuitBreaker>	getCircuitBreaker()	circuit breaker module configuration or null
Optional<EndpointCompression>	getCompression()	compression module configuration or null
OffsetDateTime	getCreatedAt()	timestamp when the endpoint configuration was created, RFC 3339 format
String	getDescription()	human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to.
String	getId()	unique identifier of this endpoint configuration
Optional<EndpointIpPolicy>	getIpPolicy()	ip policy module configuration or null
Optional<EndpointLogging>	getLogging()	logging module configuration or null
String	getMetadata()	arbitrary user-defined machine-readable data of this endpoint configuration.
Optional<EndpointMutualTls>	getMutualTls()	mutual TLS module configuration or null
Optional<EndpointOAuth>	getOauth()	oauth module configuration or null
Optional<EndpointOidc>	getOidc()	oidc module configuration or null
Optional<EndpointRequestHeaders>	getRequestHeaders()	request headers module configuration or null
Optional<EndpointResponseHeaders>	getResponseHeaders()	response headers module configuration or null
Optional<EndpointSaml>	getSaml()	saml module configuration or null
Optional<EndpointTlsTermination>	getTlsTermination()	TLS termination module configuration or null
String	getType()	they type of traffic this endpoint configuration can be applied to.
URI	getUri()	URI of the endpoint configuration API resource
Optional<EndpointWebhookValidation>	getWebhookValidation()	webhook validation module configuration or null
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EndpointConfiguration

public EndpointConfiguration(String id,
 String type,
 String description,
 String metadata,
 OffsetDateTime createdAt,
 URI uri,
 Optional<EndpointCircuitBreaker> circuitBreaker,
 Optional<EndpointCompression> compression,
 Optional<EndpointRequestHeaders> requestHeaders,
 Optional<EndpointResponseHeaders> responseHeaders,
 Optional<EndpointIpPolicy> ipPolicy,
 Optional<EndpointMutualTls> mutualTls,
 Optional<EndpointTlsTermination> tlsTermination,
 Optional<EndpointWebhookValidation> webhookValidation,
 Optional<EndpointOAuth> oauth,
 Optional<EndpointLogging> logging,
 Optional<EndpointSaml> saml,
 Optional<EndpointOidc> oidc)

Creates a new instance of EndpointConfiguration.

Parameters:

id - unique identifier of this endpoint configuration

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

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

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

createdAt - timestamp when the endpoint configuration was created, RFC 3339 format

uri - URI of the endpoint configuration API resource

circuitBreaker - circuit breaker module configuration or null

compression - compression module configuration or null

requestHeaders - request headers module configuration or null

responseHeaders - response headers module configuration or null

ipPolicy - ip policy module configuration or null

mutualTls - mutual TLS module configuration or null

tlsTermination - TLS termination module configuration or null

webhookValidation - webhook validation module configuration or null

oauth - oauth module configuration or null

logging - logging module configuration or null

saml - saml module configuration or null

oidc - oidc module configuration or null

Method Details

getId

public String getId()

unique identifier of this endpoint configuration

Returns:

the value of the property as a String

getType

public String getType()

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

Returns:

the value of the property as a String

getDescription

public String getDescription()

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

Returns:

the value of the property as a String

getMetadata

public String getMetadata()

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

Returns:

the value of the property as a String

getCreatedAt

public OffsetDateTime getCreatedAt()

timestamp when the endpoint configuration was created, RFC 3339 format

Returns:

the value of the property as a OffsetDateTime

getUri

public URI getUri()

URI of the endpoint configuration API resource

Returns:

the value of the property as a URI

getCircuitBreaker

public Optional<EndpointCircuitBreaker> getCircuitBreaker()

circuit breaker module configuration or null

Returns:

the value of the property as a EndpointCircuitBreaker wrapped in an Optional

getCompression

public Optional<EndpointCompression> getCompression()

compression module configuration or null

Returns:

the value of the property as a EndpointCompression wrapped in an Optional

getRequestHeaders

public Optional<EndpointRequestHeaders> getRequestHeaders()

request headers module configuration or null

Returns:

the value of the property as a EndpointRequestHeaders wrapped in an Optional

getResponseHeaders

public Optional<EndpointResponseHeaders> getResponseHeaders()

response headers module configuration or null

Returns:

the value of the property as a EndpointResponseHeaders wrapped in an Optional

getIpPolicy

public Optional<EndpointIpPolicy> getIpPolicy()

ip policy module configuration or null

Returns:

the value of the property as a EndpointIpPolicy wrapped in an Optional

getMutualTls

public Optional<EndpointMutualTls> getMutualTls()

mutual TLS module configuration or null

Returns:

the value of the property as a EndpointMutualTls wrapped in an Optional

getTlsTermination

public Optional<EndpointTlsTermination> getTlsTermination()

TLS termination module configuration or null

Returns:

the value of the property as a EndpointTlsTermination wrapped in an Optional

getWebhookValidation

public Optional<EndpointWebhookValidation> getWebhookValidation()

webhook validation module configuration or null

Returns:

the value of the property as a EndpointWebhookValidation wrapped in an Optional

getOauth

public Optional<EndpointOAuth> getOauth()

oauth module configuration or null

Returns:

the value of the property as a EndpointOAuth wrapped in an Optional

getLogging

public Optional<EndpointLogging> getLogging()

logging module configuration or null

Returns:

the value of the property as a EndpointLogging wrapped in an Optional

getSaml

public Optional<EndpointSaml> getSaml()

saml module configuration or null

Returns:

the value of the property as a EndpointSaml wrapped in an Optional

getOidc

public Optional<EndpointOidc> getOidc()

oidc module configuration or null

Returns:

the value of the property as a EndpointOidc wrapped in an Optional

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object