Class AnalysisSummary

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

The summary metadata that describes an analysis.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the analysis.

      Returns:
      The Amazon Resource Name (ARN) for the analysis.

    • analysisId

      public final String analysisId()

      The ID of the analysis. This ID displays in the URL.

      Returns:
      The ID of the analysis. This ID displays in the URL.

    • name

      public final String name()

      The name of the analysis. This name is displayed in the Quick Sight console.

      Returns:
      The name of the analysis. This name is displayed in the Quick Sight console.

    • status

      public final ResourceStatus status()

      The last known status for the analysis.

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

      Returns:
      The last known status for the analysis.
      See Also:

    • statusAsString

      public final String statusAsString()

      The last known status for the analysis.

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

      Returns:
      The last known status for the analysis.
      See Also:

    • createdTime

      public final Instant createdTime()

      The time that the analysis was created.

      Returns:
      The time that the analysis was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The time that the analysis was last updated.

      Returns:
      The time that the analysis was last updated.

    • toBuilder

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

    • builder

      public static AnalysisSummary.Builder builder()

    • serializableBuilderClass

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