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.
`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 data about the bucket from Amazon S3.
`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.
`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()`
`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 compressed storage size, in bytes, of 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 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.
  - bucketArn
```
public String bucketArn()
```
    The Amazon Resource Name (ARN) of the bucket.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the bucket.
  - bucketCreatedAt
```
public 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 String bucketName()
```
    The name of the bucket.
    
    Returns:
    
    The name of the bucket.
  - classifiableObjectCount
```
public 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 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.
    
    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.
  - jobDetails
```
public 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 Instant lastUpdated()
```
    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the bucket from Amazon S3.
    
    Returns:
    
    The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the bucket from Amazon S3.
  - objectCount
```
public Long objectCount()
```
    The total number of objects in the bucket.
    
    Returns:
    
    The total number of objects in the bucket.
  - objectCountByEncryptionType
```
public 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 BucketPublicAccess publicAccess()
```
    Specifies whether the bucket is publicly accessible. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.
    
    Returns:
    
    Specifies whether the bucket is publicly accessible. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.
  - region
```
public String region()
```
    The AWS Region that hosts the bucket.
    
    Returns:
    
    The AWS Region that hosts the bucket.
  - replicationDetails
```
public 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.
  - sharedAccess
```
public 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 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 Long sizeInBytes()
```
    The total storage size, in bytes, of the bucket.
    
    Returns:
    
    The total storage size, in bytes, of the bucket.
  - sizeInBytesCompressed
```
public Long sizeInBytesCompressed()
```
    The total compressed storage size, in bytes, of the bucket.
    
    Returns:
    
    The total compressed storage size, in bytes, of the bucket.
  - hasTags
```
public 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 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 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 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 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

bucketArn

bucketCreatedAt

bucketName

classifiableObjectCount

classifiableSizeInBytes

jobDetails

lastUpdated

objectCount

objectCountByEncryptionType

publicAccess

region

replicationDetails

sharedAccess

sharedAccessAsString

sizeInBytes

sizeInBytesCompressed

hasTags

tags

unclassifiableObjectCount

unclassifiableObjectSizeInBytes

versioning

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields