JobSummary (AWS Java SDK for Amazon Macie 2 1.11.903 API)

java.lang.Object
- com.amazonaws.services.macie2.model.JobSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information about a classification job, including the current status of the job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobSummary()

Constructors
Constructor and Description
`JobSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobSummary`	`clone()`
`boolean`	`equals(Object obj)`
`List<S3BucketDefinitionForJob>`	`getBucketDefinitions()` The S3 buckets that the job is configured to analyze.
`Date`	`getCreatedAt()` The date and time, in UTC and extended ISO 8601 format, when the job was created.
`String`	`getJobId()` The unique identifier for the job.
`String`	`getJobStatus()` The current status of the job.
`String`	`getJobType()` The schedule for running the job.
`LastRunErrorStatus`	`getLastRunErrorStatus()` Specifies whether any account- or bucket-level access errors occurred when the job ran.
`String`	`getName()` The custom name of the job.
`UserPausedDetails`	`getUserPausedDetails()` 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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setBucketDefinitions(Collection<S3BucketDefinitionForJob> bucketDefinitions)` The S3 buckets that the job is configured to analyze.
`void`	`setCreatedAt(Date createdAt)` The date and time, in UTC and extended ISO 8601 format, when the job was created.
`void`	`setJobId(String jobId)` The unique identifier for the job.
`void`	`setJobStatus(String jobStatus)` The current status of the job.
`void`	`setJobType(String jobType)` The schedule for running the job.
`void`	`setLastRunErrorStatus(LastRunErrorStatus lastRunErrorStatus)` Specifies whether any account- or bucket-level access errors occurred when the job ran.
`void`	`setName(String name)` The custom name of the job.
`void`	`setUserPausedDetails(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.
`String`	`toString()` Returns a string representation of this object.
`JobSummary`	`withBucketDefinitions(Collection<S3BucketDefinitionForJob> bucketDefinitions)` The S3 buckets that the job is configured to analyze.
`JobSummary`	`withBucketDefinitions(S3BucketDefinitionForJob... bucketDefinitions)` The S3 buckets that the job is configured to analyze.
`JobSummary`	`withCreatedAt(Date createdAt)` The date and time, in UTC and extended ISO 8601 format, when the job was created.
`JobSummary`	`withJobId(String jobId)` The unique identifier for the job.
`JobSummary`	`withJobStatus(JobStatus jobStatus)` The current status of the job.
`JobSummary`	`withJobStatus(String jobStatus)` The current status of the job.
`JobSummary`	`withJobType(JobType jobType)` The schedule for running the job.
`JobSummary`	`withJobType(String jobType)` The schedule for running the job.
`JobSummary`	`withLastRunErrorStatus(LastRunErrorStatus lastRunErrorStatus)` Specifies whether any account- or bucket-level access errors occurred when the job ran.
`JobSummary`	`withName(String name)` The custom name of the job.
`JobSummary`	`withUserPausedDetails(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
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JobSummary
```
public JobSummary()
```
- Method Detail
  - getBucketDefinitions
```
public List<S3BucketDefinitionForJob> getBucketDefinitions()
```
    The S3 buckets that the job is configured to analyze.
    
    Returns:
    
    The S3 buckets that the job is configured to analyze.
  - setBucketDefinitions
```
public void setBucketDefinitions(Collection<S3BucketDefinitionForJob> bucketDefinitions)
```
    The S3 buckets that the job is configured to analyze.
    
    Parameters:
    
    bucketDefinitions - The S3 buckets that the job is configured to analyze.
  - withBucketDefinitions
```
public JobSummary withBucketDefinitions(S3BucketDefinitionForJob... bucketDefinitions)
```
    The S3 buckets that the job is configured to analyze.
    
    NOTE: This method appends the values to the existing list (if any). Use setBucketDefinitions(java.util.Collection) or withBucketDefinitions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    bucketDefinitions - The S3 buckets that the job is configured to analyze.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBucketDefinitions
```
public JobSummary withBucketDefinitions(Collection<S3BucketDefinitionForJob> bucketDefinitions)
```
    The S3 buckets that the job is configured to analyze.
    
    Parameters:
    
    bucketDefinitions - The S3 buckets that the job is configured to analyze.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The date and time, in UTC and extended ISO 8601 format, when the job was created.
    
    Parameters:
    
    createdAt - The date and time, in UTC and extended ISO 8601 format, when the job was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    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.
  - withCreatedAt
```
public JobSummary withCreatedAt(Date createdAt)
```
    The date and time, in UTC and extended ISO 8601 format, when the job was created.
    
    Parameters:
    
    createdAt - The date and time, in UTC and extended ISO 8601 format, when the job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobId
```
public void setJobId(String jobId)
```
    The unique identifier for the job.
    
    Parameters:
    
    jobId - The unique identifier for the job.
  - getJobId
```
public String getJobId()
```
    The unique identifier for the job.
    
    Returns:
    
    The unique identifier for the job.
  - withJobId
```
public JobSummary withJobId(String jobId)
```
    The unique identifier for the job.
    
    Parameters:
    
    jobId - The unique identifier for the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobStatus
```
public void setJobStatus(String jobStatus)
```
    The current status of the job. Possible values are:
    - CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
    - COMPLETE - For a one-time job, Amazon Macie finished processing all 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 completion of the job would exceed one or more quotas for your account.
    - 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 don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
    Parameters:
    jobStatus - The current status of the job. Possible values are:
    
    CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
    
    COMPLETE - For a one-time job, Amazon Macie finished processing all 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 completion of the job would exceed one or more quotas for your account.
    
    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 don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
    See Also:
    
    JobStatus
  - getJobStatus
```
public String getJobStatus()
```
    The current status of the job. Possible values are:
    - CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
    - COMPLETE - For a one-time job, Amazon Macie finished processing all 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 completion of the job would exceed one or more quotas for your account.
    - 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 don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
    Returns:
    The current status of the job. Possible values are:
    
    CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
    
    COMPLETE - For a one-time job, Amazon Macie finished processing all 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 completion of the job would exceed one or more quotas for your account.
    
    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 don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
    See Also:
    
    JobStatus
  - withJobStatus
```
public JobSummary withJobStatus(String jobStatus)
```
    The current status of the job. Possible values are:
    - CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
    - COMPLETE - For a one-time job, Amazon Macie finished processing all 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 completion of the job would exceed one or more quotas for your account.
    - 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 don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
    Parameters:
    jobStatus - The current status of the job. Possible values are:
    
    CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
    
    COMPLETE - For a one-time job, Amazon Macie finished processing all 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 completion of the job would exceed one or more quotas for your account.
    
    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 don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withJobStatus
```
public JobSummary withJobStatus(JobStatus jobStatus)
```
    The current status of the job. Possible values are:
    - CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
    - COMPLETE - For a one-time job, Amazon Macie finished processing all 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 completion of the job would exceed one or more quotas for your account.
    - 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 don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
    Parameters:
    jobStatus - The current status of the job. Possible values are:
    
    CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
    
    COMPLETE - For a one-time job, Amazon Macie finished processing all 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 completion of the job would exceed one or more quotas for your account.
    
    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 don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setJobType
```
public void setJobType(String 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.
    Parameters:
    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.
    See Also:
    
    JobType
  - getJobType
```
public String getJobType()
```
    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.
    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
  - withJobType
```
public JobSummary withJobType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType
  - withJobType
```
public JobSummary withJobType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobType
  - setLastRunErrorStatus
```
public void setLastRunErrorStatus(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.
    
    Parameters:
    
    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.
  - getLastRunErrorStatus
```
public LastRunErrorStatus getLastRunErrorStatus()
```
    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.
  - withLastRunErrorStatus
```
public JobSummary withLastRunErrorStatus(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The custom name of the job.
    
    Parameters:
    
    name - The custom name of the job.
  - getName
```
public String getName()
```
    The custom name of the job.
    
    Returns:
    
    The custom name of the job.
  - withName
```
public JobSummary withName(String name)
```
    The custom name of the job.
    
    Parameters:
    
    name - The custom name of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserPausedDetails
```
public void setUserPausedDetails(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.
    
    Parameters:
    
    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.
  - getUserPausedDetails
```
public UserPausedDetails getUserPausedDetails()
```
    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.
  - withUserPausedDetails
```
public JobSummary withUserPausedDetails(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public JobSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class JobSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobSummary

Method Detail

getBucketDefinitions

setBucketDefinitions

withBucketDefinitions

withBucketDefinitions

setCreatedAt

getCreatedAt

withCreatedAt

setJobId

getJobId

withJobId

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setJobType

getJobType

withJobType

withJobType

setLastRunErrorStatus

getLastRunErrorStatus

withLastRunErrorStatus

setName

getName

withName

setUserPausedDetails

getUserPausedDetails

withUserPausedDetails

toString

equals

hashCode

clone

marshall