software.amazon.awssdk.services.finspace.model

Interface ListKxClustersRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListKxClustersRequest.Builder,ListKxClustersRequest>, FinspaceRequest.Builder, SdkBuilder<ListKxClustersRequest.Builder,ListKxClustersRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListKxClustersRequest

public static interface ListKxClustersRequest.Builder
extends FinspaceRequest.Builder, SdkPojo, CopyableBuilder<ListKxClustersRequest.Builder,ListKxClustersRequest>

Method Summary

Modifier and Type	Method and Description
ListKxClustersRequest.Builder	clusterType(KxClusterType clusterType) Specifies the type of KDB database that is being created.
ListKxClustersRequest.Builder	clusterType(String clusterType) Specifies the type of KDB database that is being created.
ListKxClustersRequest.Builder	environmentId(String environmentId) A unique identifier for the kdb environment.
ListKxClustersRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return in this request.
ListKxClustersRequest.Builder	nextToken(String nextToken) A token that indicates where a results page should begin.
ListKxClustersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListKxClustersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.finspace.model.FinspaceRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

environmentId

ListKxClustersRequest.Builder environmentId(String environmentId)

A unique identifier for the kdb environment.

Parameters:

environmentId - A unique identifier for the kdb environment.

Returns:

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

clusterType

ListKxClustersRequest.Builder clusterType(String clusterType)

Specifies the type of KDB database that is being created. The following types are available:

• HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

• RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

• GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

Parameters:

clusterType - Specifies the type of KDB database that is being created. The following types are available:

• HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

• RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

• GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

Returns:

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

See Also:

KxClusterType, KxClusterType

clusterType

ListKxClustersRequest.Builder clusterType(KxClusterType clusterType)

Specifies the type of KDB database that is being created. The following types are available:

• HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

• RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

• GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

Parameters:

clusterType - Specifies the type of KDB database that is being created. The following types are available:

• HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.

• RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.

• GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.

Returns:

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

See Also:

KxClusterType, KxClusterType

maxResults

ListKxClustersRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in this request.

Parameters:

maxResults - The maximum number of results to return in this request.

Returns:

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

nextToken

ListKxClustersRequest.Builder nextToken(String nextToken)

A token that indicates where a results page should begin.

Parameters:

nextToken - A token that indicates where a results page should begin.

Returns:

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

overrideConfiguration

ListKxClustersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListKxClustersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder