Class AccessLogSettings

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

Access log settings, including the access log format and access log destination ARN.

See Also:

  • Method Details

    • format

      public final String format()

      A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

      Returns:
      A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

    • destinationArn

      public final String destinationArn()

      The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

      Returns:
      The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

    • toBuilder

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

    • builder

      public static AccessLogSettings.Builder builder()

    • serializableBuilderClass

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