software.amazon.awssdk.services.macie2.model

Interface DescribeClassificationJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeClassificationJobResponse.Builder,DescribeClassificationJobResponse>, Macie2Response.Builder, SdkBuilder<DescribeClassificationJobResponse.Builder,DescribeClassificationJobResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeClassificationJobResponse

public static interface DescribeClassificationJobResponse.Builder
extends Macie2Response.Builder, SdkPojo, CopyableBuilder<DescribeClassificationJobResponse.Builder,DescribeClassificationJobResponse>

Method Summary

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) The custom data identifiers that the job uses to analyze data.
DescribeClassificationJobResponse.Builder	customDataIdentifierIds(String... customDataIdentifierIds) The custom data identifiers that the job uses to analyze data.
DescribeClassificationJobResponse.Builder	description(String description) The custom description of the job.
DescribeClassificationJobResponse.Builder	initialRun(Boolean initialRun) Specifies whether the job has run for the first time.
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.
DescribeClassificationJobResponse.Builder	lastRunTime(Instant lastRunTime) The date and time, in UTC and extended ISO 8601 format, when the job last ran.
DescribeClassificationJobResponse.Builder	name(String name) The custom name of the job.
default DescribeClassificationJobResponse.Builder	s3JobDefinition(Consumer<S3JobDefinition.Builder> s3JobDefinition) The S3 buckets that the job is configured to analyze, and the scope of that analysis.
DescribeClassificationJobResponse.Builder	s3JobDefinition(S3JobDefinition s3JobDefinition) The S3 buckets that the job is configured to analyze, and the scope of that analysis.
DescribeClassificationJobResponse.Builder	samplingPercentage(Integer samplingPercentage) The sampling depth, as a percentage, that determines the number of objects that the job processes.
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 most recent run.
DescribeClassificationJobResponse.Builder	statistics(Statistics statistics) The number of times that the job has run and processing statistics for the job's most recent run.
DescribeClassificationJobResponse.Builder	tags(Map<String,String> tags) A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification job.

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

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

DescribeClassificationJobResponse.Builder clientToken(String clientToken)

The token that was provided to ensure the idempotency of the request to create the job.

Parameters:

clientToken - The token that was provided to ensure the idempotency of the request to create the job.

Returns:

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

createdAt

DescribeClassificationJobResponse.Builder createdAt(Instant createdAt)

The date and time, in UTC and extended ISO 8601 format, when the job was created.

Parameters:

createdAt - The date and time, in UTC and extended ISO 8601 format, when the job was created.

Returns:

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

customDataIdentifierIds

DescribeClassificationJobResponse.Builder customDataIdentifierIds(Collection<String> customDataIdentifierIds)

The custom data identifiers that the job uses to analyze data.

Parameters:

customDataIdentifierIds - The custom data identifiers that the job uses to analyze data.

Returns:

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

customDataIdentifierIds

DescribeClassificationJobResponse.Builder customDataIdentifierIds(String... customDataIdentifierIds)

The custom data identifiers that the job uses to analyze data.

Parameters:

customDataIdentifierIds - The custom data identifiers that the job uses to analyze data.

Returns:

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

description

DescribeClassificationJobResponse.Builder description(String description)

The custom description of the job.

Parameters:

description - The custom description of the job.

Returns:

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

initialRun

DescribeClassificationJobResponse.Builder initialRun(Boolean initialRun)

Specifies whether the job has run for the first time.

Parameters:

initialRun - Specifies whether the job has run for the first time.

Returns:

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

jobArn

DescribeClassificationJobResponse.Builder jobArn(String jobArn)

The Amazon Resource Name (ARN) of the job.

Parameters:

jobArn - The Amazon Resource Name (ARN) of the job.

Returns:

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

jobId

DescribeClassificationJobResponse.Builder jobId(String jobId)

The unique identifier for the job.

Parameters:

jobId - The unique identifier for the job.

Returns:

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

jobStatus

DescribeClassificationJobResponse.Builder jobStatus(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.

Parameters:

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.

Returns:

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

See Also:

JobStatus, JobStatus

jobStatus

DescribeClassificationJobResponse.Builder jobStatus(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.

Parameters:

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.

Returns:

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

See Also:

JobStatus, JobStatus

jobType

DescribeClassificationJobResponse.Builder jobType(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.

Parameters:

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.

Returns:

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

See Also:

JobType, JobType

jobType

DescribeClassificationJobResponse.Builder jobType(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.

Parameters:

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.

Returns:

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

See Also:

JobType, JobType

lastRunTime

DescribeClassificationJobResponse.Builder lastRunTime(Instant lastRunTime)

The date and time, in UTC and extended ISO 8601 format, when the job last ran.

Parameters:

lastRunTime - The date and time, in UTC and extended ISO 8601 format, when the job last ran.

Returns:

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

name

DescribeClassificationJobResponse.Builder name(String name)

The custom name of the job.

Parameters:

name - The custom name of the job.

Returns:

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

s3JobDefinition

DescribeClassificationJobResponse.Builder s3JobDefinition(S3JobDefinition s3JobDefinition)

The S3 buckets that the job is configured to analyze, and the scope of that analysis.

Parameters:

s3JobDefinition - The S3 buckets that the job is configured 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 DescribeClassificationJobResponse.Builder s3JobDefinition(Consumer<S3JobDefinition.Builder> s3JobDefinition)

The S3 buckets that the job is configured 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

DescribeClassificationJobResponse.Builder samplingPercentage(Integer samplingPercentage)

The sampling depth, as a percentage, that determines the number of objects that the job processes.

Parameters:

samplingPercentage - The sampling depth, as a percentage, that determines the number of objects that the job processes.

Returns:

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

scheduleFrequency

DescribeClassificationJobResponse.Builder scheduleFrequency(JobScheduleFrequency scheduleFrequency)

The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

Parameters:

scheduleFrequency - The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

Returns:

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

scheduleFrequency

default DescribeClassificationJobResponse.Builder scheduleFrequency(Consumer<JobScheduleFrequency.Builder> scheduleFrequency)

The recurrence pattern for running the job. If the job is configured to run only once, this value is null.

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)

statistics

DescribeClassificationJobResponse.Builder statistics(Statistics statistics)

The number of times that the job has run and processing statistics for the job's most recent run.

Parameters:

statistics - The number of times that the job has run and processing statistics for the job's most recent run.

Returns:

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

statistics

default DescribeClassificationJobResponse.Builder statistics(Consumer<Statistics.Builder> statistics)

The number of times that the job has run and processing statistics for the job's most recent run.

This is a convenience that creates an instance of the Statistics.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).

Parameters:

statistics - a consumer that will call methods on Statistics.Builder

Returns:

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

See Also:

statistics(Statistics)

tags

DescribeClassificationJobResponse.Builder tags(Map<String,String> tags)

A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification job.

Parameters:

tags - A map of key-value pairs that identifies the tags (keys and values) that are associated with the classification job.

Returns:

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