@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) |
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()
The custom data identifiers that the job uses to analyze data.
|
String |
getDescription()
The custom description of the job.
|
Boolean |
getInitialRun()
Specifies whether the job has run for the first time.
|
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.
|
Date |
getLastRunTime()
The date and time, in UTC and extended ISO 8601 format, when the job last ran.
|
String |
getName()
The custom name of the job.
|
S3JobDefinition |
getS3JobDefinition()
The S3 buckets that the job is configured to analyze, and the scope of that analysis.
|
Integer |
getSamplingPercentage()
The sampling depth, as a percentage, that the job applies when it processes objects.
|
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 most recent run.
|
Map<String,String> |
getTags()
A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification
job.
|
int |
hashCode() |
Boolean |
isInitialRun()
Specifies whether the job has run for the first time.
|
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)
The custom data identifiers that the job uses to analyze data.
|
void |
setDescription(String description)
The custom description of the job.
|
void |
setInitialRun(Boolean initialRun)
Specifies whether the job has run for the first time.
|
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 |
setLastRunTime(Date lastRunTime)
The date and time, in UTC and extended ISO 8601 format, when the job last ran.
|
void |
setName(String name)
The custom name of the job.
|
void |
setS3JobDefinition(S3JobDefinition s3JobDefinition)
The S3 buckets that the job is configured to analyze, and the scope of that analysis.
|
void |
setSamplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, that the job applies when it processes objects.
|
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 most recent run.
|
void |
setTags(Map<String,String> tags)
A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification
job.
|
String |
toString()
Returns a string representation of this object.
|
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)
The custom data identifiers that the job uses to analyze data.
|
DescribeClassificationJobResult |
withCustomDataIdentifierIds(String... customDataIdentifierIds)
The custom data identifiers that the job uses to analyze data.
|
DescribeClassificationJobResult |
withDescription(String description)
The custom description of the job.
|
DescribeClassificationJobResult |
withInitialRun(Boolean initialRun)
Specifies whether the job has run for the first time.
|
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 |
withLastRunTime(Date lastRunTime)
The date and time, in UTC and extended ISO 8601 format, when the job last ran.
|
DescribeClassificationJobResult |
withName(String name)
The custom name of the job.
|
DescribeClassificationJobResult |
withS3JobDefinition(S3JobDefinition s3JobDefinition)
The S3 buckets that the job is configured to analyze, and the scope of that analysis.
|
DescribeClassificationJobResult |
withSamplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, that the job applies when it processes objects.
|
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 most recent run.
|
DescribeClassificationJobResult |
withTags(Map<String,String> tags)
A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification
job.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
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()
The custom data identifiers that the job uses to analyze data.
public void setCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)
The custom data identifiers that the job uses to analyze data.
customDataIdentifierIds
- The custom data identifiers that the job uses to analyze data.public DescribeClassificationJobResult withCustomDataIdentifierIds(String... customDataIdentifierIds)
The custom data identifiers that the job uses 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
- The custom data identifiers that the job uses to analyze data.public DescribeClassificationJobResult withCustomDataIdentifierIds(Collection<String> customDataIdentifierIds)
The custom data identifiers that the job uses to analyze data.
customDataIdentifierIds
- The custom data identifiers that the job uses 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)
Specifies whether the job has run for the first time.
initialRun
- Specifies whether the job has run for the first time.public Boolean getInitialRun()
Specifies whether the job has run for the first time.
public DescribeClassificationJobResult withInitialRun(Boolean initialRun)
Specifies whether the job has run for the first time.
initialRun
- Specifies whether the job has run for the first time.public Boolean isInitialRun()
Specifies whether the job has run for the first time.
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 - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
jobStatus
- The current status of the job. Possible values are:
CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
JobStatus
public String getJobStatus()
The current status of the job. Possible values are:
CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
JobStatus
public DescribeClassificationJobResult withJobStatus(String jobStatus)
The current status of the job. Possible values are:
CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
jobStatus
- The current status of the job. Possible values are:
CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
JobStatus
public DescribeClassificationJobResult withJobStatus(JobStatus jobStatus)
The current status of the job. Possible values are:
CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
jobStatus
- The current status of the job. Possible values are:
CANCELLED - The job was cancelled by you or a user of the master account for your organization. A job might also be cancelled if ownership of an S3 bucket changed while the job was running, and that change affected the job's access to the bucket.
COMPLETE - Amazon Macie finished processing all the data specified for the job.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to jobs that occur only once.
PAUSED - Amazon Macie started the job, but completion of the job would exceed one or more quotas for your account.
RUNNING - The job is in progress.
JobStatus
public void setJobType(String jobType)
The schedule for running the job. Possible values are:
ONE_TIME - The job ran or will run 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 ran or will run 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 ran or will run 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 ran or will run 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 ran or will run 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 ran or will run 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 ran or will run 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 ran or will run 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 setLastRunTime(Date lastRunTime)
The date and time, in UTC and extended ISO 8601 format, when the job last ran.
lastRunTime
- The date and time, in UTC and extended ISO 8601 format, when the job last ran.public Date getLastRunTime()
The date and time, in UTC and extended ISO 8601 format, when the job last ran.
public DescribeClassificationJobResult withLastRunTime(Date lastRunTime)
The date and time, in UTC and extended ISO 8601 format, when the job last ran.
lastRunTime
- The date and time, in UTC and extended ISO 8601 format, when the job last ran.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 the job is configured to analyze, and the scope of that analysis.
s3JobDefinition
- The S3 buckets that the job is configured to analyze, and the scope of that analysis.public S3JobDefinition getS3JobDefinition()
The S3 buckets that the job is configured to analyze, and the scope of that analysis.
public DescribeClassificationJobResult withS3JobDefinition(S3JobDefinition s3JobDefinition)
The S3 buckets that the job is configured to analyze, and the scope of that analysis.
s3JobDefinition
- The S3 buckets that the job is configured to analyze, and the scope of that analysis.public void setSamplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, that the job applies when it processes objects.
samplingPercentage
- The sampling depth, as a percentage, that the job applies when it processes objects.public Integer getSamplingPercentage()
The sampling depth, as a percentage, that the job applies when it processes objects.
public DescribeClassificationJobResult withSamplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, that the job applies when it processes objects.
samplingPercentage
- The sampling depth, as a percentage, that the job applies when it processes objects.public void setScheduleFrequency(JobScheduleFrequency scheduleFrequency)
The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
scheduleFrequency
- The recurrence pattern for running the job. If the job is configured to run only once, this value is null.public JobScheduleFrequency getScheduleFrequency()
The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
public DescribeClassificationJobResult withScheduleFrequency(JobScheduleFrequency scheduleFrequency)
The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
scheduleFrequency
- The recurrence pattern for running the job. If the job is configured to run only once, this value is null.public void setStatistics(Statistics statistics)
The number of times that the job has run and processing statistics for the job's most recent run.
statistics
- The number of times that the job has run and processing statistics for the job's most recent run.public Statistics getStatistics()
The number of times that the job has run and processing statistics for the job's most recent run.
public DescribeClassificationJobResult withStatistics(Statistics statistics)
The number of times that the job has run and processing statistics for the job's most recent run.
statistics
- The number of times that the job has run and processing statistics for the job's most recent run.public Map<String,String> getTags()
A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification job.
public void setTags(Map<String,String> tags)
A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification job.
tags
- A map of key-value pairs that identifies the tags (keys and values) that are associated with the
classification job.public DescribeClassificationJobResult withTags(Map<String,String> tags)
A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification job.
tags
- A map of key-value pairs that identifies the tags (keys and values) that are associated with the
classification job.public DescribeClassificationJobResult addTagsEntry(String key, String value)
public DescribeClassificationJobResult clearTagsEntries()
public String toString()
toString
in class Object
Object.toString()
public DescribeClassificationJobResult clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.