BucketMetadata (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.macie2.model.BucketMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BucketMetadata.Builder,BucketMetadata>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class BucketMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BucketMetadata.Builder,BucketMetadata>
```
Provides 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 BucketMetadata.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BucketMetadata.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accountId()` The unique identifier for the AWS account that owns the bucket.
`AllowsUnencryptedObjectUploads`	`allowsUnencryptedObjectUploads()` Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket.
`String`	`allowsUnencryptedObjectUploadsAsString()` Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket.
`String`	`bucketArn()` The Amazon Resource Name (ARN) of the bucket.
`Instant`	`bucketCreatedAt()` The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
`String`	`bucketName()` The name of the bucket.
`static BucketMetadata.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()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`JobDetails`	`jobDetails()` Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.
`Instant`	`lastUpdated()` The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.
`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.
`BucketPublicAccess`	`publicAccess()` Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.
`String`	`region()` The AWS Region that hosts the bucket.
`ReplicationDetails`	`replicationDetails()` Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BucketMetadata.Builder>`	`serializableBuilderClass()`
`BucketServerSideEncryption`	`serverSideEncryption()` Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.
`SharedAccess`	`sharedAccess()` Specifies whether the bucket is shared with another AWS account.
`String`	`sharedAccessAsString()` Specifies whether the bucket is shared with another AWS account.
`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.
`List<KeyValuePair>`	`tags()` An array that specifies the tags (keys and values) that are associated with the bucket.
`BucketMetadata.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.
`Boolean`	`versioning()` Specifies whether versioning is enabled for 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.
  - allowsUnencryptedObjectUploads
```
public final AllowsUnencryptedObjectUploads allowsUnencryptedObjectUploads()
```
    Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    - FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    - TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    - UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.
    If the service returns an enum value that is not available in the current SDK version, allowsUnencryptedObjectUploads will return AllowsUnencryptedObjectUploads.UNKNOWN_TO_SDK_VERSION . The raw value returned by the service is available from allowsUnencryptedObjectUploadsAsString().
    Returns:
    Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    
    FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    
    TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    
    UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.
    See Also:
    
    AllowsUnencryptedObjectUploads
  - allowsUnencryptedObjectUploadsAsString
```
public final String allowsUnencryptedObjectUploadsAsString()
```
    Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    - FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    - TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    - UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.
    If the service returns an enum value that is not available in the current SDK version, allowsUnencryptedObjectUploads will return AllowsUnencryptedObjectUploads.UNKNOWN_TO_SDK_VERSION . The raw value returned by the service is available from allowsUnencryptedObjectUploadsAsString().
    Returns:
    Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:
    
    FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
    
    TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
    
    UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.
    See Also:
    
    AllowsUnencryptedObjectUploads
  - bucketArn
```
public final String bucketArn()
```
    The Amazon Resource Name (ARN) of the bucket.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the bucket.
  - bucketCreatedAt
```
public final Instant bucketCreatedAt()
```
    The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
    
    Returns:
    
    The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
  - 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 data 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 data in the bucket, and, if so, the details of the job that ran most recently.
  - lastUpdated
```
public final Instant lastUpdated()
```
    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.
    
    Returns:
    
    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.
  - 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.
  - publicAccess
```
public final BucketPublicAccess publicAccess()
```
    Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.
    
    Returns:
    
    Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.
  - region
```
public final String region()
```
    The AWS Region that hosts the bucket.
    
    Returns:
    
    The AWS Region that hosts the bucket.
  - replicationDetails
```
public final ReplicationDetails replicationDetails()
```
    Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.
    
    Returns:
    
    Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.
  - serverSideEncryption
```
public final BucketServerSideEncryption serverSideEncryption()
```
    Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.
    
    Returns:
    
    Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.
  - sharedAccess
```
public final SharedAccess sharedAccess()
```
    Specifies whether the bucket is shared with another AWS account. Possible values are:
    - EXTERNAL - The bucket is shared with an AWS account that isn't part of the same Amazon Macie organization.
    - INTERNAL - The bucket is shared with an AWS account that's part of the same Amazon Macie organization.
    - NOT_SHARED - The bucket isn't shared with other AWS accounts.
    - UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
    If the service returns an enum value that is not available in the current SDK version, sharedAccess will return SharedAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sharedAccessAsString().
    Returns:
    Specifies whether the bucket is shared with another AWS account. Possible values are:
    
    EXTERNAL - The bucket is shared with an AWS account that isn't part of the same Amazon Macie organization.
    
    INTERNAL - The bucket is shared with an AWS account that's part of the same Amazon Macie organization.
    
    NOT_SHARED - The bucket isn't shared with other AWS accounts.
    
    UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
    See Also:
    
    SharedAccess
  - sharedAccessAsString
```
public final String sharedAccessAsString()
```
    Specifies whether the bucket is shared with another AWS account. Possible values are:
    - EXTERNAL - The bucket is shared with an AWS account that isn't part of the same Amazon Macie organization.
    - INTERNAL - The bucket is shared with an AWS account that's part of the same Amazon Macie organization.
    - NOT_SHARED - The bucket isn't shared with other AWS accounts.
    - UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
    If the service returns an enum value that is not available in the current SDK version, sharedAccess will return SharedAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sharedAccessAsString().
    Returns:
    Specifies whether the bucket is shared with another AWS account. Possible values are:
    
    EXTERNAL - The bucket is shared with an AWS account that isn't part of the same Amazon Macie organization.
    
    INTERNAL - The bucket is shared with an AWS account that's part of the same Amazon Macie organization.
    
    NOT_SHARED - The bucket isn't shared with other AWS accounts.
    
    UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
    See Also:
    
    SharedAccess
  - 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.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<KeyValuePair> tags()
```
    An array that specifies the tags (keys and values) that are associated with the bucket.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    An array that specifies the tags (keys and values) that are associated with 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.
  - versioning
```
public final Boolean versioning()
```
    Specifies whether versioning is enabled for the bucket.
    
    Returns:
    
    Specifies whether versioning is enabled for the bucket.
  - toBuilder
```
public BucketMetadata.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BucketMetadata.Builder,BucketMetadata>
  - builder
```
public static BucketMetadata.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BucketMetadata.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

Class BucketMetadata

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

accountId

allowsUnencryptedObjectUploads

allowsUnencryptedObjectUploadsAsString

bucketArn

bucketCreatedAt

bucketName

classifiableObjectCount

classifiableSizeInBytes

jobDetails

lastUpdated

objectCount

objectCountByEncryptionType

publicAccess

region

replicationDetails

serverSideEncryption

sharedAccess

sharedAccessAsString

sizeInBytes

sizeInBytesCompressed

hasTags

tags

unclassifiableObjectCount

unclassifiableObjectSizeInBytes

versioning

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields