Interface KxCluster.Builder

All Superinterfaces:
Buildable, CopyableBuilder<KxCluster.Builder,KxCluster>, SdkBuilder<KxCluster.Builder,KxCluster>, SdkPojo
Enclosing class:
KxCluster
public static interface KxCluster.Builder extends SdkPojo, CopyableBuilder<KxCluster.Builder,KxCluster>

  • Method Details

    • status

      KxCluster.Builder status(String 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.

      Parameters:
      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.

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

    • status

      KxCluster.Builder status(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.

      Parameters:
      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.

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

    • statusReason

      KxCluster.Builder statusReason(String statusReason)

      The error message when a failed state occurs.

      Parameters:
      statusReason - The error message when a failed state occurs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterName

      KxCluster.Builder clusterName(String clusterName)

      A unique name for the cluster.

      Parameters:
      clusterName - A unique name for the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterType

      KxCluster.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.

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

      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.

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

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

    • clusterType

      KxCluster.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.

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

      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.

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

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

    • clusterDescription

      KxCluster.Builder clusterDescription(String clusterDescription)

      A description of the cluster.

      Parameters:
      clusterDescription - A description of the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • releaseLabel

      KxCluster.Builder releaseLabel(String releaseLabel)

      A version of the FinSpace managed kdb to run.

      Parameters:
      releaseLabel - A version of the FinSpace managed kdb to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

      KxCluster.Builder volumes(Collection<Volume> volumes)

      A list of volumes attached to the cluster.

      Parameters:
      volumes - A list of volumes attached to the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

      KxCluster.Builder volumes(Volume... volumes)

      A list of volumes attached to the cluster.

      Parameters:
      volumes - A list of volumes attached to the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumes

      KxCluster.Builder volumes(Consumer<Volume.Builder>... volumes)

      A list of volumes attached to the cluster.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to volumes(List<Volume>).

      Parameters:
      volumes - a consumer that will call methods on Volume.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • initializationScript

      KxCluster.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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • executionRole

      KxCluster.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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • azMode

      KxCluster.Builder azMode(String 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.

      Parameters:
      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.

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

    • azMode

      KxCluster.Builder azMode(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.

      Parameters:
      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.

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

    • availabilityZoneId

      KxCluster.Builder availabilityZoneId(String availabilityZoneId)

      The availability zone identifiers for the requested regions.

      Parameters:
      availabilityZoneId - The availability zone identifiers for the requested regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTimestamp

      KxCluster.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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • createdTimestamp

      KxCluster.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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.