software.amazon.awssdk.services.macie2.model

Interface MatchingBucket.Builder

All Superinterfaces:

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

Enclosing class:

MatchingBucket

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

Method Summary

Modifier and Type	Method and Description
MatchingBucket.Builder	accountId(String accountId) The unique identifier for the Amazon Web Services account that owns the bucket.
MatchingBucket.Builder	bucketName(String bucketName) The name of the bucket.
MatchingBucket.Builder	classifiableObjectCount(Long classifiableObjectCount) The total number of objects that Amazon Macie can analyze in the bucket.
MatchingBucket.Builder	classifiableSizeInBytes(Long classifiableSizeInBytes) The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket.
MatchingBucket.Builder	errorCode(BucketMetadataErrorCode errorCode) Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects.
MatchingBucket.Builder	errorCode(String errorCode) Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects.
MatchingBucket.Builder	errorMessage(String errorMessage) A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects.
default MatchingBucket.Builder	jobDetails(Consumer<JobDetails.Builder> jobDetails) Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.
MatchingBucket.Builder	jobDetails(JobDetails jobDetails) Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.
MatchingBucket.Builder	lastAutomatedDiscoveryTime(Instant lastAutomatedDiscoveryTime) The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently performed automated sensitive data discovery for the bucket.
MatchingBucket.Builder	objectCount(Long objectCount) The total number of objects in the bucket.
default MatchingBucket.Builder	objectCountByEncryptionType(Consumer<ObjectCountByEncryptionType.Builder> objectCountByEncryptionType) The total number of objects in the bucket, grouped by server-side encryption type.
MatchingBucket.Builder	objectCountByEncryptionType(ObjectCountByEncryptionType objectCountByEncryptionType) The total number of objects in the bucket, grouped by server-side encryption type.
MatchingBucket.Builder	sensitivityScore(Integer sensitivityScore) The current sensitivity score for the bucket, ranging from -1 (no analysis due to an error) to 100 (sensitive).
MatchingBucket.Builder	sizeInBytes(Long sizeInBytes) The total storage size, in bytes, of the bucket.
MatchingBucket.Builder	sizeInBytesCompressed(Long sizeInBytesCompressed) The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
default MatchingBucket.Builder	unclassifiableObjectCount(Consumer<ObjectLevelStatistics.Builder> unclassifiableObjectCount) The total number of objects that Amazon Macie can't analyze in the bucket.
MatchingBucket.Builder	unclassifiableObjectCount(ObjectLevelStatistics unclassifiableObjectCount) The total number of objects that Amazon Macie can't analyze in the bucket.
default MatchingBucket.Builder	unclassifiableObjectSizeInBytes(Consumer<ObjectLevelStatistics.Builder> unclassifiableObjectSizeInBytes) The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket.
MatchingBucket.Builder	unclassifiableObjectSizeInBytes(ObjectLevelStatistics unclassifiableObjectSizeInBytes) The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket.

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

accountId

MatchingBucket.Builder accountId(String accountId)

The unique identifier for the Amazon Web Services account that owns the bucket.

Parameters:

accountId - The unique identifier for the Amazon Web Services account that owns the bucket.

Returns:

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

bucketName

MatchingBucket.Builder bucketName(String bucketName)

The name of the bucket.

Parameters:

bucketName - The name of the bucket.

Returns:

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

classifiableObjectCount

MatchingBucket.Builder classifiableObjectCount(Long classifiableObjectCount)

The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

Parameters:

classifiableObjectCount - The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

Returns:

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

classifiableSizeInBytes

MatchingBucket.Builder classifiableSizeInBytes(Long classifiableSizeInBytes)

The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

Parameters:

classifiableSizeInBytes - The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

Returns:

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

errorCode

MatchingBucket.Builder errorCode(String errorCode)

Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

Parameters:

errorCode - Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

Returns:

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

See Also:

BucketMetadataErrorCode, BucketMetadataErrorCode

errorCode

MatchingBucket.Builder errorCode(BucketMetadataErrorCode errorCode)

Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

Parameters:

errorCode - Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

Returns:

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

See Also:

BucketMetadataErrorCode, BucketMetadataErrorCode

errorMessage

MatchingBucket.Builder errorMessage(String errorMessage)

A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.

Parameters:

errorMessage - A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.

Returns:

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

jobDetails

MatchingBucket.Builder jobDetails(JobDetails jobDetails)

Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.

Parameters:

jobDetails - Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.

Returns:

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

jobDetails

