public static interface CreateKxClusterResponse.Builder extends FinspaceResponse.Builder, SdkPojo, CopyableBuilder<CreateKxClusterResponse.Builder,CreateKxClusterResponse>
| Modifier and Type | Method and Description |
|---|---|
CreateKxClusterResponse.Builder |
autoScalingConfiguration(AutoScalingConfiguration autoScalingConfiguration)
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
|
default CreateKxClusterResponse.Builder |
autoScalingConfiguration(Consumer<AutoScalingConfiguration.Builder> autoScalingConfiguration)
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
|
CreateKxClusterResponse.Builder |
availabilityZoneId(String availabilityZoneId)
The availability zone identifiers for the requested regions.
|
CreateKxClusterResponse.Builder |
azMode(KxAzMode azMode)
The number of availability zones you want to assign per cluster.
|
CreateKxClusterResponse.Builder |
azMode(String azMode)
The number of availability zones you want to assign per cluster.
|
CreateKxClusterResponse.Builder |
cacheStorageConfigurations(Collection<KxCacheStorageConfiguration> cacheStorageConfigurations)
The configurations for a read only cache storage associated with a cluster.
|
CreateKxClusterResponse.Builder |
cacheStorageConfigurations(Consumer<KxCacheStorageConfiguration.Builder>... cacheStorageConfigurations)
The configurations for a read only cache storage associated with a cluster.
|
CreateKxClusterResponse.Builder |
cacheStorageConfigurations(KxCacheStorageConfiguration... cacheStorageConfigurations)
The configurations for a read only cache storage associated with a cluster.
|
CreateKxClusterResponse.Builder |
capacityConfiguration(CapacityConfiguration capacityConfiguration)
A structure for the metadata of a cluster.
|
default CreateKxClusterResponse.Builder |
capacityConfiguration(Consumer<CapacityConfiguration.Builder> capacityConfiguration)
A structure for the metadata of a cluster.
|
CreateKxClusterResponse.Builder |
clusterDescription(String clusterDescription)
A description of the cluster.
|
CreateKxClusterResponse.Builder |
clusterName(String clusterName)
A unique name for the cluster.
|
CreateKxClusterResponse.Builder |
clusterType(KxClusterType clusterType)
Specifies the type of KDB database that is being created.
|
CreateKxClusterResponse.Builder |
clusterType(String clusterType)
Specifies the type of KDB database that is being created.
|
CreateKxClusterResponse.Builder |
code(CodeConfiguration code)
The details of the custom code that you want to use inside a cluster when analyzing a data.
|
default CreateKxClusterResponse.Builder |
code(Consumer<CodeConfiguration.Builder> code)
The details of the custom code that you want to use inside a cluster when analyzing a data.
|
CreateKxClusterResponse.Builder |
commandLineArguments(Collection<KxCommandLineArgument> commandLineArguments)
Defines the key-value pairs to make them available inside the cluster.
|
CreateKxClusterResponse.Builder |
commandLineArguments(Consumer<KxCommandLineArgument.Builder>... commandLineArguments)
Defines the key-value pairs to make them available inside the cluster.
|
CreateKxClusterResponse.Builder |
commandLineArguments(KxCommandLineArgument... commandLineArguments)
Defines the key-value pairs to make them available inside the cluster.
|
CreateKxClusterResponse.Builder |
createdTimestamp(Instant createdTimestamp)
The timestamp at which the cluster was created in FinSpace.
|
CreateKxClusterResponse.Builder |
databases(Collection<KxDatabaseConfiguration> databases)
A list of databases that will be available for querying.
|
CreateKxClusterResponse.Builder |
databases(Consumer<KxDatabaseConfiguration.Builder>... databases)
A list of databases that will be available for querying.
|
CreateKxClusterResponse.Builder |
databases(KxDatabaseConfiguration... databases)
A list of databases that will be available for querying.
|
CreateKxClusterResponse.Builder |
environmentId(String environmentId)
A unique identifier for the kdb environment.
|
CreateKxClusterResponse.Builder |
executionRole(String executionRole)
An IAM role that defines a set of permissions associated with a cluster.
|
CreateKxClusterResponse.Builder |
initializationScript(String initializationScript)
Specifies a Q program that will be run at launch of a cluster.
|
CreateKxClusterResponse.Builder |
lastModifiedTimestamp(Instant lastModifiedTimestamp)
The last time that the cluster was modified.
|
CreateKxClusterResponse.Builder |
releaseLabel(String releaseLabel)
A version of the FinSpace managed kdb to run.
|
default CreateKxClusterResponse.Builder |
savedownStorageConfiguration(Consumer<KxSavedownStorageConfiguration.Builder> savedownStorageConfiguration)
The size and type of the temporary storage that is used to hold data during the savedown process.
|
CreateKxClusterResponse.Builder |
savedownStorageConfiguration(KxSavedownStorageConfiguration savedownStorageConfiguration)
The size and type of the temporary storage that is used to hold data during the savedown process.
|
CreateKxClusterResponse.Builder |
status(KxClusterStatus status)
The status of cluster creation.
|
CreateKxClusterResponse.Builder |
status(String status)
The status of cluster creation.
|
CreateKxClusterResponse.Builder |
statusReason(String statusReason)
The error message when a failed state occurs.
|
default CreateKxClusterResponse.Builder |
vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)
Configuration details about the network where the Privatelink endpoint of the cluster resides.
|
CreateKxClusterResponse.Builder |
vpcConfiguration(VpcConfiguration vpcConfiguration)
Configuration details about the network where the Privatelink endpoint of the cluster resides.
|
build, responseMetadata, responseMetadatasdkHttpResponse, sdkHttpResponseequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateKxClusterResponse.Builder environmentId(String environmentId)
A unique identifier for the kdb environment.
environmentId - A unique identifier for the kdb environment.CreateKxClusterResponse.Builder status(String status)
The status of cluster creation.
PENDING – The cluster is pending creation.
CREATING – The cluster creation process is in progress.
CREATE_FAILED – The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
status - The status of cluster creation.
PENDING – The cluster is pending creation.
CREATING – The cluster creation process is in progress.
CREATE_FAILED – The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
KxClusterStatus,
KxClusterStatusCreateKxClusterResponse.Builder status(KxClusterStatus status)
The status of cluster creation.
PENDING – The cluster is pending creation.
CREATING – The cluster creation process is in progress.
CREATE_FAILED – The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
status - The status of cluster creation.
PENDING – The cluster is pending creation.
CREATING – The cluster creation process is in progress.
CREATE_FAILED – The cluster creation process has failed.
RUNNING – The cluster creation process is running.
UPDATING – The cluster is in the process of being updated.
DELETING – The cluster is in the process of being deleted.
DELETED – The cluster has been deleted.
DELETE_FAILED – The cluster failed to delete.
KxClusterStatus,
KxClusterStatusCreateKxClusterResponse.Builder statusReason(String statusReason)
The error message when a failed state occurs.
statusReason - The error message when a failed state occurs.CreateKxClusterResponse.Builder clusterName(String clusterName)
A unique name for the cluster.
clusterName - A unique name for the cluster.CreateKxClusterResponse.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.
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.
KxClusterType,
KxClusterTypeCreateKxClusterResponse.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.
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.
KxClusterType,
KxClusterTypeCreateKxClusterResponse.Builder databases(Collection<KxDatabaseConfiguration> databases)
A list of databases that will be available for querying.
databases - A list of databases that will be available for querying.CreateKxClusterResponse.Builder databases(KxDatabaseConfiguration... databases)
A list of databases that will be available for querying.
databases - A list of databases that will be available for querying.CreateKxClusterResponse.Builder databases(Consumer<KxDatabaseConfiguration.Builder>... databases)
A list of databases that will be available for querying.
This is a convenience method that creates an instance of theKxDatabaseConfiguration.Builder avoiding the need to
create one manually via
KxDatabaseConfiguration.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #databases(List.
databases - a consumer that will call methods on
KxDatabaseConfiguration.Builder#databases(java.util.Collection) CreateKxClusterResponse.Builder cacheStorageConfigurations(Collection<KxCacheStorageConfiguration> cacheStorageConfigurations)
The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
cacheStorageConfigurations - The configurations for a read only cache storage associated with a cluster. This cache will be stored
as an FSx Lustre that reads from the S3 store.CreateKxClusterResponse.Builder cacheStorageConfigurations(KxCacheStorageConfiguration... cacheStorageConfigurations)
The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
cacheStorageConfigurations - The configurations for a read only cache storage associated with a cluster. This cache will be stored
as an FSx Lustre that reads from the S3 store.CreateKxClusterResponse.Builder cacheStorageConfigurations(Consumer<KxCacheStorageConfiguration.Builder>... cacheStorageConfigurations)
The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
This is a convenience method that creates an instance of theKxCacheStorageConfiguration.Builder avoiding the need
to create one manually via
KxCacheStorageConfiguration.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #cacheStorageConfigurations(List.
cacheStorageConfigurations - a consumer that will call methods on
KxCacheStorageConfiguration.Builder#cacheStorageConfigurations(java.util.Collection) CreateKxClusterResponse.Builder autoScalingConfiguration(AutoScalingConfiguration autoScalingConfiguration)
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
autoScalingConfiguration - The configuration based on which FinSpace will scale in or scale out nodes in your cluster.default CreateKxClusterResponse.Builder autoScalingConfiguration(Consumer<AutoScalingConfiguration.Builder> autoScalingConfiguration)
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
This is a convenience method that creates an instance of theAutoScalingConfiguration.Builder
avoiding the need to create one manually via AutoScalingConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to autoScalingConfiguration(AutoScalingConfiguration).
autoScalingConfiguration - a consumer that will call methods on AutoScalingConfiguration.BuilderautoScalingConfiguration(AutoScalingConfiguration)CreateKxClusterResponse.Builder clusterDescription(String clusterDescription)
A description of the cluster.
clusterDescription - A description of the cluster.CreateKxClusterResponse.Builder capacityConfiguration(CapacityConfiguration capacityConfiguration)
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
capacityConfiguration - A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of
instances, and number of instances.default CreateKxClusterResponse.Builder capacityConfiguration(Consumer<CapacityConfiguration.Builder> capacityConfiguration)
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
This is a convenience method that creates an instance of theCapacityConfiguration.Builder avoiding
the need to create one manually via CapacityConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to capacityConfiguration(CapacityConfiguration).
capacityConfiguration - a consumer that will call methods on CapacityConfiguration.BuildercapacityConfiguration(CapacityConfiguration)CreateKxClusterResponse.Builder releaseLabel(String releaseLabel)
A version of the FinSpace managed kdb to run.
releaseLabel - A version of the FinSpace managed kdb to run.CreateKxClusterResponse.Builder vpcConfiguration(VpcConfiguration vpcConfiguration)
Configuration details about the network where the Privatelink endpoint of the cluster resides.
vpcConfiguration - Configuration details about the network where the Privatelink endpoint of the cluster resides.default CreateKxClusterResponse.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)
Configuration details about the network where the Privatelink endpoint of the cluster resides.
This is a convenience method that creates an instance of theVpcConfiguration.Builder avoiding the
need to create one manually via VpcConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to vpcConfiguration(VpcConfiguration).
vpcConfiguration - a consumer that will call methods on VpcConfiguration.BuildervpcConfiguration(VpcConfiguration)CreateKxClusterResponse.Builder initializationScript(String initializationScript)
Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file
that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For
example, somedir/init.q.
initializationScript - Specifies a Q program that will be run at launch of a cluster. It is a relative path within
.zip file that contains the custom code, which will be loaded on the cluster. It must include
the file name itself. For example, somedir/init.q.CreateKxClusterResponse.Builder commandLineArguments(Collection<KxCommandLineArgument> commandLineArguments)
Defines the key-value pairs to make them available inside the cluster.
commandLineArguments - Defines the key-value pairs to make them available inside the cluster.CreateKxClusterResponse.Builder commandLineArguments(KxCommandLineArgument... commandLineArguments)
Defines the key-value pairs to make them available inside the cluster.
commandLineArguments - Defines the key-value pairs to make them available inside the cluster.CreateKxClusterResponse.Builder commandLineArguments(Consumer<KxCommandLineArgument.Builder>... commandLineArguments)
Defines the key-value pairs to make them available inside the cluster.
This is a convenience method that creates an instance of theKxCommandLineArgument.Builder avoiding the need to
create one manually via
KxCommandLineArgument.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #commandLineArguments(List.
commandLineArguments - a consumer that will call methods on
KxCommandLineArgument.Builder#commandLineArguments(java.util.Collection) CreateKxClusterResponse.Builder code(CodeConfiguration code)
The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
code - The details of the custom code that you want to use inside a cluster when analyzing a data. It
consists of the S3 source bucket, location, S3 object version, and the relative path from where the
custom code is loaded into the cluster.default CreateKxClusterResponse.Builder code(Consumer<CodeConfiguration.Builder> code)
The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
This is a convenience method that creates an instance of theCodeConfiguration.Builder avoiding the
need to create one manually via CodeConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to code(CodeConfiguration).
code - a consumer that will call methods on CodeConfiguration.Buildercode(CodeConfiguration)CreateKxClusterResponse.Builder executionRole(String executionRole)
An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
executionRole - An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed
when a cluster attempts to access another cluster.CreateKxClusterResponse.Builder lastModifiedTimestamp(Instant lastModifiedTimestamp)
The last time that the cluster was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
lastModifiedTimestamp - The last time that the cluster was modified. The value is determined as epoch time in milliseconds.
For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.CreateKxClusterResponse.Builder savedownStorageConfiguration(KxSavedownStorageConfiguration savedownStorageConfiguration)
The size and type of the temporary storage that is used to hold data during the savedown process. This
parameter is required when you choose clusterType as RDB. All the data written to this storage
space is lost when the cluster node is restarted.
savedownStorageConfiguration - The size and type of the temporary storage that is used to hold data during the savedown process. This
parameter is required when you choose clusterType as RDB. All the data written to this
storage space is lost when the cluster node is restarted.default CreateKxClusterResponse.Builder savedownStorageConfiguration(Consumer<KxSavedownStorageConfiguration.Builder> savedownStorageConfiguration)
The size and type of the temporary storage that is used to hold data during the savedown process. This
parameter is required when you choose clusterType as RDB. All the data written to this storage
space is lost when the cluster node is restarted.
KxSavedownStorageConfiguration.Builder
avoiding the need to create one manually via KxSavedownStorageConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to savedownStorageConfiguration(KxSavedownStorageConfiguration).
savedownStorageConfiguration - a consumer that will call methods on KxSavedownStorageConfiguration.BuildersavedownStorageConfiguration(KxSavedownStorageConfiguration)CreateKxClusterResponse.Builder azMode(String azMode)
The number of availability zones you want to assign per cluster. This can be one of the following
SINGLE – Assigns one availability zone per cluster.
MULTI – Assigns all the availability zones per cluster.
azMode - The number of availability zones you want to assign per cluster. This can be one of the following
SINGLE – Assigns one availability zone per cluster.
MULTI – Assigns all the availability zones per cluster.
KxAzMode,
KxAzModeCreateKxClusterResponse.Builder azMode(KxAzMode azMode)
The number of availability zones you want to assign per cluster. This can be one of the following
SINGLE – Assigns one availability zone per cluster.
MULTI – Assigns all the availability zones per cluster.
azMode - The number of availability zones you want to assign per cluster. This can be one of the following
SINGLE – Assigns one availability zone per cluster.
MULTI – Assigns all the availability zones per cluster.
KxAzMode,
KxAzModeCreateKxClusterResponse.Builder availabilityZoneId(String availabilityZoneId)
The availability zone identifiers for the requested regions.
availabilityZoneId - The availability zone identifiers for the requested regions.CreateKxClusterResponse.Builder createdTimestamp(Instant createdTimestamp)
The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
createdTimestamp - The timestamp at which the cluster was created in FinSpace. The value is determined as epoch time in
milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as
1635768000000.Copyright © 2023. All rights reserved.