Class GetKxChangesetResponse

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.GetKxChangesetResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetKxChangesetResponse.Builder,GetKxChangesetResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetKxChangesetResponse extends FinspaceResponse implements ToCopyableBuilder<GetKxChangesetResponse.Builder,GetKxChangesetResponse>

  • Method Details

    • changesetId

      public final String changesetId()

      A unique identifier for the changeset.

      Returns:
      A unique identifier for the changeset.

    • databaseName

      public final String databaseName()

      The name of the kdb database.

      Returns:
      The name of the kdb database.

    • environmentId

      public final String environmentId()

      A unique identifier for the kdb environment.

      Returns:
      A unique identifier for the kdb environment.

    • hasChangeRequests

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

    • changeRequests

      public final List<ChangeRequest> changeRequests()

      A list of change request objects that are run in order.

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

      Returns:
      A list of change request objects that are run in order.

    • createdTimestamp

      public final Instant createdTimestamp()

      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.

    • activeFromTimestamp

      public final Instant 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.

    • lastModifiedTimestamp

      public final Instant lastModifiedTimestamp()

      The timestamp at which the changeset 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 timestamp at which the changeset 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 ChangesetStatus status()

      Status of the changeset creation process.

      • Pending – Changeset creation is pending.

      • Processing – Changeset creation is running.

      • Failed – Changeset creation has failed.

      • Complete – Changeset creation has succeeded.

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

      Returns:
      Status of the changeset creation process.

      • Pending – Changeset creation is pending.

      • Processing – Changeset creation is running.

      • Failed – Changeset creation has failed.

      • Complete – Changeset creation has succeeded.

      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the changeset creation process.

      • Pending – Changeset creation is pending.

      • Processing – Changeset creation is running.

      • Failed – Changeset creation has failed.

      • Complete – Changeset creation has succeeded.

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

      Returns:
      Status of the changeset creation process.

      • Pending – Changeset creation is pending.

      • Processing – Changeset creation is running.

      • Failed – Changeset creation has failed.

      • Complete – Changeset creation has succeeded.

      See Also:

    • errorInfo

      public final ErrorInfo errorInfo()

      Provides details in the event of a failed flow, including the error type and the related error message.

      Returns:
      Provides details in the event of a failed flow, including the error type and the related error message.

    • toBuilder

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

    • builder

      public static GetKxChangesetResponse.Builder builder()

    • serializableBuilderClass

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