Package software.amazon.awssdk.services.finspace.model

Class KxCluster

java.lang.Object

software.amazon.awssdk.services.finspace.model.KxCluster

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KxCluster.Builder,KxCluster>

@Generated("software.amazon.awssdk:codegen")
public final class KxCluster
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KxCluster.Builder,KxCluster>

The details of a kdb cluster.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KxCluster.Builder

Method Summary

Modifier and Type	Method	Description
final String	availabilityZoneId()	The availability zone identifiers for the requested regions.
final KxAzMode	azMode()	The number of availability zones assigned per cluster.
final String	azModeAsString()	The number of availability zones assigned per cluster.
static KxCluster.Builder	builder()
final String	clusterDescription()	A description of the cluster.
final String	clusterName()	A unique name for the cluster.
final KxClusterType	clusterType()	Specifies the type of KDB database that is being created.
final String	clusterTypeAsString()	Specifies the type of KDB database that is being created.
final Instant	createdTimestamp()	The timestamp at which the cluster was created in FinSpace.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final String	executionRole()	An IAM role that defines a set of permissions associated with a cluster.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	initializationScript()	Specifies a Q program that will be run at launch of a cluster.
final Instant	lastModifiedTimestamp()	The last time that the cluster was modified.
final String	releaseLabel()	A version of the FinSpace managed kdb to run.
final List<SdkField<?>>	sdkFields()
static Class<? extends KxCluster.Builder>	serializableBuilderClass()
final KxClusterStatus	status()	The status of a cluster.
final String	statusAsString()	The status of a cluster.
final String	statusReason()	The error message when a failed state occurs.
KxCluster.Builder	toBuilder()	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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

status

public final KxClusterStatus status()

The status of a cluster.

• 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 return KxClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of a cluster.

• 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:

• KxClusterStatus

statusAsString

public final String statusAsString()

The status of a cluster.

• 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 return KxClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of a cluster.

• 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:

• KxClusterStatus

statusReason

public final String statusReason()

The error message when a failed state occurs.

Returns:

The error message when a failed state occurs.

clusterName

public final String clusterName()

A unique name for the cluster.

Returns:

A unique name for the cluster.

clusterType

public final 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.

If the service returns an enum value that is not available in the current SDK version, clusterType will return KxClusterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterTypeAsString().

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.

See Also:

• KxClusterType

clusterTypeAsString

public final String 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.

If the service returns an enum value that is not available in the current SDK version, clusterType will return KxClusterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterTypeAsString().

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.

See Also:

• KxClusterType

clusterDescription

public final String clusterDescription()

A description of the cluster.

Returns:

A description of the cluster.

releaseLabel

public final String releaseLabel()

A version of the FinSpace managed kdb to run.

Returns:

A version of the FinSpace managed kdb to run.

initializationScript

public final 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.

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.

executionRole

public final 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.

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.

azMode

public final KxAzMode azMode()

The number of availability zones assigned 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 return KxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().

Returns:

The number of availability zones assigned 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:

• KxAzMode

azModeAsString

public final String azModeAsString()

The number of availability zones assigned 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 return KxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().

Returns:

The number of availability zones assigned 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:

• KxAzMode

availabilityZoneId

public final String availabilityZoneId()

The availability zone identifiers for the requested regions.

Returns:

The availability zone identifiers for the requested regions.

lastModifiedTimestamp

public final 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.

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.

createdTimestamp

public final 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.

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.

toBuilder

public KxCluster.Builder 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 interface ToCopyableBuilder<KxCluster.Builder,KxCluster>

Returns:

a builder for type T

builder

public static KxCluster.Builder builder()

serializableBuilderClass

public static Class<? extends KxCluster.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.