software.amazon.awssdk.services.macie2.model

Interface CreateClassificationJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateClassificationJobRequest.Builder,CreateClassificationJobRequest>, Macie2Request.Builder, SdkBuilder<CreateClassificationJobRequest.Builder,CreateClassificationJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateClassificationJobRequest

public static interface CreateClassificationJobRequest.Builder
extends Macie2Request.Builder, SdkPojo, CopyableBuilder<CreateClassificationJobRequest.Builder,CreateClassificationJobRequest>

Method Summary

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) The custom data identifiers to use for data analysis and classification.
CreateClassificationJobRequest.Builder	customDataIdentifierIds(String... customDataIdentifierIds) The custom data identifiers to use for data analysis and classification.
CreateClassificationJobRequest.Builder	description(String description) A custom description of the job.
CreateClassificationJobRequest.Builder	initialRun(Boolean initialRun) Specifies whether to analyze all existing, eligible objects immediately after the job is created.
CreateClassificationJobRequest.Builder	jobType(JobType jobType) The schedule for running the job.
CreateClassificationJobRequest.Builder	jobType(String jobType) The schedule for running the job.
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, 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.

Methods inherited from interface software.amazon.awssdk.services.macie2.model.Macie2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clientToken

CreateClassificationJobRequest.Builder clientToken(String clientToken)

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Parameters:

clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

customDataIdentifierIds

CreateClassificationJobRequest.Builder customDataIdentifierIds(Collection<String> customDataIdentifierIds)

The custom data identifiers to use for data analysis and classification.

Parameters:

customDataIdentifierIds - The custom data identifiers to use for data analysis and classification.

Returns:

Returns a reference to this object so that method calls can be chained together.

customDataIdentifierIds

CreateClassificationJobRequest.Builder customDataIdentifierIds(String... customDataIdentifierIds)

The custom data identifiers to use for data analysis and classification.

Parameters:

customDataIdentifierIds - The custom data identifiers to use for data analysis and classification.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateClassificationJobRequest.Builder description(String description)

A custom description of the job. The description can contain as many as 200 characters.

Parameters:

description - A custom description of the job. The description can contain as many as 200 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

initialRun

CreateClassificationJobRequest.Builder initialRun(Boolean initialRun)

Specifies whether to analyze all existing, eligible objects immediately after the job is created.

Parameters:

initialRun - Specifies whether to analyze all existing, eligible objects immediately after the job is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobType

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType, JobType

jobType

CreateClassificationJobRequest.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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType, JobType

name

CreateClassificationJobRequest.Builder name(String name)

A custom name for the job. The name can contain as many as 500 characters.

Parameters:

name - A custom name for the job. The name can contain as many as 500 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

s3JobDefinition

CreateClassificationJobRequest.Builder s3JobDefinition(S3JobDefinition s3JobDefinition)

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

Parameters:

s3JobDefinition - The S3 buckets that contain the objects to analyze, and the scope of that analysis.

Returns:

Returns a reference to this object so that method calls can be chained together.

s3JobDefinition

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 the S3JobDefinition.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).

Parameters:

s3JobDefinition - a consumer that will call methods on S3JobDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

s3JobDefinition(S3JobDefinition)

samplingPercentage

CreateClassificationJobRequest.Builder samplingPercentage(Integer samplingPercentage)

The sampling depth, as a percentage, 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.

Parameters:

samplingPercentage - The sampling depth, as a percentage, 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

scheduleFrequency

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

scheduleFrequency

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 the JobScheduleFrequency.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).

Parameters:

scheduleFrequency - a consumer that will call methods on JobScheduleFrequency.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

scheduleFrequency(JobScheduleFrequency)

tags

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateClassificationJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateClassificationJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.