Class PolicyPreviewJobDetails

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

Contains details about the execution of a policy preview job.

See Also:

  • Method Details

    • jobStatus

      public final ImpactAnalysisJobStatus jobStatus()

      The current status of the job. Possible values are:

      • SUBMITTED - The job has been submitted but not yet started.

      • IN_PROGRESS - The job is currently executing.

      • COMPLETED - The job completed successfully.

      • FAILED - The job failed with an error.

      • CANCELED - The job was canceled by the user.

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

      Returns:
      The current status of the job. Possible values are:

      • SUBMITTED - The job has been submitted but not yet started.

      • IN_PROGRESS - The job is currently executing.

      • COMPLETED - The job completed successfully.

      • FAILED - The job failed with an error.

      • CANCELED - The job was canceled by the user.

      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The current status of the job. Possible values are:

      • SUBMITTED - The job has been submitted but not yet started.

      • IN_PROGRESS - The job is currently executing.

      • COMPLETED - The job completed successfully.

      • FAILED - The job failed with an error.

      • CANCELED - The job was canceled by the user.

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

      Returns:
      The current status of the job. Possible values are:

      • SUBMITTED - The job has been submitted but not yet started.

      • IN_PROGRESS - The job is currently executing.

      • COMPLETED - The job completed successfully.

      • FAILED - The job failed with an error.

      • CANCELED - The job was canceled by the user.

      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. This field is not populated until the job begins processing.

      Returns:
      The time at which the job execution started. This field is not populated until the job begins processing.

    • completedAt

      public final Instant completedAt()

      The time at which the job completed. This field is populated only when the job reaches a terminal state (COMPLETED, FAILED, or CANCELED).

      Returns:
      The time at which the job completed. This field is populated only when the job reaches a terminal state (COMPLETED, FAILED, or CANCELED).

    • jobError

      public final JobError jobError()

      Detailed information about the error that caused the job to fail. This field is populated only when the job status is FAILED.

      Returns:
      Detailed information about the error that caused the job to fail. This field is populated only when the job status is FAILED.

    • toBuilder

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

    • builder

      public static PolicyPreviewJobDetails.Builder builder()

    • serializableBuilderClass

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