Class CreateKxClusterResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateKxClusterResponse.Builder,
CreateKxClusterResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AutoScalingConfiguration
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.final String
The availability zone identifiers for the requested regions.final KxAzMode
azMode()
The number of availability zones you want to assign per cluster.final String
The number of availability zones you want to assign per cluster.builder()
final List
<KxCacheStorageConfiguration> The configurations for a read only cache storage associated with a cluster.final CapacityConfiguration
A structure for the metadata of a cluster.final String
A description of the cluster.final String
A unique name for the cluster.final KxClusterType
Specifies the type of KDB database that is being created.final String
Specifies the type of KDB database that is being created.final CodeConfiguration
code()
The details of the custom code that you want to use inside a cluster when analyzing a data.final List
<KxCommandLineArgument> Defines the key-value pairs to make them available inside the cluster.final Instant
The timestamp at which the cluster was created in FinSpace.final List
<KxDatabaseConfiguration> A list of databases that will be available for querying.final String
A unique identifier for the kdb environment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
An IAM role that defines a set of permissions associated with a cluster.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the CacheStorageConfigurations property.final boolean
For responses, this returns true if the service returned a value for the CommandLineArguments property.final boolean
For responses, this returns true if the service returned a value for the Databases property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Volumes property.final String
Specifies a Q program that will be run at launch of a cluster.final Instant
The last time that the cluster was modified.final String
A version of the FinSpace managed kdb to run.The size and type of the temporary storage that is used to hold data during the savedown process.The structure that stores the configuration details of a scaling group.static Class
<? extends CreateKxClusterResponse.Builder> final KxClusterStatus
status()
The status of cluster creation.final String
The status of cluster creation.final String
The error message when a failed state occurs.Returns the value of the TickerplantLogConfiguration property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.volumes()
A list of volumes mounted on the cluster.final VpcConfiguration
Configuration details about the network where the Privatelink endpoint of the cluster resides.Methods inherited from class software.amazon.awssdk.services.finspace.model.FinspaceResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
environmentId
A unique identifier for the kdb environment.
- Returns:
- A unique identifier for the kdb environment.
-
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.
If the service returns an enum value that is not available in the current SDK version,
status
will returnKxClusterStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
statusAsString
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.
If the service returns an enum value that is not available in the current SDK version,
status
will returnKxClusterStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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.
-
- See Also:
-
-
statusReason
The error message when a failed state occurs.
- Returns:
- The error message when a failed state occurs.
-
clusterName
A unique name for the cluster.
- Returns:
- A unique name for the cluster.
-
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.
-
GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only
SINGLE
AZ mode. -
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
If the service returns an enum value that is not available in the current SDK version,
clusterType
will returnKxClusterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclusterTypeAsString()
.- Returns:
- 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.
-
GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only
SINGLE
AZ mode. -
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
-
- See Also:
-
-
clusterTypeAsString
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.
-
GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only
SINGLE
AZ mode. -
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
If the service returns an enum value that is not available in the current SDK version,
clusterType
will returnKxClusterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromclusterTypeAsString()
.- Returns:
- 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.
-
GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only
SINGLE
AZ mode. -
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
-
- See Also:
-
-
tickerplantLogConfiguration
Returns the value of the TickerplantLogConfiguration property for this object.- Returns:
- The value of the TickerplantLogConfiguration property for this object.
-
hasVolumes
public final boolean hasVolumes()For responses, this returns true if the service returned a value for the Volumes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
volumes
A list of volumes mounted on the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVolumes()
method.- Returns:
- A list of volumes mounted on the cluster.
-
hasDatabases
public final boolean hasDatabases()For responses, this returns true if the service returned a value for the Databases property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
databases
A list of databases that will be available for querying.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDatabases()
method.- Returns:
- A list of databases that will be available for querying.
-
hasCacheStorageConfigurations
public final boolean hasCacheStorageConfigurations()For responses, this returns true if the service returned a value for the CacheStorageConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCacheStorageConfigurations()
method.- Returns:
- 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.
-
autoScalingConfiguration
The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
- Returns:
- The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
-
clusterDescription
A description of the cluster.
- Returns:
- A description of the cluster.
-
capacityConfiguration
A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
- Returns:
- A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
-
releaseLabel
A version of the FinSpace managed kdb to run.
- Returns:
- A version of the FinSpace managed kdb to run.
-
vpcConfiguration
Configuration details about the network where the Privatelink endpoint of the cluster resides.
- Returns:
- Configuration details about the network where the Privatelink endpoint of the cluster resides.
-
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
.- Returns:
- 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
.
-
hasCommandLineArguments
public final boolean hasCommandLineArguments()For responses, this returns true if the service returned a value for the CommandLineArguments property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
commandLineArguments
Defines the key-value pairs to make them available inside the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCommandLineArguments()
method.- Returns:
- Defines the key-value pairs to make them available inside 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.
- Returns:
- 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.
-
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.
- Returns:
- 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.
-
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.
- Returns:
- 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.
-
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.- Returns:
- 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.
-
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.
If the service returns an enum value that is not available in the current SDK version,
azMode
will returnKxAzMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromazModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
azModeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
azMode
will returnKxAzMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromazModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
availabilityZoneId
The availability zone identifiers for the requested regions.
- Returns:
- The availability zone identifiers for the requested regions.
-
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.
- Returns:
- 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.
-
scalingGroupConfiguration
The structure that stores the configuration details of a scaling group.
- Returns:
- The structure that stores the configuration details of a scaling group.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateKxClusterResponse.Builder,
CreateKxClusterResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-