Class AdvancedFieldSelector

java.lang.Object
software.amazon.awssdk.services.cloudtrail.model.AdvancedFieldSelector
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>
@Generated("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:

  • Method Details

    • field

      public final String field()

      A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.

      For more information, see AdvancedFieldSelector in the CloudTrail API Reference.

      Selectors don't support the use of wildcards like * . To match multiple values with a single condition, you may use StartsWith, EndsWith, NotStartsWith, or NotEndsWith to explicitly match the beginning or end of the event field.

      Returns:
      A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.

      For more information, see AdvancedFieldSelector in the CloudTrail API Reference.

      Selectors don't support the use of wildcards like * . To match multiple values with a single condition, you may use StartsWith, EndsWith, NotStartsWith, or NotEndsWith to explicitly match the beginning or end of the event field.

    • hasEqualsValue

      public final boolean hasEqualsValue()
      For responses, this returns true if the service returned a value for the Equals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • equalsValue

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEqualsValue() method.

      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 final boolean hasStartsWith()
      For responses, this returns true if the service returned a value for the StartsWith property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • startsWith

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStartsWith() method.

      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 final boolean hasEndsWith()
      For responses, this returns true if the service returned a value for the EndsWith property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • endsWith

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEndsWith() method.

      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 final boolean hasNotEquals()
      For responses, this returns true if the service returned a value for the NotEquals property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • notEquals

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotEquals() method.

      Returns:
      An operator that excludes events that match the exact value of the event record field specified as the value of Field.

    • hasNotStartsWith

      public final boolean hasNotStartsWith()
      For responses, this returns true if the service returned a value for the NotStartsWith property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • notStartsWith

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotStartsWith() method.

      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 final boolean hasNotEndsWith()
      For responses, this returns true if the service returned a value for the NotEndsWith property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • notEndsWith

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotEndsWith() method.

      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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AdvancedFieldSelector.Builder,AdvancedFieldSelector>
      Returns:
      a builder for type T

    • builder

      public static AdvancedFieldSelector.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AdvancedFieldSelector.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.