com.amazonaws.services.macie2.model.SimpleScopeTerm 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;
/**
*
* Specifies a property-based condition that determines whether an S3 object is included or excluded from a
* classification job.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SimpleScopeTerm implements Serializable, Cloneable, StructuredPojo {
/**
*
* The operator to use in the condition. Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - EQ (equals) or NE (not equals)
*
*
* -
*
* OBJECT_KEY - STARTS_WITH
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
*
*
* -
*
* OBJECT_SIZE - Any operator except CONTAINS
*
*
*
*/
private String comparator;
/**
*
* The object property to use in the condition.
*
*/
private String key;
/**
*
* An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or
* OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise,
* this array can specify only one value.
*
*
* Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
*
*
* -
*
* OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or
* awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or
* last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
*
*
* -
*
* OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
*
*
*
*
* Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
*
*/
private java.util.List values;
/**
*
* The operator to use in the condition. Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - EQ (equals) or NE (not equals)
*
*
* -
*
* OBJECT_KEY - STARTS_WITH
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
*
*
* -
*
* OBJECT_SIZE - Any operator except CONTAINS
*
*
*
*
* @param comparator
* The operator to use in the condition. Valid values for each supported property (key) are:
*
* -
*
* OBJECT_EXTENSION - EQ (equals) or NE (not equals)
*
*
* -
*
* OBJECT_KEY - STARTS_WITH
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
*
*
* -
*
* OBJECT_SIZE - Any operator except CONTAINS
*
*
* @see JobComparator
*/
public void setComparator(String comparator) {
this.comparator = comparator;
}
/**
*
* The operator to use in the condition. Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - EQ (equals) or NE (not equals)
*
*
* -
*
* OBJECT_KEY - STARTS_WITH
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
*
*
* -
*
* OBJECT_SIZE - Any operator except CONTAINS
*
*
*
*
* @return The operator to use in the condition. Valid values for each supported property (key) are:
*
* -
*
* OBJECT_EXTENSION - EQ (equals) or NE (not equals)
*
*
* -
*
* OBJECT_KEY - STARTS_WITH
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
*
*
* -
*
* OBJECT_SIZE - Any operator except CONTAINS
*
*
* @see JobComparator
*/
public String getComparator() {
return this.comparator;
}
/**
*
* The operator to use in the condition. Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - EQ (equals) or NE (not equals)
*
*
* -
*
* OBJECT_KEY - STARTS_WITH
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
*
*
* -
*
* OBJECT_SIZE - Any operator except CONTAINS
*
*
*
*
* @param comparator
* The operator to use in the condition. Valid values for each supported property (key) are:
*
* -
*
* OBJECT_EXTENSION - EQ (equals) or NE (not equals)
*
*
* -
*
* OBJECT_KEY - STARTS_WITH
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
*
*
* -
*
* OBJECT_SIZE - Any operator except CONTAINS
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobComparator
*/
public SimpleScopeTerm withComparator(String comparator) {
setComparator(comparator);
return this;
}
/**
*
* The operator to use in the condition. Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - EQ (equals) or NE (not equals)
*
*
* -
*
* OBJECT_KEY - STARTS_WITH
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
*
*
* -
*
* OBJECT_SIZE - Any operator except CONTAINS
*
*
*
*
* @param comparator
* The operator to use in the condition. Valid values for each supported property (key) are:
*
* -
*
* OBJECT_EXTENSION - EQ (equals) or NE (not equals)
*
*
* -
*
* OBJECT_KEY - STARTS_WITH
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
*
*
* -
*
* OBJECT_SIZE - Any operator except CONTAINS
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobComparator
*/
public SimpleScopeTerm withComparator(JobComparator comparator) {
this.comparator = comparator.toString();
return this;
}
/**
*
* The object property to use in the condition.
*
*
* @param key
* The object property to use in the condition.
* @see ScopeFilterKey
*/
public void setKey(String key) {
this.key = key;
}
/**
*
* The object property to use in the condition.
*
*
* @return The object property to use in the condition.
* @see ScopeFilterKey
*/
public String getKey() {
return this.key;
}
/**
*
* The object property to use in the condition.
*
*
* @param key
* The object property to use in the condition.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScopeFilterKey
*/
public SimpleScopeTerm withKey(String key) {
setKey(key);
return this;
}
/**
*
* The object property to use in the condition.
*
*
* @param key
* The object property to use in the condition.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScopeFilterKey
*/
public SimpleScopeTerm withKey(ScopeFilterKey key) {
this.key = key.toString();
return this;
}
/**
*
* An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or
* OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise,
* this array can specify only one value.
*
*
* Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
*
*
* -
*
* OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or
* awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or
* last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
*
*
* -
*
* OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
*
*
*
*
* Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
*
*
* @return An array that lists the values to use in the condition. If the value for the key property is
* OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to
* join the values. Otherwise, this array can specify only one value.
*
* Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or
* pdf
*
*
* -
*
* OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example:
* logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the
* specified value.
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was
* created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
*
*
* -
*
* OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
*
*
*
*
* Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
*/
public java.util.List getValues() {
return values;
}
/**
*
* An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or
* OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise,
* this array can specify only one value.
*
*
* Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
*
*
* -
*
* OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or
* awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or
* last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
*
*
* -
*
* OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
*
*
*
*
* Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
*
*
* @param values
* An array that lists the values to use in the condition. If the value for the key property is
* OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to
* join the values. Otherwise, this array can specify only one value.
*
* Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
*
*
* -
*
* OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs
* or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the
* specified value.
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was
* created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
*
*
* -
*
* OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
*
*
*
*
* Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
*/
public void setValues(java.util.Collection values) {
if (values == null) {
this.values = null;
return;
}
this.values = new java.util.ArrayList(values);
}
/**
*
* An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or
* OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise,
* this array can specify only one value.
*
*
* Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
*
*
* -
*
* OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or
* awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or
* last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
*
*
* -
*
* OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
*
*
*
*
* Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setValues(java.util.Collection)} or {@link #withValues(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param values
* An array that lists the values to use in the condition. If the value for the key property is
* OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to
* join the values. Otherwise, this array can specify only one value.
*
* Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
*
*
* -
*
* OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs
* or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the
* specified value.
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was
* created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
*
*
* -
*
* OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
*
*
*
*
* Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SimpleScopeTerm withValues(String... values) {
if (this.values == null) {
setValues(new java.util.ArrayList(values.length));
}
for (String ele : values) {
this.values.add(ele);
}
return this;
}
/**
*
* An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or
* OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise,
* this array can specify only one value.
*
*
* Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
*
*
* -
*
* OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or
* awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or
* last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
*
*
* -
*
* OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
*
*
*
*
* Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
*
*
* @param values
* An array that lists the values to use in the condition. If the value for the key property is
* OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to
* join the values. Otherwise, this array can specify only one value.
*
* Valid values for each supported property (key) are:
*
*
* -
*
* OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
*
*
* -
*
* OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs
* or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the
* specified value.
*
*
* -
*
* OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was
* created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
*
*
* -
*
* OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
*
*
*
*
* Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SimpleScopeTerm withValues(java.util.Collection values) {
setValues(values);
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 (getComparator() != null)
sb.append("Comparator: ").append(getComparator()).append(",");
if (getKey() != null)
sb.append("Key: ").append(getKey()).append(",");
if (getValues() != null)
sb.append("Values: ").append(getValues());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SimpleScopeTerm == false)
return false;
SimpleScopeTerm other = (SimpleScopeTerm) obj;
if (other.getComparator() == null ^ this.getComparator() == null)
return false;
if (other.getComparator() != null && other.getComparator().equals(this.getComparator()) == false)
return false;
if (other.getKey() == null ^ this.getKey() == null)
return false;
if (other.getKey() != null && other.getKey().equals(this.getKey()) == false)
return false;
if (other.getValues() == null ^ this.getValues() == null)
return false;
if (other.getValues() != null && other.getValues().equals(this.getValues()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getComparator() == null) ? 0 : getComparator().hashCode());
hashCode = prime * hashCode + ((getKey() == null) ? 0 : getKey().hashCode());
hashCode = prime * hashCode + ((getValues() == null) ? 0 : getValues().hashCode());
return hashCode;
}
@Override
public SimpleScopeTerm clone() {
try {
return (SimpleScopeTerm) 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.SimpleScopeTermMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}