Package com.helixframework.resttemplate.metadata

Class HelixMetadataInterceptor.Builder

java.lang.Object

com.helixframework.resttemplate.metadata.HelixMetadataInterceptor.Builder

Enclosing class:

HelixMetadataInterceptor

public static class HelixMetadataInterceptor.Builder
extends Object

Builds instances of HelixMetadataInterceptor.

Method Summary

Modifier and Type	Method	Description
HelixMetadataInterceptor	build()	Builds an instance of HelixMetadataInterceptor.
HelixMetadataInterceptor.Builder	excludeMetadata(String key)	Excludes a metadata key from being passed downstream in the metadata header.
HelixMetadataInterceptor.Builder	excludeMetadata(Collection<String> keys)	Excludes a collection of metadata keys from being passed downstream in the metadata header.
HelixMetadataInterceptor.Builder	headerName(String headerName)	Sets the name of the metadata header to pass downstream.
HelixMetadataInterceptor.Builder	includeMetadata(String key)	Adds a metadata key to include in the downstream metadata header.
HelixMetadataInterceptor.Builder	includeMetadata(Collection<String> keys)	Adds a collection of metadata keys to include in the downstream metadata header.

Methods inherited from class java.lang.Object

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

Method Details

headerName

public HelixMetadataInterceptor.Builder headerName(String headerName)

Sets the name of the metadata header to pass downstream. Defaults to `X-Metadata`.

Parameters:

headerName - name of header

Returns:

this HelixMetadataInterceptor.Builder

includeMetadata

public HelixMetadataInterceptor.Builder includeMetadata(String key)

Adds a metadata key to include in the downstream metadata header.

Parameters:

key - metadata key

Returns:

this HelixMetadataInterceptor.Builder

includeMetadata

public HelixMetadataInterceptor.Builder includeMetadata(Collection<String> keys)

Adds a collection of metadata keys to include in the downstream metadata header.

Parameters:

keys - metadata keys

Returns:

this HelixMetadataInterceptor.Builder

excludeMetadata

public HelixMetadataInterceptor.Builder excludeMetadata(String key)

Excludes a metadata key from being passed downstream in the metadata header.

Parameters:

key - metadata key

Returns:

this HelixMetadataInterceptor.Builder

excludeMetadata

public HelixMetadataInterceptor.Builder excludeMetadata(Collection<String> keys)

Excludes a collection of metadata keys from being passed downstream in the metadata header.

Parameters:

keys - metadata keys

Returns:

this HelixMetadataInterceptor.Builder

build

public HelixMetadataInterceptor build()

Builds an instance of HelixMetadataInterceptor.

Returns:

a HelixMetadataInterceptor