Class AnalysisReportSummary

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

Retrieves the details of the performance analysis report.

See Also:

  • Method Details

    • analysisReportId

      public final String analysisReportId()

      The name of the analysis report.

      Returns:
      The name of the analysis report.

    • createTime

      public final Instant createTime()

      The time you created the analysis report.

      Returns:
      The time you created the analysis report.

    • startTime

      public final Instant startTime()

      The start time of the analysis in the report.

      Returns:
      The start time of the analysis in the report.

    • endTime

      public final Instant endTime()

      The end time of the analysis in the report.

      Returns:
      The end time of the analysis in the report.

    • status

      public final AnalysisStatus status()

      The status of the analysis report.

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

      Returns:
      The status of the analysis report.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the analysis report.

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

      Returns:
      The status of the analysis report.
      See Also:

    • hasTags

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

    • tags

      public final List<Tag> tags()

      List of all the tags added to the analysis report.

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

      Returns:
      List of all the tags added to the analysis report.

    • toBuilder

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

    • builder

      public static AnalysisReportSummary.Builder builder()

    • serializableBuilderClass

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