Class LogPattern
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LogPattern.Builder,
LogPattern>
An object that defines the log patterns that belongs to a LogPatternSet
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LogPattern.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
pattern()
A regular expression that defines the log pattern.final String
The name of the log pattern.final String
The name of the log pattern.final Integer
rank()
Rank of the log pattern.static Class
<? extends LogPattern.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
patternSetName
The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
- Returns:
- The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
-
patternName
The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
- Returns:
- The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.
-
pattern
A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
- Returns:
- A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.
-
rank
Rank of the log pattern. Must be a value between
1
and1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank1
will be the first to get matched to a log line. A pattern of rank1,000,000
will be last to get matched. When you configure custom log patterns from the console, aLow
severity pattern translates to a750,000
rank. AMedium
severity pattern translates to a500,000
rank. And aHigh
severity pattern translates to a250,000
rank. Rank values less than1
or greater than1,000,000
are reserved for AWS-provided patterns.- Returns:
- Rank of the log pattern. Must be a value between
1
and1,000,000
. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank1
will be the first to get matched to a log line. A pattern of rank1,000,000
will be last to get matched. When you configure custom log patterns from the console, aLow
severity pattern translates to a750,000
rank. AMedium
severity pattern translates to a500,000
rank. And aHigh
severity pattern translates to a250,000
rank. Rank values less than1
or greater than1,000,000
are reserved for AWS-provided patterns.
-
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 interfaceToCopyableBuilder<LogPattern.Builder,
LogPattern> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-