software.amazon.awssdk.services.macie2.model

Class MatchingBucket

java.lang.Object

software.amazon.awssdk.services.macie2.model.MatchingBucket

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MatchingBucket.Builder,MatchingBucket>

@Generated(value="software.amazon.awssdk:codegen")
public final class MatchingBucket
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MatchingBucket.Builder,MatchingBucket>

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MatchingBucket.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The unique identifier for the AWS account that owns the bucket.
String	bucketName() The name of the bucket.
static MatchingBucket.Builder	builder()
Long	classifiableObjectCount() The total number of objects that Amazon Macie can analyze in the bucket.
Long	classifiableSizeInBytes() The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
Long	objectCount() The total number of objects in the bucket.
ObjectCountByEncryptionType	objectCountByEncryptionType() The total number of objects that are in the bucket, grouped by server-side encryption type.
List<SdkField<?>>	sdkFields()
static Class<? extends MatchingBucket.Builder>	serializableBuilderClass()
Long	sizeInBytes() The total storage size, in bytes, of the bucket.
Long	sizeInBytesCompressed() The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
MatchingBucket.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ObjectLevelStatistics	unclassifiableObjectCount() The total number of objects that Amazon Macie can't analyze in the bucket.
ObjectLevelStatistics	unclassifiableObjectSizeInBytes() The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

accountId

public final String accountId()

The unique identifier for the AWS account that owns the bucket.

Returns:

The unique identifier for the AWS account that owns the bucket.

bucketName

public final String bucketName()

The name of the bucket.

Returns:

The name of the bucket.

classifiableObjectCount

public final 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.

Returns:

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.

classifiableSizeInBytes

public final 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.

Returns:

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.

jobDetails

public final 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.

Returns:

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.

objectCount

public final Long objectCount()

The total number of objects in the bucket.

Returns:

The total number of objects in the bucket.

objectCountByEncryptionType

public final ObjectCountByEncryptionType objectCountByEncryptionType()

The total number of objects that are 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:

The total number of objects that are 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.

sizeInBytes

public final 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.

Returns:

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.

sizeInBytesCompressed

public final 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, 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:

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

unclassifiableObjectCount

public final 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.

Returns:

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.

unclassifiableObjectSizeInBytes

public final 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.

Returns:

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.

toBuilder

public MatchingBucket.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MatchingBucket.Builder,MatchingBucket>

builder

public static MatchingBucket.Builder builder()

serializableBuilderClass

public static Class<? extends MatchingBucket.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo