Class KxDataviewListEntry
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<KxDataviewListEntry.Builder,
KxDataviewListEntry>
A collection of kdb dataview entries.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<KxDataviewActiveVersion> The active changeset versions for the given dataview entry.final Boolean
The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets.final String
The identifier of the availability zones.final KxAzMode
azMode()
The number of availability zones you want to assign per volume.final String
The number of availability zones you want to assign per volume.static KxDataviewListEntry.Builder
builder()
final String
A unique identifier for the changeset.final Instant
The timestamp at which the dataview list entry was created in FinSpace.final String
A unique identifier of the database.final String
A unique identifier of the dataview.final String
A description for the dataview list entry.final String
A unique identifier for the kdb environment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ActiveVersions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SegmentConfigurations property.final Instant
The last time that the dataview list was updated in FinSpace.final Boolean
Returns True if the dataview is created as writeable and False otherwise.The configuration that contains the database path of the data that you want to place on each selected volume.static Class
<? extends KxDataviewListEntry.Builder> final KxDataviewStatus
status()
The status of a given dataview entry.final String
The status of a given dataview entry.final String
The error message when a failed state occurs.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
environmentId
A unique identifier for the kdb environment.
- Returns:
- A unique identifier for the kdb environment.
-
databaseName
A unique identifier of the database.
- Returns:
- A unique identifier of the database.
-
dataviewName
A unique identifier of the dataview.
- Returns:
- A unique identifier of the dataview.
-
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 returnKxAzMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromazModeAsString()
.- 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:
-
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 returnKxAzMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromazModeAsString()
.- 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:
-
availabilityZoneId
The identifier of the availability zones.
- Returns:
- The identifier of the availability zones.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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 returnKxDataviewStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of a given dataview entry.
- See Also:
-
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 returnKxDataviewStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of a given dataview entry.
- See Also:
-
description
A description for the dataview list entry.
- Returns:
- A description for the dataview list entry.
-
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
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
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
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
The error message when a failed state occurs.
- Returns:
- The error message when a failed state occurs.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<KxDataviewListEntry.Builder,
KxDataviewListEntry> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-