Package software.amazon.awssdk.services.finspacedata.model

Class DataViewSummary

java.lang.Object
software.amazon.awssdk.services.finspacedata.model.DataViewSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataViewSummary.Builder,DataViewSummary>
@Generated("software.amazon.awssdk:codegen") public final class DataViewSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataViewSummary.Builder,DataViewSummary>

Structure for the summary of a Dataview.

See Also:

  • Method Details

    • dataViewId

      public final String dataViewId()

      The unique identifier for the Dataview.

      Returns:
      The unique identifier for the Dataview.

    • dataViewArn

      public final String dataViewArn()

      The ARN identifier of the Dataview.

      Returns:
      The ARN identifier of the Dataview.

    • datasetId

      public final String datasetId()

      Th unique identifier for the Dataview Dataset.

      Returns:
      Th unique identifier for the Dataview Dataset.

    • asOfTimestamp

      public final Long asOfTimestamp()

      Time range to use for the Dataview. 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:
      Time range to use for the Dataview. 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.

    • hasPartitionColumns

      public final boolean hasPartitionColumns()
      For responses, this returns true if the service returned a value for the PartitionColumns 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.

    • partitionColumns

      public final List<String> partitionColumns()

      Ordered set of column names used to partition data.

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

      Returns:
      Ordered set of column names used to partition data.

    • hasSortColumns

      public final boolean hasSortColumns()
      For responses, this returns true if the service returned a value for the SortColumns 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.

    • sortColumns

      public final List<String> sortColumns()

      Columns to be used for sorting the data.

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

      Returns:
      Columns to be used for sorting the data.

    • status

      public final DataViewStatus status()

      The status of a Dataview creation.

      • RUNNING – Dataview creation is running.

      • STARTING – Dataview creation is starting.

      • FAILED – Dataview creation has failed.

      • CANCELLED – Dataview creation has been cancelled.

      • TIMEOUT – Dataview creation has timed out.

      • SUCCESS – Dataview creation has succeeded.

      • PENDING – Dataview creation is pending.

      • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

      If the service returns an enum value that is not available in the current SDK version, status will return DataViewStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of a Dataview creation.

      • RUNNING – Dataview creation is running.

      • STARTING – Dataview creation is starting.

      • FAILED – Dataview creation has failed.

      • CANCELLED – Dataview creation has been cancelled.

      • TIMEOUT – Dataview creation has timed out.

      • SUCCESS – Dataview creation has succeeded.

      • PENDING – Dataview creation is pending.

      • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a Dataview creation.

      • RUNNING – Dataview creation is running.

      • STARTING – Dataview creation is starting.

      • FAILED – Dataview creation has failed.

      • CANCELLED – Dataview creation has been cancelled.

      • TIMEOUT – Dataview creation has timed out.

      • SUCCESS – Dataview creation has succeeded.

      • PENDING – Dataview creation is pending.

      • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

      If the service returns an enum value that is not available in the current SDK version, status will return DataViewStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of a Dataview creation.

      • RUNNING – Dataview creation is running.

      • STARTING – Dataview creation is starting.

      • FAILED – Dataview creation has failed.

      • CANCELLED – Dataview creation has been cancelled.

      • TIMEOUT – Dataview creation has timed out.

      • SUCCESS – Dataview creation has succeeded.

      • PENDING – Dataview creation is pending.

      • FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.

      See Also:

    • errorInfo

      public final DataViewErrorInfo errorInfo()

      The structure with error messages.

      Returns:
      The structure with error messages.

    • destinationTypeProperties

      public final DataViewDestinationTypeParams destinationTypeProperties()

      Information about the Dataview destination.

      Returns:
      Information about the Dataview destination.

    • autoUpdate

      public final Boolean autoUpdate()

      The flag to indicate Dataview should be updated automatically.

      Returns:
      The flag to indicate Dataview should be updated automatically.

    • createTime

      public final Long createTime()

      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.

    • lastModifiedTime

      public final Long lastModifiedTime()

      The last time that a Dataview was modified. 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 a Dataview was modified. 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.

    • toBuilder

      public DataViewSummary.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<DataViewSummary.Builder,DataViewSummary>
      Returns:
      a builder for type T

    • builder

      public static DataViewSummary.Builder builder()

    • serializableBuilderClass

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

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