@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeClassificationJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeClassificationJobResult() |
Modifier and Type | Method and Description |
---|---|
DescribeClassificationJobResult |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
DescribeClassificationJobResult |
clearTagsEntries()
Removes all the entries added into Tags.
|
DescribeClassificationJobResult |
clone() |
boolean |
equals(Object obj) |
List<String> |
getAllowListIds()
An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.
|
String |
getClientToken()
The token that was provided to ensure the idempotency of the request to create the job.
|
Date |
getCreatedAt()
The date and time, in UTC and extended ISO 8601 format, when the job was created.
|
List<String> |
getCustomDataIdentifierIds()
An array of unique identifiers, one for each custom data identifier that the job is configured to use when it
analyzes data.
|
String |
getDescription()
The custom description of the job.
|
Boolean |
getInitialRun()
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects
immediately after the job was created (true).
|
String |
getJobArn()
The Amazon Resource Name (ARN) of the job.
|
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.
|
Date |
getLastRunTime()
The date and time, in UTC and extended ISO 8601 format, when the job started.
|
List<String> |
getManagedDataIdentifierIds()
An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to
include (use) or exclude (not use) when it analyzes data.
|
String |
getManagedDataIdentifierSelector()
The selection type that determines which managed data identifiers the job uses when it analyzes data.
|
String |
getName()
The custom name of the job.
|
S3JobDefinition |
getS3JobDefinition()
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
|
Integer |
getSamplingPercentage()
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
|
JobScheduleFrequency |
getScheduleFrequency()
The recurrence pattern for running the job.
|
Statistics |
getStatistics()
The number of times that the job has run and processing statistics for the job's current run.
|
Map<String,String> |
getTags()
A map of key-value pairs that specifies which tags (keys and values) are associated with 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() |
Boolean |
isInitialRun()
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects
immediately after the job was created (true).
|
void |
setAllowListIds(Collection<String> allowListIds)
An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.
|
void |
setClientToken(String clientToken)
The token that was provided to ensure the idempotency of the request to create the job.
|
void |
setCreatedAt(Date createdAt)
The date and time, in UTC and extended ISO 8601 format, when the job was created.
|
void |
setCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job is configured to use when it
analyzes data.
|
void |
setDescription(String description)
The custom description of the job.
|
void |
setInitialRun(Boolean initialRun)
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects
immediately after the job was created (true).
|
void |
setJobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
|
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 |
setLastRunTime(Date lastRunTime)
The date and time, in UTC and extended ISO 8601 format, when the job started.
|
void |
setManagedDataIdentifierIds(Collection<String> managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to
include (use) or exclude (not use) when it analyzes data.
|
void |
setManagedDataIdentifierSelector(String managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses when it analyzes data.
|
void |
setName(String name)
The custom name of the job.
|
void |
setS3JobDefinition(S3JobDefinition s3JobDefinition)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
|
void |
setSamplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
|
void |
setScheduleFrequency(JobScheduleFrequency scheduleFrequency)
The recurrence pattern for running the job.
|
void |
setStatistics(Statistics statistics)
The number of times that the job has run and processing statistics for the job's current run.
|
void |
setTags(Map<String,String> tags)
A map of key-value pairs that specifies which tags (keys and values) are associated with 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.
|
DescribeClassificationJobResult |
withAllowListIds(Collection<String> allowListIds)
An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.
|
DescribeClassificationJobResult |
withAllowListIds(String... allowListIds)
An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.
|
DescribeClassificationJobResult |
withClientToken(String clientToken)
The token that was provided to ensure the idempotency of the request to create the job.
|
DescribeClassificationJobResult |
withCreatedAt(Date createdAt)
The date and time, in UTC and extended ISO 8601 format, when the job was created.
|
DescribeClassificationJobResult |
withCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job is configured to use when it
analyzes data.
|
DescribeClassificationJobResult |
withCustomDataIdentifierIds(String... customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job is configured to use when it
analyzes data.
|
DescribeClassificationJobResult |
withDescription(String description)
The custom description of the job.
|
DescribeClassificationJobResult |
withInitialRun(Boolean initialRun)
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects
immediately after the job was created (true).
|
DescribeClassificationJobResult |
withJobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
|
DescribeClassificationJobResult |
withJobId(String jobId)
The unique identifier for the job.
|
DescribeClassificationJobResult |
withJobStatus(JobStatus jobStatus)
The current status of the job.
|
DescribeClassificationJobResult |
withJobStatus(String jobStatus)
The current status of the job.
|
DescribeClassificationJobResult |
withJobType(JobType jobType)
The schedule for running the job.
|
DescribeClassificationJobResult |
withJobType(String jobType)
The schedule for running the job.
|
DescribeClassificationJobResult |
withLastRunErrorStatus(LastRunErrorStatus lastRunErrorStatus)
Specifies whether any account- or bucket-level access errors occurred when the job ran.
|
DescribeClassificationJobResult |
withLastRunTime(Date lastRunTime)
The date and time, in UTC and extended ISO 8601 format, when the job started.
|
DescribeClassificationJobResult |
withManagedDataIdentifierIds(Collection<String> managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to
include (use) or exclude (not use) when it analyzes data.
|
DescribeClassificationJobResult |
withManagedDataIdentifierIds(String... managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to
include (use) or exclude (not use) when it analyzes data.
|
DescribeClassificationJobResult |
withManagedDataIdentifierSelector(ManagedDataIdentifierSelector managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses when it analyzes data.
|
DescribeClassificationJobResult |
withManagedDataIdentifierSelector(String managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses when it analyzes data.
|
DescribeClassificationJobResult |
withName(String name)
The custom name of the job.
|
DescribeClassificationJobResult |
withS3JobDefinition(S3JobDefinition s3JobDefinition)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
|
DescribeClassificationJobResult |
withSamplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
|
DescribeClassificationJobResult |
withScheduleFrequency(JobScheduleFrequency scheduleFrequency)
The recurrence pattern for running the job.
|
DescribeClassificationJobResult |
withStatistics(Statistics statistics)
The number of times that the job has run and processing statistics for the job's current run.
|
DescribeClassificationJobResult |
withTags(Map<String,String> tags)
A map of key-value pairs that specifies which tags (keys and values) are associated with the job.
|
DescribeClassificationJobResult |
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.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public List<String> getAllowListIds()
An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.
public void setAllowListIds(Collection<String> allowListIds)
An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.
allowListIds
- An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes
data.public DescribeClassificationJobResult withAllowListIds(String... allowListIds)
An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.
NOTE: This method appends the values to the existing list (if any). Use
setAllowListIds(java.util.Collection)
or withAllowListIds(java.util.Collection)
if you want to
override the existing values.
allowListIds
- An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes
data.public DescribeClassificationJobResult withAllowListIds(Collection<String> allowListIds)
An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes data.
allowListIds
- An array of unique identifiers, one for each allow list that the job is configured to use when it analyzes
data.public void setClientToken(String clientToken)
The token that was provided to ensure the idempotency of the request to create the job.
clientToken
- The token that was provided to ensure the idempotency of the request to create the job.public String getClientToken()
The token that was provided to ensure the idempotency of the request to create the job.
public DescribeClassificationJobResult withClientToken(String clientToken)
The token that was provided to ensure the idempotency of the request to create the job.
clientToken
- The token that was provided to ensure the idempotency of the request to create the job.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 DescribeClassificationJobResult 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 List<String> getCustomDataIdentifierIds()
An array of unique identifiers, one for each custom data identifier that the job is configured to use when it analyzes data. This value is null if the job is configured to use only managed data identifiers to analyze data.
public void setCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job is configured to use when it analyzes data. This value is null if the job is configured to use only managed data identifiers to analyze data.
customDataIdentifierIds
- An array of unique identifiers, one for each custom data identifier that the job is configured to use when
it analyzes data. This value is null if the job is configured to use only managed data identifiers to
analyze data.public DescribeClassificationJobResult withCustomDataIdentifierIds(String... customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job is configured to use when it analyzes data. This value is null if the job is configured to use only managed data identifiers to analyze data.
NOTE: This method appends the values to the existing list (if any). Use
setCustomDataIdentifierIds(java.util.Collection)
or
withCustomDataIdentifierIds(java.util.Collection)
if you want to override the existing values.
customDataIdentifierIds
- An array of unique identifiers, one for each custom data identifier that the job is configured to use when
it analyzes data. This value is null if the job is configured to use only managed data identifiers to
analyze data.public DescribeClassificationJobResult withCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job is configured to use when it analyzes data. This value is null if the job is configured to use only managed data identifiers to analyze data.
customDataIdentifierIds
- An array of unique identifiers, one for each custom data identifier that the job is configured to use when
it analyzes data. This value is null if the job is configured to use only managed data identifiers to
analyze data.public void setDescription(String description)
The custom description of the job.
description
- The custom description of the job.public String getDescription()
The custom description of the job.
public DescribeClassificationJobResult withDescription(String description)
The custom description of the job.
description
- The custom description of the job.public void setInitialRun(Boolean initialRun)
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.
initialRun
- For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects
immediately after the job was created (true). If you configured the job to analyze only those objects that
were created or changed after the job was created and before the job's first scheduled run, this value is
false. This value is also false for a one-time job.public Boolean getInitialRun()
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.
public DescribeClassificationJobResult withInitialRun(Boolean initialRun)
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.
initialRun
- For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects
immediately after the job was created (true). If you configured the job to analyze only those objects that
were created or changed after the job was created and before the job's first scheduled run, this value is
false. This value is also false for a one-time job.public Boolean isInitialRun()
For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.
public void setJobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
jobArn
- The Amazon Resource Name (ARN) of the job.public String getJobArn()
The Amazon Resource Name (ARN) of the job.
public DescribeClassificationJobResult withJobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
jobArn
- The Amazon Resource Name (ARN) of the job.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 DescribeClassificationJobResult 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 DescribeClassificationJobResult 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 DescribeClassificationJobResult 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. The scheduleFrequency property indicates the recurrence pattern for the job.
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. The scheduleFrequency property indicates the recurrence pattern for the job.
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. The scheduleFrequency property indicates the recurrence pattern for the job.
ONE_TIME - The job runs only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
JobType
public DescribeClassificationJobResult 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. The scheduleFrequency property indicates the recurrence pattern for the job.
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. The scheduleFrequency property indicates the recurrence pattern for the job.
JobType
public DescribeClassificationJobResult 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. The scheduleFrequency property indicates the recurrence pattern for the job.
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. The scheduleFrequency property indicates the recurrence pattern for the job.
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 DescribeClassificationJobResult 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 setLastRunTime(Date lastRunTime)
The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was created.
lastRunTime
- The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring
job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was
created.public Date getLastRunTime()
The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was created.
public DescribeClassificationJobResult withLastRunTime(Date lastRunTime)
The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was created.
lastRunTime
- The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring
job, this value indicates when the most recent run started or, if the job hasn't run yet, when the job was
created.public List<String> getManagedDataIdentifierIds()
An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
public void setManagedDataIdentifierIds(Collection<String> managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
managedDataIdentifierIds
- An array of unique identifiers, one for each managed data identifier that the job is explicitly configured
to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed
data identifier selection type specified for the job (managedDataIdentifierSelector).
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
public DescribeClassificationJobResult withManagedDataIdentifierIds(String... managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
NOTE: This method appends the values to the existing list (if any). Use
setManagedDataIdentifierIds(java.util.Collection)
or
withManagedDataIdentifierIds(java.util.Collection)
if you want to override the existing values.
managedDataIdentifierIds
- An array of unique identifiers, one for each managed data identifier that the job is explicitly configured
to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed
data identifier selection type specified for the job (managedDataIdentifierSelector).
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
public DescribeClassificationJobResult withManagedDataIdentifierIds(Collection<String> managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector).
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
managedDataIdentifierIds
- An array of unique identifiers, one for each managed data identifier that the job is explicitly configured
to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed
data identifier selection type specified for the job (managedDataIdentifierSelector).
This value is null if the job's managed data identifier selection type is ALL, NONE, or RECOMMENDED.
public void setManagedDataIdentifierSelector(String managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:
ALL - Use all managed data identifiers.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
managedDataIdentifierSelector
- The selection type that determines which managed data identifiers the job uses when it analyzes data.
Possible values are:
ALL - Use all managed data identifiers.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
ManagedDataIdentifierSelector
public String getManagedDataIdentifierSelector()
The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:
ALL - Use all managed data identifiers.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
ALL - Use all managed data identifiers.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
ManagedDataIdentifierSelector
public DescribeClassificationJobResult withManagedDataIdentifierSelector(String managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:
ALL - Use all managed data identifiers.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
managedDataIdentifierSelector
- The selection type that determines which managed data identifiers the job uses when it analyzes data.
Possible values are:
ALL - Use all managed data identifiers.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
ManagedDataIdentifierSelector
public DescribeClassificationJobResult withManagedDataIdentifierSelector(ManagedDataIdentifierSelector managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses when it analyzes data. Possible values are:
ALL - Use all managed data identifiers.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
managedDataIdentifierSelector
- The selection type that determines which managed data identifiers the job uses when it analyzes data.
Possible values are:
ALL - Use all managed data identifiers.
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
NONE - Don't use any managed data identifiers. Use only custom data identifiers (customDataIdentifierIds).
RECOMMENDED (default) - Use the recommended set of managed data identifiers.
If this value is null, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and this value is ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If this value is null or RECOMMENDED for a recurring job, each job run uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
ManagedDataIdentifierSelector
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 DescribeClassificationJobResult withName(String name)
The custom name of the job.
name
- The custom name of the job.public void setS3JobDefinition(S3JobDefinition s3JobDefinition)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
s3JobDefinition
- The S3 buckets that contain the objects to analyze, and the scope of that analysis.public S3JobDefinition getS3JobDefinition()
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
public DescribeClassificationJobResult withS3JobDefinition(S3JobDefinition s3JobDefinition)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
s3JobDefinition
- The S3 buckets that contain the objects to analyze, and the scope of that analysis.public void setSamplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
samplingPercentage
- The sampling depth, as a percentage, that determines the percentage of eligible objects that the job
analyzes.public Integer getSamplingPercentage()
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
public DescribeClassificationJobResult withSamplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
samplingPercentage
- The sampling depth, as a percentage, that determines the percentage of eligible objects that the job
analyzes.public void setScheduleFrequency(JobScheduleFrequency scheduleFrequency)
The recurrence pattern for running the job. This value is null if the job is configured to run only once.
scheduleFrequency
- The recurrence pattern for running the job. This value is null if the job is configured to run only once.public JobScheduleFrequency getScheduleFrequency()
The recurrence pattern for running the job. This value is null if the job is configured to run only once.
public DescribeClassificationJobResult withScheduleFrequency(JobScheduleFrequency scheduleFrequency)
The recurrence pattern for running the job. This value is null if the job is configured to run only once.
scheduleFrequency
- The recurrence pattern for running the job. This value is null if the job is configured to run only once.public void setStatistics(Statistics statistics)
The number of times that the job has run and processing statistics for the job's current run.
statistics
- The number of times that the job has run and processing statistics for the job's current run.public Statistics getStatistics()
The number of times that the job has run and processing statistics for the job's current run.
public DescribeClassificationJobResult withStatistics(Statistics statistics)
The number of times that the job has run and processing statistics for the job's current run.
statistics
- The number of times that the job has run and processing statistics for the job's current run.public Map<String,String> getTags()
A map of key-value pairs that specifies which tags (keys and values) are associated with the job.
public void setTags(Map<String,String> tags)
A map of key-value pairs that specifies which tags (keys and values) are associated with the job.
tags
- A map of key-value pairs that specifies which tags (keys and values) are associated with the job.public DescribeClassificationJobResult withTags(Map<String,String> tags)
A map of key-value pairs that specifies which tags (keys and values) are associated with the job.
tags
- A map of key-value pairs that specifies which tags (keys and values) are associated with the job.public DescribeClassificationJobResult addTagsEntry(String key, String value)
public DescribeClassificationJobResult clearTagsEntries()
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 DescribeClassificationJobResult 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 DescribeClassificationJobResult clone()