Package com.ngrok.definitions

Class EndpointResponseHeaders.Builder

java.lang.Object

com.ngrok.definitions.EndpointResponseHeaders.Builder

Enclosing class:

EndpointResponseHeaders

public static class EndpointResponseHeaders.Builder
extends Object

Builder class for EndpointResponseHeaders.

Method Summary

Modifier and Type	Method	Description
EndpointResponseHeaders.Builder	add(Map<String,String> add)	a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
EndpointResponseHeaders.Builder	add(Optional<Map<String,String>> add)	a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
EndpointResponseHeaders	build()	Constructs the EndpointResponseHeaders instance.
EndpointResponseHeaders.Builder	enabled(boolean enabled)	true if the module will be applied to traffic, false to disable.
EndpointResponseHeaders.Builder	enabled(Optional<Boolean> enabled)	true if the module will be applied to traffic, false to disable.
EndpointResponseHeaders.Builder	remove(List<String> remove)	a list of header names that will be removed from the HTTP Response returned to the HTTP client
EndpointResponseHeaders.Builder	remove(Optional<List<String>> remove)	a list of header names that will be removed from the HTTP Response returned to the HTTP client

Methods inherited from class java.lang.Object

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

Method Details

enabled

public EndpointResponseHeaders.Builder enabled(boolean enabled)

true if the module will be applied to traffic, false to disable. default true if unspecified

Parameters:

enabled - the value of the enabled parameter as a boolean

Returns:

this builder instance

enabled

public EndpointResponseHeaders.Builder enabled(Optional<Boolean> enabled)

true if the module will be applied to traffic, false to disable. default true if unspecified

Parameters:

enabled - the value of the enabled parameter as a boolean, wrapped in an Optional

Returns:

this builder instance

add

public EndpointResponseHeaders.Builder add(Map<String,String> add)

a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client

Parameters:

add - the value of the add parameter as a Map of String to String

Returns:

this builder instance

add

public EndpointResponseHeaders.Builder add(Optional<Map<String,String>> add)

a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client

Parameters:

add - the value of the add parameter as a Map of String to String, wrapped in an Optional

Returns:

this builder instance

remove

public EndpointResponseHeaders.Builder remove(List<String> remove)

a list of header names that will be removed from the HTTP Response returned to the HTTP client

Parameters:

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

Returns:

this builder instance

remove

public EndpointResponseHeaders.Builder remove(Optional<List<String>> remove)

a list of header names that will be removed from the HTTP Response returned to the HTTP client

Parameters:

remove - the value of the remove parameter as a List of String, wrapped in an Optional

Returns:

this builder instance

build

public EndpointResponseHeaders build()

Constructs the EndpointResponseHeaders instance.

Returns:

a new EndpointResponseHeaders