Class IndexPolicy

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

This structure contains information about one field index policy in this account.

See Also:

  • Method Details

    • logGroupIdentifier

      public final String logGroupIdentifier()

      The ARN of the log group that this index policy applies to.

      Returns:
      The ARN of the log group that this index policy applies to.

    • lastUpdateTime

      public final Long lastUpdateTime()

      The date and time that this index policy was most recently updated.

      Returns:
      The date and time that this index policy was most recently updated.

    • policyDocument

      public final String policyDocument()

      The policy document for this index policy, in JSON format.

      Returns:
      The policy document for this index policy, in JSON format.

    • policyName

      public final String policyName()

      The name of this policy. Responses about log group-level field index policies don't have this field, because those policies don't have names.

      Returns:
      The name of this policy. Responses about log group-level field index policies don't have this field, because those policies don't have names.

    • source

      public final IndexSource source()

      This field indicates whether this is an account-level index policy or an index policy that applies only to a single log group.

      If the service returns an enum value that is not available in the current SDK version, source will return IndexSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceAsString().

      Returns:
      This field indicates whether this is an account-level index policy or an index policy that applies only to a single log group.
      See Also:

    • sourceAsString

      public final String sourceAsString()

      This field indicates whether this is an account-level index policy or an index policy that applies only to a single log group.

      If the service returns an enum value that is not available in the current SDK version, source will return IndexSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceAsString().

      Returns:
      This field indicates whether this is an account-level index policy or an index policy that applies only to a single log group.
      See Also:

    • toBuilder

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

    • builder

      public static IndexPolicy.Builder builder()

    • serializableBuilderClass

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