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

Class PatternToken

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

A tructures that contains information about one pattern token related to an anomaly.

For more information about patterns and tokens, see CreateLogAnomalyDetector.

See Also:

  • Method Details

    • dynamicTokenPosition

      public final Integer dynamicTokenPosition()

      For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens. The dynamic token that appears first has a value of 1, the one that appears second is 2, and so on.

      Returns:
      For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens. The dynamic token that appears first has a value of 1, the one that appears second is 2, and so on.

    • isDynamic

      public final Boolean isDynamic()

      Specifies whether this is a dynamic token.

      Returns:
      Specifies whether this is a dynamic token.

    • tokenString

      public final String tokenString()

      The string represented by this token. If this is a dynamic token, the value will be <*>

      Returns:
      The string represented by this token. If this is a dynamic token, the value will be <*>

    • hasEnumerations

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

    • enumerations

      public final Map<String,Long> enumerations()

      Contains the values found for a dynamic token, and the number of times each value was found.

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

      Returns:
      Contains the values found for a dynamic token, and the number of times each value was found.

    • toBuilder

      public PatternToken.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<PatternToken.Builder,PatternToken>
      Returns:
      a builder for type T

    • builder

      public static PatternToken.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PatternToken.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.