Class PutIndexPolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest
software.amazon.awssdk.services.cloudwatchlogs.model.PutIndexPolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutIndexPolicyRequest.Builder,PutIndexPolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutIndexPolicyRequest extends CloudWatchLogsRequest implements ToCopyableBuilder<PutIndexPolicyRequest.Builder,PutIndexPolicyRequest>

  • Method Details

    • logGroupIdentifier

      public final String logGroupIdentifier()

      Specify either the log group name or log group ARN to apply this field index policy to. If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

      Returns:
      Specify either the log group name or log group ARN to apply this field index policy to. If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

    • policyDocument

      public final String policyDocument()

      The index policy document, in JSON format. The following is an example of an index policy document that creates two indexes, RequestId and TransactionId.

      "policyDocument": "{ "Fields": [ "RequestId", "TransactionId" ] }"

      The policy document must include at least one field index. For more information about the fields that can be included and other restrictions, see Field index syntax and quotas.

      Returns:
      The index policy document, in JSON format. The following is an example of an index policy document that creates two indexes, RequestId and TransactionId.

      "policyDocument": "{ "Fields": [ "RequestId", "TransactionId" ] }"

      The policy document must include at least one field index. For more information about the fields that can be included and other restrictions, see Field index syntax and quotas.

    • toBuilder

      public PutIndexPolicyRequest.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<PutIndexPolicyRequest.Builder,PutIndexPolicyRequest>
      Specified by:
      toBuilder in class CloudWatchLogsRequest
      Returns:
      a builder for type T

    • builder

      public static PutIndexPolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutIndexPolicyRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.