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.
JobSummary.Builder	name(String name) The custom name of the job.

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

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

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

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.

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 ran or will run 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 ran or will run 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

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.