AdvancedFieldSelector (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.cloudtrail.model.AdvancedFieldSelector

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>

@Generated(value="software.amazon.awssdk:codegen")
public final class AdvancedFieldSelector
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>

A single selector statement in an advanced event selector.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AdvancedFieldSelector.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AdvancedFieldSelector.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AdvancedFieldSelector.Builder`	`builder()`
`List<String>`	`endsWith()` An operator that includes events that match the last few characters of the event record field specified as the value of `Field`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`equalsValue()` An operator that includes events that match the exact value of the event record field specified as the value of `Field`.
`String`	`field()` A field in an event record on which to filter events to be logged.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEndsWith()` Returns true if the EndsWith property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEqualsValue()` Returns true if the Equals property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasNotEndsWith()` Returns true if the NotEndsWith property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasNotEquals()` Returns true if the NotEquals property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasNotStartsWith()` Returns true if the NotStartsWith property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasStartsWith()` Returns true if the StartsWith property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`notEndsWith()` An operator that excludes events that match the last few characters of the event record field specified as the value of `Field`.
`List<String>`	`notEquals()` An operator that excludes events that match the exact value of the event record field specified as the value of `Field`.
`List<String>`	`notStartsWith()` An operator that excludes events that match the first few characters of the event record field specified as the value of `Field`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AdvancedFieldSelector.Builder>`	`serializableBuilderClass()`
`List<String>`	`startsWith()` An operator that includes events that match the first few characters of the event record field specified as the value of `Field`.
`AdvancedFieldSelector.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - field
```
public String field()
```
    A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
    - readOnly - Optional. Can be set to Equals a value of true or false. A value of false logs both read and write events.
    - eventSource - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com.
    - eventName - Can use any operator. You can use it to ﬁlter in or ﬁlter out any data event logged to CloudTrail, such as PutBucket. You can have multiple values for this ﬁeld, separated by commas.
    - eventCategory - This is required. It must be set to Equals, and the value must be Management or Data.
    - resources.type - This ﬁeld is required. resources.type can only use the Equals operator, and the value can be one of the following: AWS::S3::Object or AWS::Lambda::Function. You can have only one resources.type ﬁeld per selector. To log data events on more than one resource type, add another selector.
    - resources.ARN - You can use any operator with resources.ARN, but if you use Equals or NotEquals, the value must exactly match the ARN of a valid resource of the type you've speciﬁed in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object, the ARN must be in one of the following formats. The trailing slash is intentional; do not exclude it.
      
      arn:partition:s3:::bucket_name/
      
      arn:partition:s3:::bucket_name/object_or_file_name/
      
      When resources.type equals AWS::Lambda::Function, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
      
      arn:partition:lambda:region:account_ID:function:function_name
    Returns:
    A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.
    
    readOnly - Optional. Can be set to Equals a value of true or false. A value of false logs both read and write events.
    
    eventSource - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com.
    
    eventName - Can use any operator. You can use it to ﬁlter in or ﬁlter out any data event logged to CloudTrail, such as PutBucket. You can have multiple values for this ﬁeld, separated by commas.
    
    eventCategory - This is required. It must be set to Equals, and the value must be Management or Data.
    
    resources.type - This ﬁeld is required. resources.type can only use the Equals operator, and the value can be one of the following: AWS::S3::Object or AWS::Lambda::Function. You can have only one resources.type ﬁeld per selector. To log data events on more than one resource type, add another selector.
    
    resources.ARN - You can use any operator with resources.ARN, but if you use Equals or NotEquals, the value must exactly match the ARN of a valid resource of the type you've speciﬁed in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object, the ARN must be in one of the following formats. The trailing slash is intentional; do not exclude it.
    
    arn:partition:s3:::bucket_name/
    
    arn:partition:s3:::bucket_name/object_or_file_name/
    
    When resources.type equals AWS::Lambda::Function, and the operator is set to Equals or NotEquals, the ARN must be in the following format:
    
    arn:partition:lambda:region:account_ID:function:function_name
  - hasEqualsValue
```
public boolean hasEqualsValue()
```
    Returns true if the Equals property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - equalsValue
```
public List<String> equalsValue()
```
    An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEqualsValue() to see if a value was sent in this field.
    
    Returns:
    
    An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.
  - hasStartsWith
```
public boolean hasStartsWith()
```
    Returns true if the StartsWith property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - startsWith
```
public List<String> startsWith()
```
    An operator that includes events that match the first few characters of the event record field specified as the value of Field.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasStartsWith() to see if a value was sent in this field.
    
    Returns:
    
    An operator that includes events that match the first few characters of the event record field specified as the value of Field.
  - hasEndsWith
```
public boolean hasEndsWith()
```
    Returns true if the EndsWith property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - endsWith
```
public List<String> endsWith()
```
    An operator that includes events that match the last few characters of the event record field specified as the value of Field.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEndsWith() to see if a value was sent in this field.
    
    Returns:
    
    An operator that includes events that match the last few characters of the event record field specified as the value of Field.
  - hasNotEquals
```
public boolean hasNotEquals()
```
    Returns true if the NotEquals property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - notEquals
```
public List<String> notEquals()
```
    An operator that excludes events that match the exact value of the event record field specified as the value of Field.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNotEquals() to see if a value was sent in this field.
    
    Returns:
    
    An operator that excludes events that match the exact value of the event record field specified as the value of Field.
  - hasNotStartsWith
```
public boolean hasNotStartsWith()
```
    Returns true if the NotStartsWith property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - notStartsWith
```
public List<String> notStartsWith()
```
    An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNotStartsWith() to see if a value was sent in this field.
    
    Returns:
    
    An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
  - hasNotEndsWith
```
public boolean hasNotEndsWith()
```
    Returns true if the NotEndsWith property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - notEndsWith
```
public List<String> notEndsWith()
```
    An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNotEndsWith() to see if a value was sent in this field.
    
    Returns:
    
    An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
  - toBuilder
```
public AdvancedFieldSelector.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>
  - builder
```
public static AdvancedFieldSelector.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AdvancedFieldSelector.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AdvancedFieldSelector

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

field

hasEqualsValue

equalsValue

hasStartsWith

startsWith

hasEndsWith

endsWith

hasNotEquals

notEquals

hasNotStartsWith

notStartsWith

hasNotEndsWith

notEndsWith

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields