Class FieldIndex

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

This structure describes one log event field that is used as an index in at least one index policy in this account.

See Also:

  • Method Details

    • logGroupIdentifier

      public final 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.

      Returns:
      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.

    • fieldIndexName

      public final String fieldIndexName()

      The string that this field index matches.

      Returns:
      The string that this field index matches.

    • lastScanTime

      public final 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.

      Returns:
      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.

    • firstEventTime

      public final 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.

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

    • lastEventTime

      public final Long lastEventTime()

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

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

    • toBuilder

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

    • builder

      public static FieldIndex.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.