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

Class KxDatabaseCacheConfiguration

java.lang.Object

software.amazon.awssdk.services.finspace.model.KxDatabaseCacheConfiguration

All Implemented Interfaces:

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

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

The structure of database cache configuration that is used for mapping database paths to cache types in clusters.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KxDatabaseCacheConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KxDatabaseCacheConfiguration.Builder	builder()
String	cacheType()	The type of disk cache.
String	dataviewName()	The name of the dataview to be used for caching historical data on disk.
List<String>	dbPaths()	Specifies the portions of database that will be loaded into the cache for access.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDbPaths()	For responses, this returns true if the service returned a value for the DbPaths property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KxDatabaseCacheConfiguration.Builder>	serializableBuilderClass()
KxDatabaseCacheConfiguration.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

cacheType

public final String cacheType()

The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

• CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

Returns:

The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

• CACHE_1000 – This type provides at least 1000 MB/s disk access throughput.

hasDbPaths

public final boolean hasDbPaths()

For responses, this returns true if the service returned a value for the DbPaths 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.

dbPaths

public final List<String> dbPaths()

Specifies the portions of database that will be loaded into the cache for access.

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 hasDbPaths() method.

Returns:

Specifies the portions of database that will be loaded into the cache for access.

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.

toBuilder

public KxDatabaseCacheConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KxDatabaseCacheConfiguration.Builder,KxDatabaseCacheConfiguration>

builder

public static KxDatabaseCacheConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo