kontent.ai.delivery

Class DeliveryOptions.DeliveryOptionsBuilder

java.lang.Object

kontent.ai.delivery.DeliveryOptions.DeliveryOptionsBuilder

Enclosing class:

DeliveryOptions

public static class DeliveryOptions.DeliveryOptionsBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
DeliveryOptions	build()
DeliveryOptions.DeliveryOptionsBuilder	customHeaders(java.util.List<Header> customHeaders) Include custom request headers.
DeliveryOptions.DeliveryOptionsBuilder	previewApiKey(java.lang.String previewApiKey) The Preview API key configured with your Kontent.ai account.
DeliveryOptions.DeliveryOptionsBuilder	previewEndpoint(java.lang.String previewEndpoint) The Preview endpoint address.
DeliveryOptions.DeliveryOptionsBuilder	productionApiKey(java.lang.String productionApiKey) The Production API key (Secured access API key) configured with your Kontent.ai account.
DeliveryOptions.DeliveryOptionsBuilder	productionEndpoint(java.lang.String productionEndpoint) The Production endpoint address.
DeliveryOptions.DeliveryOptionsBuilder	projectId(java.lang.String projectId) The Project ID associated with your Kontent.ai account.
DeliveryOptions.DeliveryOptionsBuilder	proxyServer(java.net.Proxy proxyServer) Sets the proxy server used by the http client.
DeliveryOptions.DeliveryOptionsBuilder	retryAttempts(int retryAttempts) Sets the number of retry attempts the client should make when a request to the API fails.
java.lang.String	toString()
DeliveryOptions.DeliveryOptionsBuilder	usePreviewApi(boolean usePreviewApi) This boolean flag determines if this client will use the preview API instead of the production API.
DeliveryOptions.DeliveryOptionsBuilder	waitForLoadingNewContent(boolean waitForLoadingNewContent) If the requested content has changed since the last request, the header determines whether to wait while fetching content.

Methods inherited from class java.lang.Object

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

Method Detail

productionEndpoint

public DeliveryOptions.DeliveryOptionsBuilder productionEndpoint(java.lang.String productionEndpoint)

The Production endpoint address. Mainly useful to change for mocks in unit tests, or if you are establishing a proxy.

This defaults to "https://deliver.kontent.ai"

Parameters:

productionEndpoint - New value for the productionEndpoint in this DeliveryOptions instance. Kontent.

Returns:

this.

See Also:

Kontent.ai API reference - Production vs. preview, Formatter

previewEndpoint

public DeliveryOptions.DeliveryOptionsBuilder previewEndpoint(java.lang.String previewEndpoint)

The Preview endpoint address. Mainly useful to change for mocks in unit tests, or if you are establishing a proxy.

This defaults to "https://assets-us-01.kc-usercontent.com/"

Parameters:

previewEndpoint - New value for the productionEndpoint in this DeliveryOptions instance.

Returns:

this.

See Also:

Kontent.ai API reference - Production vs. preview, Formatter

projectId

public DeliveryOptions.DeliveryOptionsBuilder projectId(java.lang.String projectId)

The Project ID associated with your Kontent.ai account. Must be in the format of an UUID.

Parameters:

projectId - The Project ID associated with your Kontent.ai account. Must be in the format of an UUID.

Returns:

this.

See Also:

Kontent.ai API reference - Delivery API

productionApiKey

public DeliveryOptions.DeliveryOptionsBuilder productionApiKey(java.lang.String productionApiKey)

The Production API key (Secured access API key) configured with your Kontent.ai account.

Parameters:

productionApiKey - Sets the value of the production API key (Secured access API key) in this DeliveryOptions instance.

Returns:

this.

See Also:

Kontent.ai API reference - Production vs. preview, Secure access

previewApiKey

public DeliveryOptions.DeliveryOptionsBuilder previewApiKey(java.lang.String previewApiKey)

The Preview API key configured with your Kontent.ai account.

Returns:

this.

See Also:

Kontent.ai API reference - Production vs. preview, Kontent.ai API reference - Authentication

usePreviewApi

public DeliveryOptions.DeliveryOptionsBuilder usePreviewApi(boolean usePreviewApi)

This boolean flag determines if this client will use the preview API instead of the production API. Defaults to 'false'.

Parameters:

usePreviewApi - Whether the preview API should be used instead of the production API. Defaults to 'false'. production API.

Returns:

this.

See Also:

Kontent.ai API reference - Production vs. preview

waitForLoadingNewContent

public DeliveryOptions.DeliveryOptionsBuilder waitForLoadingNewContent(boolean waitForLoadingNewContent)

If the requested content has changed since the last request, the header determines whether to wait while fetching content. This can be useful when retrieving changed content in reaction to a webhook call. By default, when set to false, the API serves old content (if cached by the CDN) while it's fetching the new content to minimize wait time. To always fetch new content, set the header to true.

Parameters:

waitForLoadingNewContent - New value for this DeliveryOptions instance.

Returns:

this.

retryAttempts

public DeliveryOptions.DeliveryOptionsBuilder retryAttempts(int retryAttempts)

Sets the number of retry attempts the client should make when a request to the API fails. Defaults to 3, meaning 1 normal request + 3 retrials.

Parameters:

retryAttempts - New value for this DeliveryOptions instance.

Returns:

this.

proxyServer

public DeliveryOptions.DeliveryOptionsBuilder proxyServer(java.net.Proxy proxyServer)

Sets the proxy server used by the http client. See Proxy.

Parameters:

proxyServer - The Proxy instance to use with the client each request.

Returns:

this.

customHeaders

public DeliveryOptions.DeliveryOptionsBuilder customHeaders(java.util.List<Header> customHeaders)

Include custom request headers. Headers with name DeliveryClient.HEADER_ACCEPT, DeliveryClient.HEADER_AUTHORIZATION, DeliveryClient.HEADER_X_KC_SDK_ID, DeliveryClient.HEADER_X_KC_WAIT_FOR_LOADING_NEW_CONTENT will be ignored.

Returns:

this.

build

public DeliveryOptions build()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object