Package software.amazon.awssdk.services.cloudwatchlogs.model

Class TagFilter

java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.TagFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TagFilter.Builder,TagFilter>
@Generated("software.amazon.awssdk:codegen") public final class TagFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TagFilter.Builder,TagFilter>

A tag filter that specifies a tag key and optional tag values for filtering log groups by tags.

See Also:

  • Method Details

    • key

      public final String key()

      The tag key to filter on.

      Returns:
      The tag key to filter on.

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values 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.

    • values

      public final List<String> values()

      An optional list of tag values to filter on.

      • If you specify a filter that contains more than one value for a key, the response returns log groups that match any of the specified values for that key.

      • If you don't specify values, the response returns all log groups that are tagged with that key, with any or no value.

      • Use * for wildcard matching. For example, prod* matches values that start with prod.

      • Use ! as a prefix for negation. For example, !prod matches values that are not prod.

      • Exact matching and negation are case-sensitive. Wildcard matching is case-insensitive.

      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 hasValues() method.

      Returns:
      An optional list of tag values to filter on.

      • If you specify a filter that contains more than one value for a key, the response returns log groups that match any of the specified values for that key.

      • If you don't specify values, the response returns all log groups that are tagged with that key, with any or no value.

      • Use * for wildcard matching. For example, prod* matches values that start with prod.

      • Use ! as a prefix for negation. For example, !prod matches values that are not prod.

      • Exact matching and negation are case-sensitive. Wildcard matching is case-insensitive.

    • toBuilder

      public TagFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<TagFilter.Builder,TagFilter>

    • builder

      public static TagFilter.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TagFilter.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo