Class GetKxDataviewResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.finspace.model.FinspaceResponse
software.amazon.awssdk.services.finspace.model.GetKxDataviewResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetKxDataviewResponse.Builder,GetKxDataviewResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetKxDataviewResponse extends FinspaceResponse implements ToCopyableBuilder<GetKxDataviewResponse.Builder,GetKxDataviewResponse>

  • Method Details

    • databaseName

      public final String databaseName()

      The name of the database where you created the dataview.

      Returns:
      The name of the database where you created the dataview.

    • dataviewName

      public final String dataviewName()

      A unique identifier for the dataview.

      Returns:
      A unique identifier for 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:

    • 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:

    • 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 of the changeset that you want to use to ingest data.

      Returns:
      A unique identifier of the changeset that you want to use to ingest data.

    • 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 current active changeset versions of the database on the given dataview.

      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 current active changeset versions of the database on the given dataview.

    • description

      public final String description()

      A description of the dataview.

      Returns:
      A description of the dataview.

    • 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 new changesets are ingested. 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 new changesets are ingested. 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.

    • environmentId

      public final String environmentId()

      A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

      Returns:
      A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

    • createdTimestamp

      public final Instant createdTimestamp()

      The timestamp at which the dataview 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 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 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 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.

    • status

      public final KxDataviewStatus status()

      The status of dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      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 dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      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 dataview creation.

      • CREATING – The dataview creation is in progress.

      • UPDATING – The dataview is in the process of being updated.

      • ACTIVE – The dataview is active.

      See Also:

    • statusReason

      public final String statusReason()

      The error message when a failed state occurs.

      Returns:
      The error message when a failed state occurs.

    • toBuilder

      public GetKxDataviewResponse.Builder 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 interface ToCopyableBuilder<GetKxDataviewResponse.Builder,GetKxDataviewResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetKxDataviewResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetKxDataviewResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.