Class ChangesetSummary

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

A Changeset is unit of data in a Dataset.

See Also:

  • Method Details

    • changesetId

      public final String changesetId()

      The unique identifier for a Changeset.

      Returns:
      The unique identifier for a Changeset.

    • changesetArn

      public final String changesetArn()

      The ARN identifier of the Changeset.

      Returns:
      The ARN identifier of the Changeset.

    • datasetId

      public final String datasetId()

      The unique identifier for the FinSpace Dataset in which the Changeset is created.

      Returns:
      The unique identifier for the FinSpace Dataset in which the Changeset is created.

    • changeType

      public final ChangeType changeType()

      Type that indicates how a Changeset is applied to a Dataset.

      • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.

      • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.

      • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

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

      Returns:
      Type that indicates how a Changeset is applied to a Dataset.

      • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.

      • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.

      • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

      See Also:

    • changeTypeAsString

      public final String changeTypeAsString()

      Type that indicates how a Changeset is applied to a Dataset.

      • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.

      • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.

      • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

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

      Returns:
      Type that indicates how a Changeset is applied to a Dataset.

      • REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.

      • APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.

      • MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

      See Also:

    • hasSourceParams

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

    • sourceParams

      public final Map<String,String> sourceParams()

      Options that define the location of the data being ingested.

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

      Returns:
      Options that define the location of the data being ingested.

    • hasFormatParams

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

    • formatParams

      public final Map<String,String> formatParams()

      Options that define the structure of the source file(s).

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

      Returns:
      Options that define the structure of the source file(s).

    • createTime

      public final Long createTime()

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

    • status

      public final IngestionStatus status()

      Status of the Changeset ingestion.

      • PENDING – Changeset is pending creation.

      • FAILED – Changeset creation has failed.

      • SUCCESS – Changeset creation has succeeded.

      • RUNNING – Changeset creation is running.

      • STOP_REQUESTED – User requested Changeset creation to stop.

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

      Returns:
      Status of the Changeset ingestion.

      • PENDING – Changeset is pending creation.

      • FAILED – Changeset creation has failed.

      • SUCCESS – Changeset creation has succeeded.

      • RUNNING – Changeset creation is running.

      • STOP_REQUESTED – User requested Changeset creation to stop.

      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the Changeset ingestion.

      • PENDING – Changeset is pending creation.

      • FAILED – Changeset creation has failed.

      • SUCCESS – Changeset creation has succeeded.

      • RUNNING – Changeset creation is running.

      • STOP_REQUESTED – User requested Changeset creation to stop.

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

      Returns:
      Status of the Changeset ingestion.

      • PENDING – Changeset is pending creation.

      • FAILED – Changeset creation has failed.

      • SUCCESS – Changeset creation has succeeded.

      • RUNNING – Changeset creation is running.

      • STOP_REQUESTED – User requested Changeset creation to stop.

      See Also:

    • errorInfo

      public final ChangesetErrorInfo errorInfo()

      The structure with error messages.

      Returns:
      The structure with error messages.

    • activeUntilTimestamp

      public final Long activeUntilTimestamp()

      Time until which the Changeset is active. 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 until which the Changeset is active. 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.

    • activeFromTimestamp

      public final Long activeFromTimestamp()

      Beginning time from which the Changeset is active. 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:
      Beginning time from which the Changeset is active. 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.

    • updatesChangesetId

      public final String updatesChangesetId()

      The unique identifier of the Changeset that is updated.

      Returns:
      The unique identifier of the Changeset that is updated.

    • updatedByChangesetId

      public final String updatedByChangesetId()

      The unique identifier of the updated Changeset.

      Returns:
      The unique identifier of the updated Changeset.

    • toBuilder

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

    • builder

      public static ChangesetSummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.