SimpleScopeTerm (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.macie2.model.SimpleScopeTerm

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SimpleScopeTerm
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SimpleScopeTerm()

Constructors
Constructor and Description
`SimpleScopeTerm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SimpleScopeTerm`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getComparator()` The operator to use in the condition.
`String`	`getKey()` The object property to use in the condition.
`List<String>`	`getValues()` An array that lists the values to use in the condition.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setComparator(String comparator)` The operator to use in the condition.
`void`	`setKey(String key)` The object property to use in the condition.
`void`	`setValues(Collection<String> values)` An array that lists the values to use in the condition.
`String`	`toString()` Returns a string representation of this object.
`SimpleScopeTerm`	`withComparator(JobComparator comparator)` The operator to use in the condition.
`SimpleScopeTerm`	`withComparator(String comparator)` The operator to use in the condition.
`SimpleScopeTerm`	`withKey(ScopeFilterKey key)` The object property to use in the condition.
`SimpleScopeTerm`	`withKey(String key)` The object property to use in the condition.
`SimpleScopeTerm`	`withValues(Collection<String> values)` An array that lists the values to use in the condition.
`SimpleScopeTerm`	`withValues(String... values)` An array that lists the values to use in the condition.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SimpleScopeTerm
```
public SimpleScopeTerm()
```
- Method Detail
  - setComparator
```
public void setComparator(String 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
    Parameters:
    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 Also:
    
    JobComparator
  - getComparator
```
public String getComparator()
```
    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
    Returns:
    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 Also:
    
    JobComparator
  - withComparator
```
public SimpleScopeTerm withComparator(String 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobComparator
  - withComparator
```
public SimpleScopeTerm withComparator(JobComparator 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobComparator
  - setKey
```
public void setKey(String key)
```
    The object property to use in the condition.
    
    Parameters:
    
    key - The object property to use in the condition.
    
    See Also:
    
    ScopeFilterKey
  - getKey
```
public String getKey()
```
    The object property to use in the condition.
    
    Returns:
    
    The object property to use in the condition.
    
    See Also:
    
    ScopeFilterKey
  - withKey
```
public SimpleScopeTerm withKey(String key)
```
    The object property to use in the condition.
    
    Parameters:
    
    key - The object property to use in the condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScopeFilterKey
  - withKey
```
public SimpleScopeTerm withKey(ScopeFilterKey key)
```
    The object property to use in the condition.
    
    Parameters:
    
    key - The object property to use in the condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScopeFilterKey
  - getValues
```
public List<String> getValues()
```
    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.
    Returns:
    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.
  - setValues
```
public void setValues(Collection<String> 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.
    Parameters:
    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.
  - withValues
```
public SimpleScopeTerm withValues(String... 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 setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValues
```
public SimpleScopeTerm withValues(Collection<String> 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SimpleScopeTerm clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class SimpleScopeTerm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleScopeTerm

Method Detail

setComparator

getComparator

withComparator

withComparator

setKey

getKey

withKey

withKey

getValues

setValues

withValues

withValues

toString

equals

hashCode

clone

marshall