Package software.amazon.awssdk.services.macie2.model

Class JobDetails

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

Specifies whether any one-time or recurring classification jobs are configured to analyze objects in an S3 bucket, and, if so, the details of the job that ran most recently.

See Also:

  • Method Details

    • isDefinedInJob

      public final IsDefinedInJob isDefinedInJob()

      Specifies whether any one-time or recurring jobs are configured to analyze objects in the bucket. Possible values are:

      • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.

      • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.

      • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

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

      Returns:
      Specifies whether any one-time or recurring jobs are configured to analyze objects in the bucket. Possible values are:

      • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.

      • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.

      • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

      See Also:

    • isDefinedInJobAsString

      public final String isDefinedInJobAsString()

      Specifies whether any one-time or recurring jobs are configured to analyze objects in the bucket. Possible values are:

      • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.

      • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.

      • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

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

      Returns:
      Specifies whether any one-time or recurring jobs are configured to analyze objects in the bucket. Possible values are:

      • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.

      • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.

      • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

      See Also:

    • isMonitoredByJob

      public final IsMonitoredByJob isMonitoredByJob()

      Specifies whether any recurring jobs are configured to analyze objects in the bucket. Possible values are:

      • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.

      • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.

      • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

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

      Returns:
      Specifies whether any recurring jobs are configured to analyze objects in the bucket. Possible values are:

      • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.

      • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.

      • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

      See Also:

    • isMonitoredByJobAsString

      public final String isMonitoredByJobAsString()

      Specifies whether any recurring jobs are configured to analyze objects in the bucket. Possible values are:

      • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.

      • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.

      • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

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

      Returns:
      Specifies whether any recurring jobs are configured to analyze objects in the bucket. Possible values are:

      • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.

      • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.

      • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

      See Also:

    • lastJobId

      public final String lastJobId()

      The unique identifier for the job that ran most recently and is configured to analyze objects in the bucket, either the latest run of a recurring job or the only run of a one-time job.

      This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

      Returns:
      The unique identifier for the job that ran most recently and is configured to analyze objects in the bucket, either the latest run of a recurring job or the only run of a one-time job.

      This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

    • lastJobRunTime

      public final Instant lastJobRunTime()

      The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.

      This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

      Returns:
      The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.

      This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

    • toBuilder

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

    • builder

      public static JobDetails.Builder builder()

    • serializableBuilderClass

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