software.amazon.awssdk.services.cognitoidentityprovider.model

Interface ContextDataType.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ContextDataType.Builder,ContextDataType>, SdkBuilder<ContextDataType.Builder,ContextDataType>, SdkPojo

Enclosing class:

ContextDataType

public static interface ContextDataType.Builder
extends SdkPojo, CopyableBuilder<ContextDataType.Builder,ContextDataType>

Method Summary

Modifier and Type	Method and Description
ContextDataType.Builder	encodedData(String encodedData) Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library.
ContextDataType.Builder	httpHeaders(Collection<HttpHeader> httpHeaders) HttpHeaders received on your server in same order.
ContextDataType.Builder	httpHeaders(Consumer<HttpHeader.Builder>... httpHeaders) HttpHeaders received on your server in same order.
ContextDataType.Builder	httpHeaders(HttpHeader... httpHeaders) HttpHeaders received on your server in same order.
ContextDataType.Builder	ipAddress(String ipAddress) The source IP address of your user's device.
ContextDataType.Builder	serverName(String serverName) Your server endpoint where this API is invoked.
ContextDataType.Builder	serverPath(String serverPath) Your server path where this API is invoked.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

ipAddress

ContextDataType.Builder ipAddress(String ipAddress)

The source IP address of your user's device.

Parameters:

ipAddress - The source IP address of your user's device.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverName

ContextDataType.Builder serverName(String serverName)

Your server endpoint where this API is invoked.

Parameters:

serverName - Your server endpoint where this API is invoked.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverPath

ContextDataType.Builder serverPath(String serverPath)

Your server path where this API is invoked.

Parameters:

serverPath - Your server path where this API is invoked.

Returns:

Returns a reference to this object so that method calls can be chained together.

httpHeaders

ContextDataType.Builder httpHeaders(Collection<HttpHeader> httpHeaders)

HttpHeaders received on your server in same order.

Parameters:

httpHeaders - HttpHeaders received on your server in same order.

Returns:

Returns a reference to this object so that method calls can be chained together.

httpHeaders

ContextDataType.Builder httpHeaders(HttpHeader... httpHeaders)

HttpHeaders received on your server in same order.

Parameters:

httpHeaders - HttpHeaders received on your server in same order.

Returns:

Returns a reference to this object so that method calls can be chained together.

httpHeaders

ContextDataType.Builder httpHeaders(Consumer<HttpHeader.Builder>... httpHeaders)

HttpHeaders received on your server in same order.

This is a convenience method that creates an instance of the HttpHeader.Builder avoiding the need to create one manually via HttpHeader.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #httpHeaders(List).

Parameters:

httpHeaders - a consumer that will call methods on HttpHeader.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#httpHeaders(java.util.Collection)

encodedData

ContextDataType.Builder encodedData(String encodedData)

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

Parameters:

encodedData - Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

Returns:

Returns a reference to this object so that method calls can be chained together.