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 structure that contains information about one pattern token related to an anomaly.

For more information about patterns and tokens, see CreateLogAnomalyDetector.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PatternToken.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PatternToken.Builder`	`builder()`
`Integer`	`dynamicTokenPosition()`	For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens.
`Map<String,Long>`	`enumerations()`	Contains the values found for a dynamic token, and the number of times each value was found.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEnumerations()`	For responses, this returns true if the service returned a value for the Enumerations property.
`int`	`hashCode()`
`String`	`inferredTokenName()`	A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable.
`Boolean`	`isDynamic()`	Specifies whether this is a dynamic token.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PatternToken.Builder>`	`serializableBuilderClass()`
`PatternToken.Builder`	`toBuilder()`
`String`	`tokenString()`	The string represented by this token.
`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
  - 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.
  - inferredTokenName
```
public final String inferredTokenName()
```
    A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of the inferredTokenName gives you a clearer idea of the content of this token. The number part of the inferredTokenName shows where in the pattern this token appears, compared to other dynamic tokens. CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.
    
    For example, an inferred token name of IPAddress-3 means that the token represents an IP address, and this token is the third dynamic token in the pattern.
    
    Returns:
    
    A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of the inferredTokenName gives you a clearer idea of the content of this token. The number part of the inferredTokenName shows where in the pattern this token appears, compared to other dynamic tokens. CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.
    
    For example, an inferred token name of IPAddress-3 means that the token represents an IP address, and this token is the third dynamic token in the pattern.
  - toBuilder
```
public PatternToken.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PatternToken.Builder,PatternToken>
  - 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)
```
    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

Class PatternToken

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

dynamicTokenPosition

isDynamic

tokenString

hasEnumerations

enumerations

inferredTokenName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField