com.amazonaws.services.macie2.model.ResourceStatistics Maven / Gradle / Ivy
Show all versions of aws-java-sdk-macie2 Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.macie2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides statistical data for sensitive data discovery metrics that apply to an S3 bucket that Amazon Macie monitors
* and analyzes for your account. The statistics capture the results of automated sensitive data discovery activities
* that Macie has performed for the bucket. The data is available only if automated sensitive data discovery is
* currently enabled for your account.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ResourceStatistics implements Serializable, Cloneable, StructuredPojo {
/**
*
* The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.
*
*/
private Long totalBytesClassified;
/**
*
* The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects. This
* includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket
* (totalDetectionsSuppressed).
*
*/
private Long totalDetections;
/**
*
* The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring
* settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket's
* objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the
* bucket's sensitivity score.
*
*/
private Long totalDetectionsSuppressed;
/**
*
* The total number of objects that Amazon Macie has analyzed in the bucket.
*
*/
private Long totalItemsClassified;
/**
*
* The total number of the bucket's objects that Amazon Macie has found sensitive data in.
*
*/
private Long totalItemsSensitive;
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue
* or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to
* analyze for reasons reported by other statistics in the ResourceStatistics object.
*
*/
private Long totalItemsSkipped;
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with a key that Macie can't access. The objects use server-side encryption with customer-provided keys
* (SSE-C).
*
*/
private Long totalItemsSkippedInvalidEncryption;
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.
*
*/
private Long totalItemsSkippedInvalidKms;
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions
* settings for the objects or the permissions settings for the keys that were used to encrypt the objects.
*
*/
private Long totalItemsSkippedPermissionDenied;
/**
*
* The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.
*
*
* @param totalBytesClassified
* The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.
*/
public void setTotalBytesClassified(Long totalBytesClassified) {
this.totalBytesClassified = totalBytesClassified;
}
/**
*
* The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.
*
*
* @return The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.
*/
public Long getTotalBytesClassified() {
return this.totalBytesClassified;
}
/**
*
* The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.
*
*
* @param totalBytesClassified
* The total amount of data, in bytes, that Amazon Macie has analyzed in the bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceStatistics withTotalBytesClassified(Long totalBytesClassified) {
setTotalBytesClassified(totalBytesClassified);
return this;
}
/**
*
* The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects. This
* includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket
* (totalDetectionsSuppressed).
*
*
* @param totalDetections
* The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects.
* This includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket
* (totalDetectionsSuppressed).
*/
public void setTotalDetections(Long totalDetections) {
this.totalDetections = totalDetections;
}
/**
*
* The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects. This
* includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket
* (totalDetectionsSuppressed).
*
*
* @return The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects.
* This includes occurrences that are currently suppressed by the sensitivity scoring settings for the
* bucket (totalDetectionsSuppressed).
*/
public Long getTotalDetections() {
return this.totalDetections;
}
/**
*
* The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects. This
* includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket
* (totalDetectionsSuppressed).
*
*
* @param totalDetections
* The total number of occurrences of sensitive data that Amazon Macie has found in the bucket's objects.
* This includes occurrences that are currently suppressed by the sensitivity scoring settings for the bucket
* (totalDetectionsSuppressed).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceStatistics withTotalDetections(Long totalDetections) {
setTotalDetections(totalDetections);
return this;
}
/**
*
* The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring
* settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket's
* objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the
* bucket's sensitivity score.
*
*
* @param totalDetectionsSuppressed
* The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring
* settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the
* bucket's objects, but the occurrences were manually suppressed. By default, suppressed occurrences are
* excluded from the bucket's sensitivity score.
*/
public void setTotalDetectionsSuppressed(Long totalDetectionsSuppressed) {
this.totalDetectionsSuppressed = totalDetectionsSuppressed;
}
/**
*
* The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring
* settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket's
* objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the
* bucket's sensitivity score.
*
*
* @return The total number of occurrences of sensitive data that are currently suppressed by the sensitivity
* scoring settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in
* the bucket's objects, but the occurrences were manually suppressed. By default, suppressed occurrences
* are excluded from the bucket's sensitivity score.
*/
public Long getTotalDetectionsSuppressed() {
return this.totalDetectionsSuppressed;
}
/**
*
* The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring
* settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the bucket's
* objects, but the occurrences were manually suppressed. By default, suppressed occurrences are excluded from the
* bucket's sensitivity score.
*
*
* @param totalDetectionsSuppressed
* The total number of occurrences of sensitive data that are currently suppressed by the sensitivity scoring
* settings for the bucket. These represent occurrences of sensitive data that Amazon Macie found in the
* bucket's objects, but the occurrences were manually suppressed. By default, suppressed occurrences are
* excluded from the bucket's sensitivity score.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceStatistics withTotalDetectionsSuppressed(Long totalDetectionsSuppressed) {
setTotalDetectionsSuppressed(totalDetectionsSuppressed);
return this;
}
/**
*
* The total number of objects that Amazon Macie has analyzed in the bucket.
*
*
* @param totalItemsClassified
* The total number of objects that Amazon Macie has analyzed in the bucket.
*/
public void setTotalItemsClassified(Long totalItemsClassified) {
this.totalItemsClassified = totalItemsClassified;
}
/**
*
* The total number of objects that Amazon Macie has analyzed in the bucket.
*
*
* @return The total number of objects that Amazon Macie has analyzed in the bucket.
*/
public Long getTotalItemsClassified() {
return this.totalItemsClassified;
}
/**
*
* The total number of objects that Amazon Macie has analyzed in the bucket.
*
*
* @param totalItemsClassified
* The total number of objects that Amazon Macie has analyzed in the bucket.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceStatistics withTotalItemsClassified(Long totalItemsClassified) {
setTotalItemsClassified(totalItemsClassified);
return this;
}
/**
*
* The total number of the bucket's objects that Amazon Macie has found sensitive data in.
*
*
* @param totalItemsSensitive
* The total number of the bucket's objects that Amazon Macie has found sensitive data in.
*/
public void setTotalItemsSensitive(Long totalItemsSensitive) {
this.totalItemsSensitive = totalItemsSensitive;
}
/**
*
* The total number of the bucket's objects that Amazon Macie has found sensitive data in.
*
*
* @return The total number of the bucket's objects that Amazon Macie has found sensitive data in.
*/
public Long getTotalItemsSensitive() {
return this.totalItemsSensitive;
}
/**
*
* The total number of the bucket's objects that Amazon Macie has found sensitive data in.
*
*
* @param totalItemsSensitive
* The total number of the bucket's objects that Amazon Macie has found sensitive data in.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceStatistics withTotalItemsSensitive(Long totalItemsSensitive) {
setTotalItemsSensitive(totalItemsSensitive);
return this;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue
* or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to
* analyze for reasons reported by other statistics in the ResourceStatistics object.
*
*
* @param totalItemsSkipped
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level
* issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn't
* able to analyze for reasons reported by other statistics in the ResourceStatistics object.
*/
public void setTotalItemsSkipped(Long totalItemsSkipped) {
this.totalItemsSkipped = totalItemsSkipped;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue
* or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to
* analyze for reasons reported by other statistics in the ResourceStatistics object.
*
*
* @return The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level
* issue or error. For example, the object is a malformed file. This value includes objects that Macie
* wasn't able to analyze for reasons reported by other statistics in the ResourceStatistics object.
*/
public Long getTotalItemsSkipped() {
return this.totalItemsSkipped;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level issue
* or error. For example, the object is a malformed file. This value includes objects that Macie wasn't able to
* analyze for reasons reported by other statistics in the ResourceStatistics object.
*
*
* @param totalItemsSkipped
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to an object-level
* issue or error. For example, the object is a malformed file. This value includes objects that Macie wasn't
* able to analyze for reasons reported by other statistics in the ResourceStatistics object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceStatistics withTotalItemsSkipped(Long totalItemsSkipped) {
setTotalItemsSkipped(totalItemsSkipped);
return this;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with a key that Macie can't access. The objects use server-side encryption with customer-provided keys
* (SSE-C).
*
*
* @param totalItemsSkippedInvalidEncryption
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with a key that Macie can't access. The objects use server-side encryption with
* customer-provided keys (SSE-C).
*/
public void setTotalItemsSkippedInvalidEncryption(Long totalItemsSkippedInvalidEncryption) {
this.totalItemsSkippedInvalidEncryption = totalItemsSkippedInvalidEncryption;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with a key that Macie can't access. The objects use server-side encryption with customer-provided keys
* (SSE-C).
*
*
* @return The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects
* are encrypted with a key that Macie can't access. The objects use server-side encryption with
* customer-provided keys (SSE-C).
*/
public Long getTotalItemsSkippedInvalidEncryption() {
return this.totalItemsSkippedInvalidEncryption;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with a key that Macie can't access. The objects use server-side encryption with customer-provided keys
* (SSE-C).
*
*
* @param totalItemsSkippedInvalidEncryption
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with a key that Macie can't access. The objects use server-side encryption with
* customer-provided keys (SSE-C).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceStatistics withTotalItemsSkippedInvalidEncryption(Long totalItemsSkippedInvalidEncryption) {
setTotalItemsSkippedInvalidEncryption(totalItemsSkippedInvalidEncryption);
return this;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.
*
*
* @param totalItemsSkippedInvalidKms
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.
*/
public void setTotalItemsSkippedInvalidKms(Long totalItemsSkippedInvalidKms) {
this.totalItemsSkippedInvalidKms = totalItemsSkippedInvalidKms;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.
*
*
* @return The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects
* are encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.
*/
public Long getTotalItemsSkippedInvalidKms() {
return this.totalItemsSkippedInvalidKms;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.
*
*
* @param totalItemsSkippedInvalidKms
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket because the objects are
* encrypted with KMS keys that were disabled, are scheduled for deletion, or were deleted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceStatistics withTotalItemsSkippedInvalidKms(Long totalItemsSkippedInvalidKms) {
setTotalItemsSkippedInvalidKms(totalItemsSkippedInvalidKms);
return this;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions
* settings for the objects or the permissions settings for the keys that were used to encrypt the objects.
*
*
* @param totalItemsSkippedPermissionDenied
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions
* settings for the objects or the permissions settings for the keys that were used to encrypt the objects.
*/
public void setTotalItemsSkippedPermissionDenied(Long totalItemsSkippedPermissionDenied) {
this.totalItemsSkippedPermissionDenied = totalItemsSkippedPermissionDenied;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions
* settings for the objects or the permissions settings for the keys that were used to encrypt the objects.
*
*
* @return The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions
* settings for the objects or the permissions settings for the keys that were used to encrypt the objects.
*/
public Long getTotalItemsSkippedPermissionDenied() {
return this.totalItemsSkippedPermissionDenied;
}
/**
*
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions
* settings for the objects or the permissions settings for the keys that were used to encrypt the objects.
*
*
* @param totalItemsSkippedPermissionDenied
* The total number of objects that Amazon Macie wasn't able to analyze in the bucket due to the permissions
* settings for the objects or the permissions settings for the keys that were used to encrypt the objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceStatistics withTotalItemsSkippedPermissionDenied(Long totalItemsSkippedPermissionDenied) {
setTotalItemsSkippedPermissionDenied(totalItemsSkippedPermissionDenied);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTotalBytesClassified() != null)
sb.append("TotalBytesClassified: ").append(getTotalBytesClassified()).append(",");
if (getTotalDetections() != null)
sb.append("TotalDetections: ").append(getTotalDetections()).append(",");
if (getTotalDetectionsSuppressed() != null)
sb.append("TotalDetectionsSuppressed: ").append(getTotalDetectionsSuppressed()).append(",");
if (getTotalItemsClassified() != null)
sb.append("TotalItemsClassified: ").append(getTotalItemsClassified()).append(",");
if (getTotalItemsSensitive() != null)
sb.append("TotalItemsSensitive: ").append(getTotalItemsSensitive()).append(",");
if (getTotalItemsSkipped() != null)
sb.append("TotalItemsSkipped: ").append(getTotalItemsSkipped()).append(",");
if (getTotalItemsSkippedInvalidEncryption() != null)
sb.append("TotalItemsSkippedInvalidEncryption: ").append(getTotalItemsSkippedInvalidEncryption()).append(",");
if (getTotalItemsSkippedInvalidKms() != null)
sb.append("TotalItemsSkippedInvalidKms: ").append(getTotalItemsSkippedInvalidKms()).append(",");
if (getTotalItemsSkippedPermissionDenied() != null)
sb.append("TotalItemsSkippedPermissionDenied: ").append(getTotalItemsSkippedPermissionDenied());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ResourceStatistics == false)
return false;
ResourceStatistics other = (ResourceStatistics) obj;
if (other.getTotalBytesClassified() == null ^ this.getTotalBytesClassified() == null)
return false;
if (other.getTotalBytesClassified() != null && other.getTotalBytesClassified().equals(this.getTotalBytesClassified()) == false)
return false;
if (other.getTotalDetections() == null ^ this.getTotalDetections() == null)
return false;
if (other.getTotalDetections() != null && other.getTotalDetections().equals(this.getTotalDetections()) == false)
return false;
if (other.getTotalDetectionsSuppressed() == null ^ this.getTotalDetectionsSuppressed() == null)
return false;
if (other.getTotalDetectionsSuppressed() != null && other.getTotalDetectionsSuppressed().equals(this.getTotalDetectionsSuppressed()) == false)
return false;
if (other.getTotalItemsClassified() == null ^ this.getTotalItemsClassified() == null)
return false;
if (other.getTotalItemsClassified() != null && other.getTotalItemsClassified().equals(this.getTotalItemsClassified()) == false)
return false;
if (other.getTotalItemsSensitive() == null ^ this.getTotalItemsSensitive() == null)
return false;
if (other.getTotalItemsSensitive() != null && other.getTotalItemsSensitive().equals(this.getTotalItemsSensitive()) == false)
return false;
if (other.getTotalItemsSkipped() == null ^ this.getTotalItemsSkipped() == null)
return false;
if (other.getTotalItemsSkipped() != null && other.getTotalItemsSkipped().equals(this.getTotalItemsSkipped()) == false)
return false;
if (other.getTotalItemsSkippedInvalidEncryption() == null ^ this.getTotalItemsSkippedInvalidEncryption() == null)
return false;
if (other.getTotalItemsSkippedInvalidEncryption() != null
&& other.getTotalItemsSkippedInvalidEncryption().equals(this.getTotalItemsSkippedInvalidEncryption()) == false)
return false;
if (other.getTotalItemsSkippedInvalidKms() == null ^ this.getTotalItemsSkippedInvalidKms() == null)
return false;
if (other.getTotalItemsSkippedInvalidKms() != null && other.getTotalItemsSkippedInvalidKms().equals(this.getTotalItemsSkippedInvalidKms()) == false)
return false;
if (other.getTotalItemsSkippedPermissionDenied() == null ^ this.getTotalItemsSkippedPermissionDenied() == null)
return false;
if (other.getTotalItemsSkippedPermissionDenied() != null
&& other.getTotalItemsSkippedPermissionDenied().equals(this.getTotalItemsSkippedPermissionDenied()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTotalBytesClassified() == null) ? 0 : getTotalBytesClassified().hashCode());
hashCode = prime * hashCode + ((getTotalDetections() == null) ? 0 : getTotalDetections().hashCode());
hashCode = prime * hashCode + ((getTotalDetectionsSuppressed() == null) ? 0 : getTotalDetectionsSuppressed().hashCode());
hashCode = prime * hashCode + ((getTotalItemsClassified() == null) ? 0 : getTotalItemsClassified().hashCode());
hashCode = prime * hashCode + ((getTotalItemsSensitive() == null) ? 0 : getTotalItemsSensitive().hashCode());
hashCode = prime * hashCode + ((getTotalItemsSkipped() == null) ? 0 : getTotalItemsSkipped().hashCode());
hashCode = prime * hashCode + ((getTotalItemsSkippedInvalidEncryption() == null) ? 0 : getTotalItemsSkippedInvalidEncryption().hashCode());
hashCode = prime * hashCode + ((getTotalItemsSkippedInvalidKms() == null) ? 0 : getTotalItemsSkippedInvalidKms().hashCode());
hashCode = prime * hashCode + ((getTotalItemsSkippedPermissionDenied() == null) ? 0 : getTotalItemsSkippedPermissionDenied().hashCode());
return hashCode;
}
@Override
public ResourceStatistics clone() {
try {
return (ResourceStatistics) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.macie2.model.transform.ResourceStatisticsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}