java.lang.Object
- software.amazon.awssdk.services.finspace.model.KxDataviewListEntry

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<KxDataviewListEntry.Builder,KxDataviewListEntry>

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

A collection of kdb dataview entries.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface KxDataviewListEntry.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<KxDataviewActiveVersion>`	`activeVersions()`	The active changeset versions for the given dataview entry.
`Boolean`	`autoUpdate()`	The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets.
`String`	`availabilityZoneId()`	The identifier of the availability zones.
`KxAzMode`	`azMode()`	The number of availability zones you want to assign per volume.
`String`	`azModeAsString()`	The number of availability zones you want to assign per volume.
`static KxDataviewListEntry.Builder`	`builder()`
`String`	`changesetId()`	A unique identifier for the changeset.
`Instant`	`createdTimestamp()`	The timestamp at which the dataview list entry was created in FinSpace.
`String`	`databaseName()`	A unique identifier of the database.
`String`	`dataviewName()`	A unique identifier of the dataview.
`String`	`description()`	A description for the dataview list entry.
`String`	`environmentId()`	A unique identifier for the kdb environment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasActiveVersions()`	For responses, this returns true if the service returned a value for the ActiveVersions property.
`int`	`hashCode()`
`boolean`	`hasSegmentConfigurations()`	For responses, this returns true if the service returned a value for the SegmentConfigurations property.
`Instant`	`lastModifiedTimestamp()`	The last time that the dataview list was updated in FinSpace.
`Boolean`	`readWrite()`	Returns True if the dataview is created as writeable and False otherwise.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`List<KxDataviewSegmentConfiguration>`	`segmentConfigurations()`	The configuration that contains the database path of the data that you want to place on each selected volume.
`static Class<? extends KxDataviewListEntry.Builder>`	`serializableBuilderClass()`
`KxDataviewStatus`	`status()`	The status of a given dataview entry.
`String`	`statusAsString()`	The status of a given dataview entry.
`String`	`statusReason()`	The error message when a failed state occurs.
`KxDataviewListEntry.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
  - environmentId
```
public final String environmentId()
```
    A unique identifier for the kdb environment.
    
    Returns:
    
    A unique identifier for the kdb environment.
  - databaseName
```
public final String databaseName()
```
    A unique identifier of the database.
    
    Returns:
    
    A unique identifier of the database.
  - dataviewName
```
public final String dataviewName()
```
    A unique identifier of the dataview.
    
    Returns:
    
    A unique identifier of the dataview.
  - azMode
```
public final KxAzMode azMode()
```
    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
    
    If the service returns an enum value that is not available in the current SDK version, azMode will return KxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().
    
    Returns:
    
    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
    
    See Also:
    
    KxAzMode
  - azModeAsString
```
public final String azModeAsString()
```
    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
    
    If the service returns an enum value that is not available in the current SDK version, azMode will return KxAzMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from azModeAsString().
    
    Returns:
    
    The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.
    
    See Also:
    
    KxAzMode
  - availabilityZoneId
```
public final String availabilityZoneId()
```
    The identifier of the availability zones.
    
    Returns:
    
    The identifier of the availability zones.
  - changesetId
```
public final String changesetId()
```
    A unique identifier for the changeset.
    
    Returns:
    
    A unique identifier for the changeset.
  - hasSegmentConfigurations
```
public final boolean hasSegmentConfigurations()
```
    For responses, this returns true if the service returned a value for the SegmentConfigurations 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.
  - segmentConfigurations
```
public final List<KxDataviewSegmentConfiguration> segmentConfigurations()
```
    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.
    
    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 hasSegmentConfigurations() method.
    
    Returns:
    
    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.
  - hasActiveVersions
```
public final boolean hasActiveVersions()
```
    For responses, this returns true if the service returned a value for the ActiveVersions 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.
  - activeVersions
```
public final List<KxDataviewActiveVersion> activeVersions()
```
    The active changeset versions for the given dataview entry.
    
    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 hasActiveVersions() method.
    
    Returns:
    
    The active changeset versions for the given dataview entry.
  - status
```
public final KxDataviewStatus status()
```
    The status of a given dataview entry.
    
    If the service returns an enum value that is not available in the current SDK version, status will return KxDataviewStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a given dataview entry.
    
    See Also:
    
    KxDataviewStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of a given dataview entry.
    
    If the service returns an enum value that is not available in the current SDK version, status will return KxDataviewStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a given dataview entry.
    
    See Also:
    
    KxDataviewStatus
  - description
```
public final String description()
```
    A description for the dataview list entry.
    
    Returns:
    
    A description for the dataview list entry.
  - autoUpdate
```
public final Boolean autoUpdate()
```
    The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.
    
    Returns:
    
    The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.
  - readWrite
```
public final Boolean readWrite()
```
    Returns True if the dataview is created as writeable and False otherwise.
    
    Returns:
    
    Returns True if the dataview is created as writeable and False otherwise.
  - createdTimestamp
```
public final Instant createdTimestamp()
```
    The timestamp at which the dataview list entry was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
    
    Returns:
    
    The timestamp at which the dataview list entry was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
  - lastModifiedTimestamp
```
public final Instant lastModifiedTimestamp()
```
    The last time that the dataview list was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
    
    Returns:
    
    The last time that the dataview list was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
  - statusReason
```
public final String statusReason()
```
    The error message when a failed state occurs.
    
    Returns:
    
    The error message when a failed state occurs.
  - toBuilder
```
public KxDataviewListEntry.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KxDataviewListEntry.Builder,KxDataviewListEntry>
  - builder
```
public static KxDataviewListEntry.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends KxDataviewListEntry.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

Class KxDataviewListEntry

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

environmentId

databaseName

dataviewName

azMode

azModeAsString

availabilityZoneId

changesetId

hasSegmentConfigurations

segmentConfigurations

hasActiveVersions

activeVersions

status

statusAsString

description

autoUpdate

readWrite

createdTimestamp

lastModifiedTimestamp

statusReason

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField