@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class BucketMetadata extends Object implements Serializable, Cloneable, StructuredPojo
Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. If an error occurs when Macie attempts to retrieve and process information about the bucket or the bucket's objects, the value for the versioning property is false and the value for most other properties is null. Exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.
Constructor and Description |
---|
BucketMetadata() |
Modifier and Type | Method and Description |
---|---|
BucketMetadata |
clone() |
boolean |
equals(Object obj) |
String |
getAccountId()
The unique identifier for the Amazon Web Services account that owns the bucket.
|
String |
getAllowsUnencryptedObjectUploads()
Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are
uploaded to the bucket.
|
String |
getBucketArn()
The Amazon Resource Name (ARN) of the bucket.
|
Date |
getBucketCreatedAt()
The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
|
String |
getBucketName()
The name of the bucket.
|
Long |
getClassifiableObjectCount()
The total number of objects that Amazon Macie can analyze in the bucket.
|
Long |
getClassifiableSizeInBytes()
The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket.
|
String |
getErrorCode()
Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information
about the bucket and the bucket's objects.
|
String |
getErrorMessage()
A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing
information about the bucket and the bucket's objects.
|
JobDetails |
getJobDetails()
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.
|
Date |
getLastUpdated()
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 |
getObjectCount()
The total number of objects in the bucket.
|
ObjectCountByEncryptionType |
getObjectCountByEncryptionType()
The total number of objects that are in the bucket, grouped by server-side encryption type.
|
BucketPublicAccess |
getPublicAccess()
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 |
getRegion()
The Amazon Web Services Region that hosts the bucket.
|
ReplicationDetails |
getReplicationDetails()
Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web
Services accounts and, if so, which accounts.
|
BucketServerSideEncryption |
getServerSideEncryption()
Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption
that's used.
|
String |
getSharedAccess()
Specifies whether the bucket is shared with another Amazon Web Services account.
|
Long |
getSizeInBytes()
The total storage size, in bytes, of the bucket.
|
Long |
getSizeInBytesCompressed()
The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
|
List<KeyValuePair> |
getTags()
An array that specifies the tags (keys and values) that are associated with the bucket.
|
ObjectLevelStatistics |
getUnclassifiableObjectCount()
The total number of objects that Amazon Macie can't analyze in the bucket.
|
ObjectLevelStatistics |
getUnclassifiableObjectSizeInBytes()
The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket.
|
Boolean |
getVersioning()
Specifies whether versioning is enabled for the bucket.
|
int |
hashCode() |
Boolean |
isVersioning()
Specifies whether versioning is enabled for the bucket.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAccountId(String accountId)
The unique identifier for the Amazon Web Services account that owns the bucket.
|
void |
setAllowsUnencryptedObjectUploads(String allowsUnencryptedObjectUploads)
Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are
uploaded to the bucket.
|
void |
setBucketArn(String bucketArn)
The Amazon Resource Name (ARN) of the bucket.
|
void |
setBucketCreatedAt(Date bucketCreatedAt)
The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
|
void |
setBucketName(String bucketName)
The name of the bucket.
|
void |
setClassifiableObjectCount(Long classifiableObjectCount)
The total number of objects that Amazon Macie can analyze in the bucket.
|
void |
setClassifiableSizeInBytes(Long classifiableSizeInBytes)
The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket.
|
void |
setErrorCode(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.
|
void |
setErrorMessage(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.
|
void |
setJobDetails(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.
|
void |
setLastUpdated(Date 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.
|
void |
setObjectCount(Long objectCount)
The total number of objects in the bucket.
|
void |
setObjectCountByEncryptionType(ObjectCountByEncryptionType objectCountByEncryptionType)
The total number of objects that are in the bucket, grouped by server-side encryption type.
|
void |
setPublicAccess(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.
|
void |
setRegion(String region)
The Amazon Web Services Region that hosts the bucket.
|
void |
setReplicationDetails(ReplicationDetails replicationDetails)
Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web
Services accounts and, if so, which accounts.
|
void |
setServerSideEncryption(BucketServerSideEncryption serverSideEncryption)
Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption
that's used.
|
void |
setSharedAccess(String sharedAccess)
Specifies whether the bucket is shared with another Amazon Web Services account.
|
void |
setSizeInBytes(Long sizeInBytes)
The total storage size, in bytes, of the bucket.
|
void |
setSizeInBytesCompressed(Long sizeInBytesCompressed)
The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
|
void |
setTags(Collection<KeyValuePair> tags)
An array that specifies the tags (keys and values) that are associated with the bucket.
|
void |
setUnclassifiableObjectCount(ObjectLevelStatistics unclassifiableObjectCount)
The total number of objects that Amazon Macie can't analyze in the bucket.
|
void |
setUnclassifiableObjectSizeInBytes(ObjectLevelStatistics unclassifiableObjectSizeInBytes)
The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket.
|
void |
setVersioning(Boolean versioning)
Specifies whether versioning is enabled for the bucket.
|
String |
toString()
Returns a string representation of this object.
|
BucketMetadata |
withAccountId(String accountId)
The unique identifier for the Amazon Web Services account that owns the bucket.
|
BucketMetadata |
withAllowsUnencryptedObjectUploads(AllowsUnencryptedObjectUploads allowsUnencryptedObjectUploads)
Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are
uploaded to the bucket.
|
BucketMetadata |
withAllowsUnencryptedObjectUploads(String allowsUnencryptedObjectUploads)
Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are
uploaded to the bucket.
|
BucketMetadata |
withBucketArn(String bucketArn)
The Amazon Resource Name (ARN) of the bucket.
|
BucketMetadata |
withBucketCreatedAt(Date bucketCreatedAt)
The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
|
BucketMetadata |
withBucketName(String bucketName)
The name of the bucket.
|
BucketMetadata |
withClassifiableObjectCount(Long classifiableObjectCount)
The total number of objects that Amazon Macie can analyze in the bucket.
|
BucketMetadata |
withClassifiableSizeInBytes(Long classifiableSizeInBytes)
The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket.
|
BucketMetadata |
withErrorCode(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.
|
BucketMetadata |
withErrorCode(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.
|
BucketMetadata |
withErrorMessage(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.
|
BucketMetadata |
withJobDetails(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.
|
BucketMetadata |
withLastUpdated(Date 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.
|
BucketMetadata |
withObjectCount(Long objectCount)
The total number of objects in the bucket.
|
BucketMetadata |
withObjectCountByEncryptionType(ObjectCountByEncryptionType objectCountByEncryptionType)
The total number of objects that are in the bucket, grouped by server-side encryption type.
|
BucketMetadata |
withPublicAccess(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.
|
BucketMetadata |
withRegion(String region)
The Amazon Web Services Region that hosts the bucket.
|
BucketMetadata |
withReplicationDetails(ReplicationDetails replicationDetails)
Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web
Services accounts and, if so, which accounts.
|
BucketMetadata |
withServerSideEncryption(BucketServerSideEncryption serverSideEncryption)
Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption
that's used.
|
BucketMetadata |
withSharedAccess(SharedAccess sharedAccess)
Specifies whether the bucket is shared with another Amazon Web Services account.
|
BucketMetadata |
withSharedAccess(String sharedAccess)
Specifies whether the bucket is shared with another Amazon Web Services account.
|
BucketMetadata |
withSizeInBytes(Long sizeInBytes)
The total storage size, in bytes, of the bucket.
|
BucketMetadata |
withSizeInBytesCompressed(Long sizeInBytesCompressed)
The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.
|
BucketMetadata |
withTags(Collection<KeyValuePair> tags)
An array that specifies the tags (keys and values) that are associated with the bucket.
|
BucketMetadata |
withTags(KeyValuePair... tags)
An array that specifies the tags (keys and values) that are associated with the bucket.
|
BucketMetadata |
withUnclassifiableObjectCount(ObjectLevelStatistics unclassifiableObjectCount)
The total number of objects that Amazon Macie can't analyze in the bucket.
|
BucketMetadata |
withUnclassifiableObjectSizeInBytes(ObjectLevelStatistics unclassifiableObjectSizeInBytes)
The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket.
|
BucketMetadata |
withVersioning(Boolean versioning)
Specifies whether versioning is enabled for the bucket.
|
public void setAccountId(String accountId)
The unique identifier for the Amazon Web Services account that owns the bucket.
accountId
- The unique identifier for the Amazon Web Services account that owns the bucket.public String getAccountId()
The unique identifier for the Amazon Web Services account that owns the bucket.
public BucketMetadata withAccountId(String accountId)
The unique identifier for the Amazon Web Services account that owns the bucket.
accountId
- The unique identifier for the Amazon Web Services account that owns the bucket.public void setAllowsUnencryptedObjectUploads(String 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.
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.
AllowsUnencryptedObjectUploads
public String getAllowsUnencryptedObjectUploads()
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.
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.
AllowsUnencryptedObjectUploads
public BucketMetadata withAllowsUnencryptedObjectUploads(String 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.
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.
AllowsUnencryptedObjectUploads
public BucketMetadata withAllowsUnencryptedObjectUploads(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.
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.
AllowsUnencryptedObjectUploads
public void setBucketArn(String bucketArn)
The Amazon Resource Name (ARN) of the bucket.
bucketArn
- The Amazon Resource Name (ARN) of the bucket.public String getBucketArn()
The Amazon Resource Name (ARN) of the bucket.
public BucketMetadata withBucketArn(String bucketArn)
The Amazon Resource Name (ARN) of the bucket.
bucketArn
- The Amazon Resource Name (ARN) of the bucket.public void setBucketCreatedAt(Date bucketCreatedAt)
The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
bucketCreatedAt
- The date and time, in UTC and extended ISO 8601 format, when the bucket was created.public Date getBucketCreatedAt()
The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
public BucketMetadata withBucketCreatedAt(Date bucketCreatedAt)
The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
bucketCreatedAt
- The date and time, in UTC and extended ISO 8601 format, when the bucket was created.public void setBucketName(String bucketName)
The name of the bucket.
bucketName
- The name of the bucket.public String getBucketName()
The name of the bucket.
public BucketMetadata withBucketName(String bucketName)
The name of the bucket.
bucketName
- The name of the bucket.public void setClassifiableObjectCount(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.
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.public Long getClassifiableObjectCount()
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.
public BucketMetadata withClassifiableObjectCount(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.
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.public void setClassifiableSizeInBytes(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.
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.
public Long getClassifiableSizeInBytes()
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.
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.
public BucketMetadata withClassifiableSizeInBytes(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.
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.
public void setErrorCode(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.
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.BucketMetadataErrorCode
public String getErrorCode()
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.
BucketMetadataErrorCode
public BucketMetadata withErrorCode(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.
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.BucketMetadataErrorCode
public BucketMetadata withErrorCode(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.
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.BucketMetadataErrorCode
public void setErrorMessage(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.
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.public String getErrorMessage()
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.
public BucketMetadata withErrorMessage(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.
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.public void setJobDetails(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.
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.public JobDetails getJobDetails()
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.
public BucketMetadata withJobDetails(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.
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.public void setLastUpdated(Date 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.
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.public Date getLastUpdated()
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.
public BucketMetadata withLastUpdated(Date 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.
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.public void setObjectCount(Long objectCount)
The total number of objects in the bucket.
objectCount
- The total number of objects in the bucket.public Long getObjectCount()
The total number of objects in the bucket.
public BucketMetadata withObjectCount(Long objectCount)
The total number of objects in the bucket.
objectCount
- The total number of objects in the bucket.public void setObjectCountByEncryptionType(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.
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.public ObjectCountByEncryptionType getObjectCountByEncryptionType()
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.
public BucketMetadata withObjectCountByEncryptionType(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.
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.public void setPublicAccess(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.
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.public BucketPublicAccess getPublicAccess()
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.
public BucketMetadata withPublicAccess(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.
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.public void setRegion(String region)
The Amazon Web Services Region that hosts the bucket.
region
- The Amazon Web Services Region that hosts the bucket.public String getRegion()
The Amazon Web Services Region that hosts the bucket.
public BucketMetadata withRegion(String region)
The Amazon Web Services Region that hosts the bucket.
region
- The Amazon Web Services Region that hosts the bucket.public void setReplicationDetails(ReplicationDetails replicationDetails)
Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.
replicationDetails
- Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon
Web Services accounts and, if so, which accounts.public ReplicationDetails getReplicationDetails()
Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.
public BucketMetadata withReplicationDetails(ReplicationDetails replicationDetails)
Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.
replicationDetails
- Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon
Web Services accounts and, if so, which accounts.public void setServerSideEncryption(BucketServerSideEncryption serverSideEncryption)
Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.
serverSideEncryption
- Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side
encryption that's used.public BucketServerSideEncryption getServerSideEncryption()
Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.
public BucketMetadata withServerSideEncryption(BucketServerSideEncryption serverSideEncryption)
Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.
serverSideEncryption
- Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side
encryption that's used.public void setSharedAccess(String sharedAccess)
Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
sharedAccess
- Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
SharedAccess
public String getSharedAccess()
Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
SharedAccess
public BucketMetadata withSharedAccess(String sharedAccess)
Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
sharedAccess
- Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
SharedAccess
public BucketMetadata withSharedAccess(SharedAccess sharedAccess)
Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
sharedAccess
- Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:
EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
SharedAccess
public void setSizeInBytes(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.
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.
public Long getSizeInBytes()
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.
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.
public BucketMetadata withSizeInBytes(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.
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.
public void setSizeInBytesCompressed(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.
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.
public Long getSizeInBytesCompressed()
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.
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.
public BucketMetadata withSizeInBytesCompressed(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.
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.
public List<KeyValuePair> getTags()
An array that specifies the tags (keys and values) that are associated with the bucket.
public void setTags(Collection<KeyValuePair> tags)
An array that specifies the tags (keys and values) that are associated with the bucket.
tags
- An array that specifies the tags (keys and values) that are associated with the bucket.public BucketMetadata withTags(KeyValuePair... tags)
An array that specifies the tags (keys and values) that are associated with the bucket.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- An array that specifies the tags (keys and values) that are associated with the bucket.public BucketMetadata withTags(Collection<KeyValuePair> tags)
An array that specifies the tags (keys and values) that are associated with the bucket.
tags
- An array that specifies the tags (keys and values) that are associated with the bucket.public void setUnclassifiableObjectCount(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.
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.public ObjectLevelStatistics getUnclassifiableObjectCount()
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.
public BucketMetadata withUnclassifiableObjectCount(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.
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.public void setUnclassifiableObjectSizeInBytes(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.
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.public ObjectLevelStatistics getUnclassifiableObjectSizeInBytes()
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.
public BucketMetadata withUnclassifiableObjectSizeInBytes(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.
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.public void setVersioning(Boolean versioning)
Specifies whether versioning is enabled for the bucket.
versioning
- Specifies whether versioning is enabled for the bucket.public Boolean getVersioning()
Specifies whether versioning is enabled for the bucket.
public BucketMetadata withVersioning(Boolean versioning)
Specifies whether versioning is enabled for the bucket.
versioning
- Specifies whether versioning is enabled for the bucket.public Boolean isVersioning()
Specifies whether versioning is enabled for the bucket.
public String toString()
toString
in class Object
Object.toString()
public BucketMetadata clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.