Class PolicyPreviewAnalysisReport

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

Contains summary information about a policy preview job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The unique identifier of the policy preview job.

      Returns:
      The unique identifier of the policy preview job.

    • status

      public final ImpactAnalysisJobStatus status()

      The current status of the job.

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

      Returns:
      The current status of the job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the job.

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

      Returns:
      The current status of the job.
      See Also:

    • submittedAt

      public final Instant submittedAt()

      The time at which the job was submitted.

      Returns:
      The time at which the job was submitted.

    • startedAt

      public final Instant startedAt()

      The time at which the job execution started.

      Returns:
      The time at which the job execution started.

    • completedAt

      public final Instant completedAt()

      The time at which the job completed.

      Returns:
      The time at which the job completed.

    • outputS3Uri

      public final String outputS3Uri()

      The Amazon S3 URI where the analysis report is stored.

      Returns:
      The Amazon S3 URI where the analysis report is stored.

    • toBuilder

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

    • builder

      public static PolicyPreviewAnalysisReport.Builder builder()

    • serializableBuilderClass

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