All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.finspace.model.ListKxClustersRequest Maven / Gradle / Ivy

Go to download

The AWS Java SDK for FinSpace User Environment Management module holds the client classes that are used for communicating with FinSpace User Environment Management Service

The newest version!
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.finspace.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListKxClustersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * 

* A unique identifier for the kdb environment. *

*/ private String environmentId; /** *

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

    *
  • *
*/ private String clusterType; /** *

* The maximum number of results to return in this request. *

*/ private Integer maxResults; /** *

* A token that indicates where a results page should begin. *

*/ private String nextToken; /** *

* A unique identifier for the kdb environment. *

* * @param environmentId * A unique identifier for the kdb environment. */ public void setEnvironmentId(String environmentId) { this.environmentId = environmentId; } /** *

* A unique identifier for the kdb environment. *

* * @return A unique identifier for the kdb environment. */ public String getEnvironmentId() { return this.environmentId; } /** *

* A unique identifier for the kdb environment. *

* * @param environmentId * A unique identifier for the kdb environment. * @return Returns a reference to this object so that method calls can be chained together. */ public ListKxClustersRequest withEnvironmentId(String environmentId) { setEnvironmentId(environmentId); return this; } /** *

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

    *
  • *
* * @param 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. *

    *
  • * @see KxClusterType */ public void setClusterType(String clusterType) { this.clusterType = 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. *

      *
    • *
    * * @return 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 KxClusterType */ public String getClusterType() { return this.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. *

        *
      • *
      * * @param 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. *

        *
      • * @return Returns a reference to this object so that method calls can be chained together. * @see KxClusterType */ public ListKxClustersRequest withClusterType(String clusterType) { setClusterType(clusterType); return this; } /** *

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

          *
        • *
        * * @param 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. *

          *
        • * @return Returns a reference to this object so that method calls can be chained together. * @see KxClusterType */ public ListKxClustersRequest withClusterType(KxClusterType clusterType) { this.clusterType = clusterType.toString(); return this; } /** *

          * The maximum number of results to return in this request. *

          * * @param maxResults * The maximum number of results to return in this request. */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

          * The maximum number of results to return in this request. *

          * * @return The maximum number of results to return in this request. */ public Integer getMaxResults() { return this.maxResults; } /** *

          * The maximum number of results to return in this request. *

          * * @param maxResults * The maximum number of results to return in this request. * @return Returns a reference to this object so that method calls can be chained together. */ public ListKxClustersRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** *

          * A token that indicates where a results page should begin. *

          * * @param nextToken * A token that indicates where a results page should begin. */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

          * A token that indicates where a results page should begin. *

          * * @return A token that indicates where a results page should begin. */ public String getNextToken() { return this.nextToken; } /** *

          * A token that indicates where a results page should begin. *

          * * @param nextToken * A token that indicates where a results page should begin. * @return Returns a reference to this object so that method calls can be chained together. */ public ListKxClustersRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getEnvironmentId() != null) sb.append("EnvironmentId: ").append(getEnvironmentId()).append(","); if (getClusterType() != null) sb.append("ClusterType: ").append(getClusterType()).append(","); if (getMaxResults() != null) sb.append("MaxResults: ").append(getMaxResults()).append(","); if (getNextToken() != null) sb.append("NextToken: ").append(getNextToken()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ListKxClustersRequest == false) return false; ListKxClustersRequest other = (ListKxClustersRequest) obj; if (other.getEnvironmentId() == null ^ this.getEnvironmentId() == null) return false; if (other.getEnvironmentId() != null && other.getEnvironmentId().equals(this.getEnvironmentId()) == false) return false; if (other.getClusterType() == null ^ this.getClusterType() == null) return false; if (other.getClusterType() != null && other.getClusterType().equals(this.getClusterType()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getEnvironmentId() == null) ? 0 : getEnvironmentId().hashCode()); hashCode = prime * hashCode + ((getClusterType() == null) ? 0 : getClusterType().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); return hashCode; } @Override public ListKxClustersRequest clone() { return (ListKxClustersRequest) super.clone(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy