Interface FieldIndex.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FieldIndex.Builder,FieldIndex>, SdkBuilder<FieldIndex.Builder,FieldIndex>, SdkPojo

Enclosing class:

FieldIndex

@Mutable
@NotThreadSafe
public static interface FieldIndex.Builder
extends SdkPojo, CopyableBuilder<FieldIndex.Builder,FieldIndex>

Method Summary

Modifier and Type	Method	Description
FieldIndex.Builder	fieldIndexName(String fieldIndexName)	The string that this field index matches.
FieldIndex.Builder	firstEventTime(Long firstEventTime)	The time and date of the earliest log event that matches this field index, after the index policy that contains it was created.
FieldIndex.Builder	indexCategory(String indexCategory)	The category of the field index:
FieldIndex.Builder	indexCategory(IndexCategory indexCategory)	The category of the field index:
FieldIndex.Builder	lastEventTime(Long lastEventTime)	The time and date of the most recent log event that matches this field index.
FieldIndex.Builder	lastScanTime(Long lastScanTime)	The most recent time that CloudWatch Logs scanned ingested log events to search for this field index to improve the speed of future CloudWatch Logs Insights queries that search for this field index.
FieldIndex.Builder	logGroupIdentifier(String logGroupIdentifier)	If this field index appears in an index policy that applies only to a single log group, the ARN of that log group is displayed here.
FieldIndex.Builder	type(String type)	The type of index.
FieldIndex.Builder	type(IndexType type)	The type of index.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

logGroupIdentifier

FieldIndex.Builder logGroupIdentifier(String logGroupIdentifier)

If this field index appears in an index policy that applies only to a single log group, the ARN of that log group is displayed here.

Parameters:

logGroupIdentifier - If this field index appears in an index policy that applies only to a single log group, the ARN of that log group is displayed here.

Returns:

Returns a reference to this object so that method calls can be chained together.

fieldIndexName

FieldIndex.Builder fieldIndexName(String fieldIndexName)

The string that this field index matches.

Parameters:

fieldIndexName - The string that this field index matches.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastScanTime

FieldIndex.Builder lastScanTime(Long lastScanTime)

The most recent time that CloudWatch Logs scanned ingested log events to search for this field index to improve the speed of future CloudWatch Logs Insights queries that search for this field index.

Parameters:

lastScanTime - The most recent time that CloudWatch Logs scanned ingested log events to search for this field index to improve the speed of future CloudWatch Logs Insights queries that search for this field index.

Returns:

Returns a reference to this object so that method calls can be chained together.

firstEventTime

FieldIndex.Builder firstEventTime(Long firstEventTime)

The time and date of the earliest log event that matches this field index, after the index policy that contains it was created.

Parameters:

firstEventTime - The time and date of the earliest log event that matches this field index, after the index policy that contains it was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastEventTime

FieldIndex.Builder lastEventTime(Long lastEventTime)

The time and date of the most recent log event that matches this field index.

Parameters:

lastEventTime - The time and date of the most recent log event that matches this field index.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

FieldIndex.Builder type(String type)

The type of index. Specify FACET for facet-based indexing or FIELD_INDEX for field-based indexing. This determines how the field is indexed and can be queried.

Parameters:

type - The type of index. Specify FACET for facet-based indexing or FIELD_INDEX for field-based indexing. This determines how the field is indexed and can be queried.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• IndexType
• IndexType

type

FieldIndex.Builder type(IndexType type)

The type of index. Specify FACET for facet-based indexing or FIELD_INDEX for field-based indexing. This determines how the field is indexed and can be queried.

Parameters:

type - The type of index. Specify FACET for facet-based indexing or FIELD_INDEX for field-based indexing. This determines how the field is indexed and can be queried.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• IndexType
• IndexType

indexCategory

FieldIndex.Builder indexCategory(String indexCategory)

The category of the field index:

• DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

• CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

• AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

• INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

For more information about automatically indexed fields, see Automatically indexed fields.

Parameters:

indexCategory - The category of the field index:

• DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

• CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

• AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

• INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

For more information about automatically indexed fields, see Automatically indexed fields.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• IndexCategory
• IndexCategory

indexCategory

FieldIndex.Builder indexCategory(IndexCategory indexCategory)

The category of the field index:

• DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

• CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

• AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

• INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

For more information about automatically indexed fields, see Automatically indexed fields.

Parameters:

indexCategory - The category of the field index:

• DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

• CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

• AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

• INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

For more information about automatically indexed fields, see Automatically indexed fields.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• IndexCategory
• IndexCategory