software.amazon.awssdk.services.macie2.model

Interface JobSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<JobSummary.Builder,JobSummary>, SdkBuilder<JobSummary.Builder,JobSummary>, SdkPojo

Enclosing class:

JobSummary

public static interface JobSummary.Builder
extends SdkPojo, CopyableBuilder<JobSummary.Builder,JobSummary>

Method Summary

Modifier and Type	Method and Description
JobSummary.Builder	bucketDefinitions(Collection<S3BucketDefinitionForJob> bucketDefinitions) The S3 buckets that the job is configured to analyze.
JobSummary.Builder	bucketDefinitions(Consumer<S3BucketDefinitionForJob.Builder>... bucketDefinitions) The S3 buckets that the job is configured to analyze.
JobSummary.Builder	bucketDefinitions(S3BucketDefinitionForJob... bucketDefinitions) The S3 buckets that the job is configured to analyze.
JobSummary.Builder	createdAt(Instant createdAt) The date and time, in UTC and extended ISO 8601 format, when the job was created.
JobSummary.Builder	jobId(String jobId) The unique identifier for the job.
JobSummary.Builder	jobStatus(JobStatus jobStatus) The current status of the job.
JobSummary.Builder	jobStatus(String jobStatus) The current status of the job.
JobSummary.Builder	jobType(JobType jobType) The schedule for running the job.
JobSummary.Builder	jobType(String jobType) The schedule for running the job.
default JobSummary.Builder	lastRunErrorStatus(Consumer<LastRunErrorStatus.Builder> lastRunErrorStatus) Specifies whether any account- or bucket-level access errors occurred when the job ran.
JobSummary.Builder	lastRunErrorStatus(LastRunErrorStatus lastRunErrorStatus) Specifies whether any account- or bucket-level access errors occurred when the job ran.
JobSummary.Builder	name(String name) The custom name of the job.
default JobSummary.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 will expire and be cancelled if it isn't resumed.
JobSummary.Builder	userPausedDetails(UserPausedDetails userPausedDetails) If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed.

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

bucketDefinitions

JobSummary.Builder bucketDefinitions(Collection<S3BucketDefinitionForJob> bucketDefinitions)

The S3 buckets that the job is configured to analyze.

Parameters:

bucketDefinitions - The S3 buckets that the job is configured to analyze.

Returns:

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

bucketDefinitions

JobSummary.Builder bucketDefinitions(S3BucketDefinitionForJob... bucketDefinitions)

The S3 buckets that the job is configured to analyze.

Parameters:

bucketDefinitions - The S3 buckets that the job is configured to analyze.

Returns:

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

bucketDefinitions

JobSummary.Builder bucketDefinitions(Consumer<S3BucketDefinitionForJob.Builder>... bucketDefinitions)

The S3 buckets that the job is configured to analyze.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #bucketDefinitions(List).

Parameters:

bucketDefinitions - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#bucketDefinitions(List)

createdAt

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

jobId

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

JobSummary.Builder jobStatus(String jobStatus)

The current status of the job. Possible values are:

• CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.

• 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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Parameters:

jobStatus - The current status of the job. Possible values are:

• CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.

• 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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Returns:

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

See Also:

JobStatus, JobStatus

jobStatus

JobSummary.Builder jobStatus(JobStatus jobStatus)

The current status of the job. Possible values are:

• CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.

• 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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Parameters:

jobStatus - The current status of the job. Possible values are:

• CANCELLED - You cancelled the job, or you paused the job while it had a status of RUNNING and you didn't resume it within 30 days of pausing it.

• 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 - Amazon 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 the job within 30 days of pausing it, the job expires and is cancelled. To check the job's expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Returns:

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

See Also:

JobStatus, JobStatus

jobType

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

Parameters:

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.

Returns:

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

See Also:

JobType, JobType

jobType

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

Parameters:

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.

Returns:

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

See Also:

JobType, JobType

lastRunErrorStatus

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

Parameters:

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.

Returns:

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

lastRunErrorStatus

default JobSummary.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 the LastRunErrorStatus.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).

Parameters:

lastRunErrorStatus - a consumer that will call methods on LastRunErrorStatus.Builder

Returns:

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

See Also:

lastRunErrorStatus(LastRunErrorStatus)

name

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

userPausedDetails

JobSummary.Builder userPausedDetails(UserPausedDetails userPausedDetails)

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

Parameters:

userPausedDetails - If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

Returns:

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

userPausedDetails

default JobSummary.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 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 the UserPausedDetails.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).

Parameters:

userPausedDetails - a consumer that will call methods on UserPausedDetails.Builder

Returns:

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

See Also:

userPausedDetails(UserPausedDetails)