com.amazonaws.services.finspace.model

Class ListKxClustersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.finspace.model.ListKxClustersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListKxClustersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListKxClustersRequest()

Method Summary

Modifier and Type	Method and Description
ListKxClustersRequest	clone()
boolean	equals(Object obj)
String	getClusterType() Specifies the type of KDB database that is being created.
String	getEnvironmentId() A unique identifier for the kdb environment.
Integer	getMaxResults() The maximum number of results to return in this request.
String	getNextToken() A token that indicates where a results page should begin.
int	hashCode()
void	setClusterType(String clusterType) Specifies the type of KDB database that is being created.
void	setEnvironmentId(String environmentId) A unique identifier for the kdb environment.
void	setMaxResults(Integer maxResults) The maximum number of results to return in this request.
void	setNextToken(String nextToken) A token that indicates where a results page should begin.
String	toString() Returns a string representation of this object.
ListKxClustersRequest	withClusterType(KxClusterType clusterType) Specifies the type of KDB database that is being created.
ListKxClustersRequest	withClusterType(String clusterType) Specifies the type of KDB database that is being created.
ListKxClustersRequest	withEnvironmentId(String environmentId) A unique identifier for the kdb environment.
ListKxClustersRequest	withMaxResults(Integer maxResults) The maximum number of results to return in this request.
ListKxClustersRequest	withNextToken(String nextToken) A token that indicates where a results page should begin.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListKxClustersRequest

public ListKxClustersRequest()

Method Detail

setEnvironmentId

public void setEnvironmentId(String environmentId)

A unique identifier for the kdb environment.

Parameters:

environmentId - A unique identifier for the kdb environment.

getEnvironmentId

public String getEnvironmentId()

A unique identifier for the kdb environment.

Returns:

A unique identifier for the kdb environment.

withEnvironmentId

public ListKxClustersRequest withEnvironmentId(String environmentId)

A unique identifier for the kdb environment.

Parameters:

environmentId - A unique identifier for the kdb environment.

Returns:

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

setClusterType

public void setClusterType(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.

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.

See Also:

KxClusterType

getClusterType

public String getClusterType()

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.

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

withClusterType

public ListKxClustersRequest withClusterType(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.

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.

Returns:

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

See Also:

KxClusterType

withClusterType

public ListKxClustersRequest withClusterType(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.

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.

Returns:

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

See Also:

KxClusterType

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return in this request.

Parameters:

maxResults - The maximum number of results to return in this request.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return in this request.

Returns:

The maximum number of results to return in this request.

withMaxResults

public ListKxClustersRequest withMaxResults(Integer maxResults)

The maximum number of results to return in this request.

Parameters:

maxResults - The maximum number of results to return in this request.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

A token that indicates where a results page should begin.

Parameters:

nextToken - A token that indicates where a results page should begin.

getNextToken

public String getNextToken()

A token that indicates where a results page should begin.

Returns:

A token that indicates where a results page should begin.

withNextToken

public ListKxClustersRequest withNextToken(String nextToken)

A token that indicates where a results page should begin.

Parameters:

nextToken - A token that indicates where a results page should begin.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListKxClustersRequest clone()

Overrides:

clone in class AmazonWebServiceRequest