public static interface CreateClassificationJobRequest.Builder extends Macie2Request.Builder, SdkPojo, CopyableBuilder<CreateClassificationJobRequest.Builder,CreateClassificationJobRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateClassificationJobRequest.Builder |
clientToken(String clientToken)
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
|
CreateClassificationJobRequest.Builder |
customDataIdentifierIds(Collection<String> customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data.
|
CreateClassificationJobRequest.Builder |
customDataIdentifierIds(String... customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data.
|
CreateClassificationJobRequest.Builder |
description(String description)
A custom description of the job.
|
CreateClassificationJobRequest.Builder |
initialRun(Boolean initialRun)
For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is
created (true).
|
CreateClassificationJobRequest.Builder |
jobType(JobType jobType)
The schedule for running the job.
|
CreateClassificationJobRequest.Builder |
jobType(String jobType)
The schedule for running the job.
|
CreateClassificationJobRequest.Builder |
managedDataIdentifierIds(Collection<String> managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude
(not use) when it analyzes data.
|
CreateClassificationJobRequest.Builder |
managedDataIdentifierIds(String... managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude
(not use) when it analyzes data.
|
CreateClassificationJobRequest.Builder |
managedDataIdentifierSelector(ManagedDataIdentifierSelector managedDataIdentifierSelector)
The selection type to apply when determining which managed data identifiers the job uses to analyze data.
|
CreateClassificationJobRequest.Builder |
managedDataIdentifierSelector(String managedDataIdentifierSelector)
The selection type to apply when determining which managed data identifiers the job uses to analyze data.
|
CreateClassificationJobRequest.Builder |
name(String name)
A custom name for the job.
|
CreateClassificationJobRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateClassificationJobRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
default CreateClassificationJobRequest.Builder |
s3JobDefinition(Consumer<S3JobDefinition.Builder> s3JobDefinition)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
|
CreateClassificationJobRequest.Builder |
s3JobDefinition(S3JobDefinition s3JobDefinition)
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
|
CreateClassificationJobRequest.Builder |
samplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, for the job to apply when processing objects.
|
default CreateClassificationJobRequest.Builder |
scheduleFrequency(Consumer<JobScheduleFrequency.Builder> scheduleFrequency)
The recurrence pattern for running the job.
|
CreateClassificationJobRequest.Builder |
scheduleFrequency(JobScheduleFrequency scheduleFrequency)
The recurrence pattern for running the job.
|
CreateClassificationJobRequest.Builder |
tags(Map<String,String> tags)
A map of key-value pairs that specifies the tags to associate with the job.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateClassificationJobRequest.Builder clientToken(String clientToken)
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.CreateClassificationJobRequest.Builder customDataIdentifierIds(Collection<String> customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.
customDataIdentifierIds - An array of unique identifiers, one for each custom data identifier for the job to use when it
analyzes data. To use only managed data identifiers, don't specify a value for this property and
specify a value other than NONE for the managedDataIdentifierSelector property.CreateClassificationJobRequest.Builder customDataIdentifierIds(String... customDataIdentifierIds)
An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.
customDataIdentifierIds - An array of unique identifiers, one for each custom data identifier for the job to use when it
analyzes data. To use only managed data identifiers, don't specify a value for this property and
specify a value other than NONE for the managedDataIdentifierSelector property.CreateClassificationJobRequest.Builder description(String description)
A custom description of the job. The description can contain as many as 200 characters.
description - A custom description of the job. The description can contain as many as 200 characters.CreateClassificationJobRequest.Builder initialRun(Boolean initialRun)
For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.
If you configure the job to run only once, don't specify a value for this property.
initialRun - For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the
job is created (true). To analyze only those objects that are created or changed after you create the
job and before the job's first scheduled run, set this value to false.
If you configure the job to run only once, don't specify a value for this property.
CreateClassificationJobRequest.Builder jobType(String jobType)
The schedule for running the job. Valid values are:
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.
jobType - The schedule for running the job. Valid values are:
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.
JobType,
JobTypeCreateClassificationJobRequest.Builder jobType(JobType jobType)
The schedule for running the job. Valid values are:
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.
jobType - The schedule for running the job. Valid values are:
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.
JobType,
JobTypeCreateClassificationJobRequest.Builder managedDataIdentifierIds(Collection<String> managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
managedDataIdentifierIds - An array of unique identifiers, one for each managed data identifier for the job to include (use) or
exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier
selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
CreateClassificationJobRequest.Builder managedDataIdentifierIds(String... managedDataIdentifierIds)
An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
managedDataIdentifierIds - An array of unique identifiers, one for each managed data identifier for the job to include (use) or
exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier
selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
CreateClassificationJobRequest.Builder managedDataIdentifierSelector(String managedDataIdentifierSelector)
The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
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 you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
managedDataIdentifierSelector - The selection type to apply when determining which managed data identifiers the job uses to analyze
data. Valid values are:
ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
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 you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
ManagedDataIdentifierSelector,
ManagedDataIdentifierSelectorCreateClassificationJobRequest.Builder managedDataIdentifierSelector(ManagedDataIdentifierSelector managedDataIdentifierSelector)
The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
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 you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
managedDataIdentifierSelector - The selection type to apply when determining which managed data identifiers the job uses to analyze
data. Valid values are:
ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
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 you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.
ManagedDataIdentifierSelector,
ManagedDataIdentifierSelectorCreateClassificationJobRequest.Builder name(String name)
A custom name for the job. The name can contain as many as 500 characters.
name - A custom name for the job. The name can contain as many as 500 characters.CreateClassificationJobRequest.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 CreateClassificationJobRequest.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)CreateClassificationJobRequest.Builder samplingPercentage(Integer samplingPercentage)
The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
samplingPercentage - The sampling depth, as a percentage, for the job to apply when processing objects. This value
determines the percentage of eligible objects that the job analyzes. If this value is less than 100,
Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes
all the data in those objects.CreateClassificationJobRequest.Builder scheduleFrequency(JobScheduleFrequency scheduleFrequency)
The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
scheduleFrequency - The recurrence pattern for running the job. To run the job only once, don't specify a value for this
property and set the value for the jobType property to ONE_TIME.default CreateClassificationJobRequest.Builder scheduleFrequency(Consumer<JobScheduleFrequency.Builder> scheduleFrequency)
The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
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)CreateClassificationJobRequest.Builder tags(Map<String,String> tags)
A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
tags - A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
CreateClassificationJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateClassificationJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.