public static interface DescribeClassificationJobResponse.Builder extends Macie2Response.Builder, SdkPojo, CopyableBuilder<DescribeClassificationJobResponse.Builder,DescribeClassificationJobResponse>
| Modifier and Type | Method and Description |
|---|---|
DescribeClassificationJobResponse.Builder |
clientToken(String clientToken)
The token that was provided to ensure the idempotency of the request to create the job.
|
DescribeClassificationJobResponse.Builder |
createdAt(Instant createdAt)
The date and time, in UTC and extended ISO 8601 format, when the job was created.
|
DescribeClassificationJobResponse.Builder |
customDataIdentifierIds(Collection<String> customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job uses to analyze data.
|
DescribeClassificationJobResponse.Builder |
customDataIdentifierIds(String... customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job uses to analyze data.
|
DescribeClassificationJobResponse.Builder |
description(String description)
The custom description of the job.
|
DescribeClassificationJobResponse.Builder |
initialRun(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).
|
DescribeClassificationJobResponse.Builder |
jobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
|
DescribeClassificationJobResponse.Builder |
jobId(String jobId)
The unique identifier for the job.
|
DescribeClassificationJobResponse.Builder |
jobStatus(JobStatus jobStatus)
The current status of the job.
|
DescribeClassificationJobResponse.Builder |
jobStatus(String jobStatus)
The current status of the job.
|
DescribeClassificationJobResponse.Builder |
jobType(JobType jobType)
The schedule for running the job.
|
DescribeClassificationJobResponse.Builder |
jobType(String jobType)
The schedule for running the job.
|
default DescribeClassificationJobResponse.Builder |
lastRunErrorStatus(Consumer<LastRunErrorStatus.Builder> lastRunErrorStatus)
Specifies whether any account- or bucket-level access errors occurred when the job ran.
|
DescribeClassificationJobResponse.Builder |
lastRunErrorStatus(LastRunErrorStatus lastRunErrorStatus)
Specifies whether any account- or bucket-level access errors occurred when the job ran.
|
DescribeClassificationJobResponse.Builder |
lastRunTime(Instant lastRunTime)
The date and time, in UTC and extended ISO 8601 format, when the job started.
|
DescribeClassificationJobResponse.Builder |
managedDataIdentifierIds(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.
|
DescribeClassificationJobResponse.Builder |
managedDataIdentifierIds(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.
|
DescribeClassificationJobResponse.Builder |
managedDataIdentifierSelector(ManagedDataIdentifierSelector managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses to analyze data.
|
DescribeClassificationJobResponse.Builder |
managedDataIdentifierSelector(String managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses to analyze data.
|
DescribeClassificationJobResponse.Builder |
name(String name)
The custom name of the job.
|
default DescribeClassificationJobResponse.Builder |
s3JobDefinition(Consumer<S3JobDefinition.Builder> s3JobDefinition)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
|
DescribeClassificationJobResponse.Builder |
s3JobDefinition(S3JobDefinition s3JobDefinition)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
|
DescribeClassificationJobResponse.Builder |
samplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, that determines the percentage of eligible objects that the job
analyzes.
|
default DescribeClassificationJobResponse.Builder |
scheduleFrequency(Consumer<JobScheduleFrequency.Builder> scheduleFrequency)
The recurrence pattern for running the job.
|
DescribeClassificationJobResponse.Builder |
scheduleFrequency(JobScheduleFrequency scheduleFrequency)
The recurrence pattern for running the job.
|
default DescribeClassificationJobResponse.Builder |
statistics(Consumer<Statistics.Builder> statistics)
The number of times that the job has run and processing statistics for the job's current run.
|
DescribeClassificationJobResponse.Builder |
statistics(Statistics statistics)
The number of times that the job has run and processing statistics for the job's current run.
|
DescribeClassificationJobResponse.Builder |
tags(Map<String,String> tags)
A map of key-value pairs that specifies which tags (keys and values) are associated with the classification
job.
|
default DescribeClassificationJobResponse.Builder |
userPausedDetails(Consumer<UserPausedDetails.Builder> 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.
|
DescribeClassificationJobResponse.Builder |
userPausedDetails(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.
|
build, responseMetadata, responseMetadatasdkHttpResponse, sdkHttpResponseequalsBySdkFields, sdkFieldscopyapplyMutation, buildDescribeClassificationJobResponse.Builder clientToken(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.DescribeClassificationJobResponse.Builder createdAt(Instant 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.DescribeClassificationJobResponse.Builder customDataIdentifierIds(Collection<String> customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job uses to analyze data. This value is null if the job uses only managed data identifiers to analyze data.
customDataIdentifierIds - An array of unique identifiers, one for each custom data identifier that the job uses to analyze data.
This value is null if the job uses only managed data identifiers to analyze data.DescribeClassificationJobResponse.Builder customDataIdentifierIds(String... customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier that the job uses to analyze data. This value is null if the job uses only managed data identifiers to analyze data.
customDataIdentifierIds - An array of unique identifiers, one for each custom data identifier that the job uses to analyze data.
This value is null if the job uses only managed data identifiers to analyze data.DescribeClassificationJobResponse.Builder description(String description)
The custom description of the job.
description - The custom description of the job.DescribeClassificationJobResponse.Builder initialRun(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.DescribeClassificationJobResponse.Builder jobArn(String jobArn)
The Amazon Resource Name (ARN) of the job.
jobArn - The Amazon Resource Name (ARN) of the job.DescribeClassificationJobResponse.Builder jobId(String jobId)
The unique identifier for the job.
jobId - The unique identifier for the job.DescribeClassificationJobResponse.Builder jobStatus(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,
JobStatusDescribeClassificationJobResponse.Builder jobStatus(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,
JobStatusDescribeClassificationJobResponse.Builder jobType(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,
JobTypeDescribeClassificationJobResponse.Builder jobType(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,
JobTypeDescribeClassificationJobResponse.Builder lastRunErrorStatus(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.default DescribeClassificationJobResponse.Builder lastRunErrorStatus(Consumer<LastRunErrorStatus.Builder> 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.
This is a convenience that creates an instance of theLastRunErrorStatus.Builder avoiding the need to
create one manually via LastRunErrorStatus.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to lastRunErrorStatus(LastRunErrorStatus).lastRunErrorStatus - a consumer that will call methods on LastRunErrorStatus.BuilderlastRunErrorStatus(LastRunErrorStatus)DescribeClassificationJobResponse.Builder lastRunTime(Instant 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.
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.DescribeClassificationJobResponse.Builder managedDataIdentifierIds(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 or the job uses only custom data identifiers (customDataIdentifierIds) to analyze data.
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 or the job uses only
custom data identifiers (customDataIdentifierIds) to analyze data.DescribeClassificationJobResponse.Builder managedDataIdentifierIds(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 or the job uses only custom data identifiers (customDataIdentifierIds) to analyze data.
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 or the job uses only
custom data identifiers (customDataIdentifierIds) to analyze data.DescribeClassificationJobResponse.Builder managedDataIdentifierSelector(String managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses to analyze data. Possible values are:
ALL - Use all the managed data identifiers that Amazon Macie provides.
EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers 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.
If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
managedDataIdentifierSelector - The selection type that determines which managed data identifiers the job uses to analyze data.
Possible values are:
ALL - Use all the managed data identifiers that Amazon Macie provides.
EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers 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.
If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
ManagedDataIdentifierSelector,
ManagedDataIdentifierSelectorDescribeClassificationJobResponse.Builder managedDataIdentifierSelector(ManagedDataIdentifierSelector managedDataIdentifierSelector)
The selection type that determines which managed data identifiers the job uses to analyze data. Possible values are:
ALL - Use all the managed data identifiers that Amazon Macie provides.
EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers 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.
If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
managedDataIdentifierSelector - The selection type that determines which managed data identifiers the job uses to analyze data.
Possible values are:
ALL - Use all the managed data identifiers that Amazon Macie provides.
EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers 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.
If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
ManagedDataIdentifierSelector,
ManagedDataIdentifierSelectorDescribeClassificationJobResponse.Builder name(String name)
The custom name of the job.
name - The custom name of the job.DescribeClassificationJobResponse.Builder s3JobDefinition(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.default DescribeClassificationJobResponse.Builder s3JobDefinition(Consumer<S3JobDefinition.Builder> s3JobDefinition)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
This is a convenience that creates an instance of theS3JobDefinition.Builder avoiding the need to
create one manually via S3JobDefinition.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to s3JobDefinition(S3JobDefinition).s3JobDefinition - a consumer that will call methods on S3JobDefinition.Builders3JobDefinition(S3JobDefinition)DescribeClassificationJobResponse.Builder samplingPercentage(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.DescribeClassificationJobResponse.Builder scheduleFrequency(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.default DescribeClassificationJobResponse.Builder scheduleFrequency(Consumer<JobScheduleFrequency.Builder> scheduleFrequency)
The recurrence pattern for running the job. This value is null if the job is configured to run only once.
This is a convenience that creates an instance of theJobScheduleFrequency.Builder avoiding the need
to create one manually via JobScheduleFrequency.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to scheduleFrequency(JobScheduleFrequency).scheduleFrequency - a consumer that will call methods on JobScheduleFrequency.BuilderscheduleFrequency(JobScheduleFrequency)DescribeClassificationJobResponse.Builder statistics(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.default DescribeClassificationJobResponse.Builder statistics(Consumer<Statistics.Builder> statistics)
The number of times that the job has run and processing statistics for the job's current run.
This is a convenience that creates an instance of theStatistics.Builder avoiding the need to create
one manually via Statistics.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to statistics(Statistics).statistics - a consumer that will call methods on Statistics.Builderstatistics(Statistics)DescribeClassificationJobResponse.Builder tags(Map<String,String> tags)
A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.
tags - A map of key-value pairs that specifies which tags (keys and values) are associated with the
classification job.DescribeClassificationJobResponse.Builder userPausedDetails(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.default DescribeClassificationJobResponse.Builder userPausedDetails(Consumer<UserPausedDetails.Builder> 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.
This is a convenience that creates an instance of theUserPausedDetails.Builder avoiding the need to
create one manually via UserPausedDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to userPausedDetails(UserPausedDetails).userPausedDetails - a consumer that will call methods on UserPausedDetails.BuilderuserPausedDetails(UserPausedDetails)Copyright © 2022. All rights reserved.