Class TopicRefreshDetails

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

The details about the refresh of a topic.

See Also:

  • Method Details

    • refreshArn

      public final String refreshArn()

      The Amazon Resource Name (ARN) of the topic refresh.

      Returns:
      The Amazon Resource Name (ARN) of the topic refresh.

    • refreshId

      public final String refreshId()

      The ID of the refresh, which occurs as a result of topic creation or topic update.

      Returns:
      The ID of the refresh, which occurs as a result of topic creation or topic update.

    • refreshStatus

      public final TopicRefreshStatus refreshStatus()

      The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

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

      Returns:
      The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.
      See Also:

    • refreshStatusAsString

      public final String refreshStatusAsString()

      The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

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

      Returns:
      The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.
      See Also:

    • toBuilder

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

    • builder

      public static TopicRefreshDetails.Builder builder()

    • serializableBuilderClass

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