JobSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.macie2.model.JobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobSummary.Builder,JobSummary>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<S3BucketDefinitionForJob>`	`bucketDefinitions()` The S3 buckets that the job is configured to analyze.
`static JobSummary.Builder`	`builder()`
`Instant`	`createdAt()` The date and time, in UTC and extended ISO 8601 format, when the job was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBucketDefinitions()` Returns true if the BucketDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`String`	`jobId()` The unique identifier for the job.
`JobStatus`	`jobStatus()` The current status of the job.
`String`	`jobStatusAsString()` The current status of the job.
`JobType`	`jobType()` The schedule for running the job.
`String`	`jobTypeAsString()` The schedule for running the job.
`LastRunErrorStatus`	`lastRunErrorStatus()` Specifies whether any account- or bucket-level access errors occurred when the job ran.
`String`	`name()` The custom name of the job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends JobSummary.Builder>`	`serializableBuilderClass()`
`JobSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`UserPausedDetails`	`userPausedDetails()` If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasBucketDefinitions
```
public boolean hasBucketDefinitions()
```
    Returns true if the BucketDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - bucketDefinitions
```
public List<S3BucketDefinitionForJob> bucketDefinitions()
```
    The S3 buckets that the job is configured to analyze.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasBucketDefinitions() to see if a value was sent in this field.
    
    Returns:
    
    The S3 buckets that the job is configured to analyze.
  - createdAt
```
public 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 String jobId()
```
    The unique identifier for the job.
    
    Returns:
    
    The unique identifier for the job.
  - jobStatus
```
public JobStatus jobStatus()
```
    The current status of the job. Possible values are:
    - CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.
    - 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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's 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 you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.
    
    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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's expiration date, refer to the UserPausedDetails.jobExpiresAt property.
    See Also:
    
    JobStatus
  - jobStatusAsString
```
public String jobStatusAsString()
```
    The current status of the job. Possible values are:
    - CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.
    - 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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's 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 you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.
    
    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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's expiration date, refer to the UserPausedDetails.jobExpiresAt property.
    See Also:
    
    JobStatus
  - jobType
```
public 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:
    
    JobType
  - jobTypeAsString
```
public 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:
    
    JobType
  - lastRunErrorStatus
```
public 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 String name()
```
    The custom name of the job.
    
    Returns:
    
    The custom name of the job.
  - userPausedDetails
```
public UserPausedDetails userPausedDetails()
```
    If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job 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 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JobSummary.Builder,JobSummary>
  - builder
```
public static JobSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JobSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class JobSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasBucketDefinitions

bucketDefinitions

createdAt

jobId

jobStatus

jobStatusAsString

jobType

jobTypeAsString

lastRunErrorStatus

name

userPausedDetails

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields