@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.
Constructor and Description |
---|
JobSummary() |
Modifier and Type | Method and Description |
---|---|
JobSummary |
clone() |
boolean |
equals(Object obj) |
S3BucketCriteriaForJob |
getBucketCriteria()
The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's
analysis.
|
List<S3BucketDefinitionForJob> |
getBucketDefinitions()
An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job 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 or job run
will expire and be cancelled if it isn't resumed.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setBucketCriteria(S3BucketCriteriaForJob bucketCriteria)
The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's
analysis.
|
void |
setBucketDefinitions(Collection<S3BucketDefinitionForJob> bucketDefinitions)
An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job 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 or job run
will expire and be cancelled if it isn't resumed.
|
String |
toString()
Returns a string representation of this object.
|
JobSummary |
withBucketCriteria(S3BucketCriteriaForJob bucketCriteria)
The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's
analysis.
|
JobSummary |
withBucketDefinitions(Collection<S3BucketDefinitionForJob> bucketDefinitions)
An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to
analyze.
|
JobSummary |
withBucketDefinitions(S3BucketDefinitionForJob... bucketDefinitions)
An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job 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 or job run
will expire and be cancelled if it isn't resumed.
|
public void setBucketCriteria(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.
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.public S3BucketCriteriaForJob getBucketCriteria()
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.
public JobSummary withBucketCriteria(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.
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.public List<S3BucketDefinitionForJob> getBucketDefinitions()
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.
public void setBucketDefinitions(Collection<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.
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.public JobSummary withBucketDefinitions(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.
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.
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.public JobSummary withBucketDefinitions(Collection<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.
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.public void setCreatedAt(Date createdAt)
The date and time, in UTC and extended ISO 8601 format, when the job was created.
createdAt
- The date and time, in UTC and extended ISO 8601 format, when the job was created.public Date getCreatedAt()
The date and time, in UTC and extended ISO 8601 format, when the job was created.
public JobSummary withCreatedAt(Date createdAt)
The date and time, in UTC and extended ISO 8601 format, when the job was created.
createdAt
- The date and time, in UTC and extended ISO 8601 format, when the job was created.public void setJobId(String jobId)
The unique identifier for the job.
jobId
- The unique identifier for the job.public String getJobId()
The unique identifier for the job.
public JobSummary withJobId(String jobId)
The unique identifier for the job.
jobId
- The unique identifier for the job.public void setJobStatus(String 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.
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.
JobStatus
public String getJobStatus()
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.
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.
JobStatus
public JobSummary withJobStatus(String 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.
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.
JobStatus
public JobSummary withJobStatus(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.
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.
JobStatus
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.
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.
JobType
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.
ONE_TIME - The job runs only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis.
JobType
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.
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.
JobType
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.
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.
JobType
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.
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.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.
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.
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.public void setName(String name)
The custom name of the job.
name
- The custom name of the job.public String getName()
The custom name of the job.
public JobSummary withName(String name)
The custom name of the job.
name
- The custom name of the job.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 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.
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.public UserPausedDetails getUserPausedDetails()
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.
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 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.
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.public String toString()
toString
in class Object
Object.toString()
public JobSummary clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.