Class LogPublishingOption

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

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.

After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

See Also:

  • Method Details

    • cloudWatchLogsLogGroupArn

      public final String cloudWatchLogsLogGroupArn()

      The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

      Returns:
      The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

    • enabled

      public final Boolean enabled()

      Whether the log should be published.

      Returns:
      Whether the log should be published.

    • toBuilder

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

    • builder

      public static LogPublishingOption.Builder builder()

    • serializableBuilderClass

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