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

Class JobSummary

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

Provides information about a classification job, including the current status of the job.

See Also:

  • Method Details

    • bucketCriteria

      public final S3BucketCriteriaForJob bucketCriteria()

      The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

      Returns:
      The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

    • hasBucketDefinitions

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

    • bucketDefinitions

      public final List<S3BucketDefinitionForJob> bucketDefinitions()

      An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

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

      Returns:
      An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

    • createdAt

      public final Instant createdAt()

      The date and time, in UTC and extended ISO 8601 format, when the job was created.

      Returns:
      The date and time, in UTC and extended ISO 8601 format, when the job was created.

    • jobId

      public final String jobId()

      The unique identifier for the job.

      Returns:
      The unique identifier for the job.

    • jobStatus

      public final JobStatus jobStatus()

      The current status of the job. Possible values are:

      • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

      • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

      • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

      • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

      • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

      • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.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:

      • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

      • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

      • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

      • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

      • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

      • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The current status of the job. Possible values are:

      • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

      • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

      • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

      • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

      • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

      • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.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:

      • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

      • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

      • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

      • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

      • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

      • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

      See Also:

    • jobType

      public final JobType jobType()

      The schedule for running the job. Possible values are:

      • ONE_TIME - The job runs only once.

      • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

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

      Returns:
      The schedule for running the job. Possible values are:

      • ONE_TIME - The job runs only once.

      • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The schedule for running the job. Possible values are:

      • ONE_TIME - The job runs only once.

      • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

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

      Returns:
      The schedule for running the job. Possible values are:

      • ONE_TIME - The job runs only once.

      • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

      See Also:

    • lastRunErrorStatus

      public final LastRunErrorStatus lastRunErrorStatus()

      Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

      Returns:
      Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

    • name

      public final String name()

      The custom name of the job.

      Returns:
      The custom name of the job.

    • userPausedDetails

      public final UserPausedDetails userPausedDetails()

      If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

      Returns:
      If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

    • toBuilder

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

    • builder

      public static JobSummary.Builder builder()

    • serializableBuilderClass

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