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

Class KxDatabaseConfiguration

java.lang.Object

software.amazon.awssdk.services.finspace.model.KxDatabaseConfiguration

All Implemented Interfaces:

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

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

The configuration of data that is available for querying from this database.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KxDatabaseConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KxDatabaseConfiguration.Builder	builder()
List<KxDatabaseCacheConfiguration>	cacheConfigurations()	Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.
String	changesetId()	A unique identifier of the changeset that is associated with the cluster.
String	databaseName()	The name of the kdb database.
KxDataviewConfiguration	dataviewConfiguration()	The configuration of the dataview to be used with specified cluster.
String	dataviewName()	The name of the dataview to be used for caching historical data on disk.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCacheConfigurations()	For responses, this returns true if the service returned a value for the CacheConfigurations property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends KxDatabaseConfiguration.Builder>	serializableBuilderClass()
KxDatabaseConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

databaseName

public final String databaseName()

The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.

Returns:

The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.

hasCacheConfigurations

public final boolean hasCacheConfigurations()

For responses, this returns true if the service returned a value for the CacheConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

cacheConfigurations

public final List<KxDatabaseCacheConfiguration> cacheConfigurations()

Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCacheConfigurations() method.

Returns:

Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.

changesetId

public final String changesetId()

A unique identifier of the changeset that is associated with the cluster.

Returns:

A unique identifier of the changeset that is associated with the cluster.

dataviewName

public final String dataviewName()

The name of the dataview to be used for caching historical data on disk.

Returns:

The name of the dataview to be used for caching historical data on disk.

dataviewConfiguration

public final KxDataviewConfiguration dataviewConfiguration()

The configuration of the dataview to be used with specified cluster.

Returns:

The configuration of the dataview to be used with specified cluster.

toBuilder

public KxDatabaseConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KxDatabaseConfiguration.Builder,KxDatabaseConfiguration>

builder

public static KxDatabaseConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends KxDatabaseConfiguration.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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