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

Interface GetKxClusterResponse.Builder

    • Method Detail

      • status

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

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

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

      • status

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

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

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

      • statusReason

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

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

        GetKxClusterResponse.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:
        KxClusterType, KxClusterType

      • clusterType

        GetKxClusterResponse.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:
        KxClusterType, KxClusterType

      • tickerplantLogConfiguration

        GetKxClusterResponse.Builder tickerplantLogConfiguration​(TickerplantLogConfiguration tickerplantLogConfiguration)
        Sets the value of the TickerplantLogConfiguration property for this object.
        Parameters:
        tickerplantLogConfiguration - The new value for the TickerplantLogConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • volumes

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

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

      • databases

        GetKxClusterResponse.Builder databases​(KxDatabaseConfiguration... databases)

        A list of databases mounted on the cluster.

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

      • cacheStorageConfigurations

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

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

      • cacheStorageConfigurations

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

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

      • autoScalingConfiguration

        GetKxClusterResponse.Builder autoScalingConfiguration​(AutoScalingConfiguration autoScalingConfiguration)

        The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

        Parameters:
        autoScalingConfiguration - The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterDescription

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

      • capacityConfiguration

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

        Parameters:
        capacityConfiguration - A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • releaseLabel

        GetKxClusterResponse.Builder releaseLabel​(String releaseLabel)

        The version of FinSpace managed kdb to run.

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

      • vpcConfiguration

        GetKxClusterResponse.Builder vpcConfiguration​(VpcConfiguration vpcConfiguration)

        Configuration details about the network where the Privatelink endpoint of the cluster resides.

        Parameters:
        vpcConfiguration - Configuration details about the network where the Privatelink endpoint of the cluster resides.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • initializationScript

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

      • commandLineArguments

        GetKxClusterResponse.Builder commandLineArguments​(Collection<KxCommandLineArgument> commandLineArguments)

        Defines key-value pairs to make them available inside the cluster.

        Parameters:
        commandLineArguments - Defines key-value pairs to make them available inside the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • commandLineArguments

        GetKxClusterResponse.Builder commandLineArguments​(KxCommandLineArgument... commandLineArguments)

        Defines key-value pairs to make them available inside the cluster.

        Parameters:
        commandLineArguments - Defines key-value pairs to make them available inside the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • code

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

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

      • executionRole

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

      • lastModifiedTimestamp

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

      • savedownStorageConfiguration

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

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

      • azMode

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

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

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

      • azMode

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

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

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

      • availabilityZoneId

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

      • createdTimestamp

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

      • scalingGroupConfiguration

        GetKxClusterResponse.Builder scalingGroupConfiguration​(KxScalingGroupConfiguration scalingGroupConfiguration)
        Sets the value of the ScalingGroupConfiguration property for this object.
        Parameters:
        scalingGroupConfiguration - The new value for the ScalingGroupConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.