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

Class KxDataviewSegmentConfiguration

java.lang.Object

software.amazon.awssdk.services.finspace.model.KxDataviewSegmentConfiguration

All Implemented Interfaces:

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

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

The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KxDataviewSegmentConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KxDataviewSegmentConfiguration.Builder	builder()
List<String>	dbPaths()	The database path of the data that you want to place on each selected volume for the segment.
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()
Boolean	onDemand()	Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed.
List<SdkField<?>>	sdkFields()
static Class<? extends KxDataviewSegmentConfiguration.Builder>	serializableBuilderClass()
KxDataviewSegmentConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	volumeName()	The name of the volume where you want to add data.

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

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()

The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

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:

The database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

volumeName

public final String volumeName()

The name of the volume where you want to add data.

Returns:

The name of the volume where you want to add data.

onDemand

public final Boolean onDemand()

Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

Returns:

Enables on-demand caching on the selected database path when a particular file or a column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as needed. When it is set to False, everything is cached. The default value is False.

toBuilder

public KxDataviewSegmentConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KxDataviewSegmentConfiguration.Builder,KxDataviewSegmentConfiguration>

builder

public static KxDataviewSegmentConfiguration.Builder builder()

serializableBuilderClass

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