default MatchingBucket.Builder jobDetails(Consumer<JobDetails.Builder> jobDetails)

Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.

This is a convenience method that creates an instance of the JobDetails.Builder avoiding the need to create one manually via JobDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobDetails(JobDetails).

Parameters:

jobDetails - a consumer that will call methods on JobDetails.Builder

Returns:

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

See Also:

jobDetails(JobDetails)

lastAutomatedDiscoveryTime

MatchingBucket.Builder lastAutomatedDiscoveryTime(Instant lastAutomatedDiscoveryTime)

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently performed automated sensitive data discovery for the bucket. This value is null if automated sensitive data discovery is currently disabled for your account.

Parameters:

lastAutomatedDiscoveryTime - The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently performed automated sensitive data discovery for the bucket. This value is null if automated sensitive data discovery is currently disabled for your account.

Returns:

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

objectCount

MatchingBucket.Builder objectCount(Long objectCount)

The total number of objects in the bucket.

Parameters:

objectCount - The total number of objects in the bucket.

Returns:

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

objectCountByEncryptionType

MatchingBucket.Builder objectCountByEncryptionType(ObjectCountByEncryptionType objectCountByEncryptionType)

The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

Parameters:

objectCountByEncryptionType - The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

Returns:

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

objectCountByEncryptionType

default MatchingBucket.Builder objectCountByEncryptionType(Consumer<ObjectCountByEncryptionType.Builder> objectCountByEncryptionType)

The total number of objects in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

This is a convenience method that creates an instance of the ObjectCountByEncryptionType.Builder avoiding the need to create one manually via ObjectCountByEncryptionType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to objectCountByEncryptionType(ObjectCountByEncryptionType).

Parameters:

objectCountByEncryptionType - a consumer that will call methods on ObjectCountByEncryptionType.Builder

Returns:

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

See Also:

objectCountByEncryptionType(ObjectCountByEncryptionType)

sensitivityScore

MatchingBucket.Builder sensitivityScore(Integer sensitivityScore)

The current sensitivity score for the bucket, ranging from -1 (no analysis due to an error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

Parameters:

sensitivityScore - The current sensitivity score for the bucket, ranging from -1 (no analysis due to an error) to 100 (sensitive). This value is null if automated sensitive data discovery is currently disabled for your account.

Returns:

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

sizeInBytes

MatchingBucket.Builder sizeInBytes(Long sizeInBytes)

The total storage size, in bytes, of the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.

Parameters:

sizeInBytes - The total storage size, in bytes, of the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.

Returns:

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

sizeInBytesCompressed

MatchingBucket.Builder sizeInBytesCompressed(Long sizeInBytesCompressed)

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

Parameters:

sizeInBytesCompressed - The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

Returns:

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

unclassifiableObjectCount

MatchingBucket.Builder unclassifiableObjectCount(ObjectLevelStatistics unclassifiableObjectCount)

The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

Parameters:

unclassifiableObjectCount - The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

Returns:

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

unclassifiableObjectCount

default MatchingBucket.Builder unclassifiableObjectCount(Consumer<ObjectLevelStatistics.Builder> unclassifiableObjectCount)

The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

This is a convenience method that creates an instance of the ObjectLevelStatistics.Builder avoiding the need to create one manually via ObjectLevelStatistics.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to unclassifiableObjectCount(ObjectLevelStatistics).

Parameters:

unclassifiableObjectCount - a consumer that will call methods on ObjectLevelStatistics.Builder

Returns:

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

See Also:

unclassifiableObjectCount(ObjectLevelStatistics)

unclassifiableObjectSizeInBytes

MatchingBucket.Builder unclassifiableObjectSizeInBytes(ObjectLevelStatistics unclassifiableObjectSizeInBytes)

The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

Parameters:

unclassifiableObjectSizeInBytes - The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

Returns:

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

unclassifiableObjectSizeInBytes

default MatchingBucket.Builder unclassifiableObjectSizeInBytes(Consumer<ObjectLevelStatistics.Builder> unclassifiableObjectSizeInBytes)

The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

This is a convenience method that creates an instance of the ObjectLevelStatistics.Builder avoiding the need to create one manually via ObjectLevelStatistics.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to unclassifiableObjectSizeInBytes(ObjectLevelStatistics).

Parameters:

unclassifiableObjectSizeInBytes - a consumer that will call methods on ObjectLevelStatistics.Builder

Returns:

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

See Also:

unclassifiableObjectSizeInBytes(ObjectLevelStatistics)