Class MethodSetting

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

Specifies the method setting properties.

See Also:

  • Method Details

    • metricsEnabled

      public final Boolean metricsEnabled()

      Specifies whether Amazon CloudWatch metrics are enabled for this method.

      Returns:
      Specifies whether Amazon CloudWatch metrics are enabled for this method.

    • loggingLevel

      public final String loggingLevel()

      Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

      Returns:
      Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

    • dataTraceEnabled

      public final Boolean dataTraceEnabled()

      Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.

      Returns:
      Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.

    • throttlingBurstLimit

      public final Integer throttlingBurstLimit()

      Specifies the throttling burst limit.

      Returns:
      Specifies the throttling burst limit.

    • throttlingRateLimit

      public final Double throttlingRateLimit()

      Specifies the throttling rate limit.

      Returns:
      Specifies the throttling rate limit.

    • cachingEnabled

      public final Boolean cachingEnabled()

      Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.

      Returns:
      Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.

    • cacheTtlInSeconds

      public final Integer cacheTtlInSeconds()

      Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.

      Returns:
      Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.

    • cacheDataEncrypted

      public final Boolean cacheDataEncrypted()

      Specifies whether the cached responses are encrypted.

      Returns:
      Specifies whether the cached responses are encrypted.

    • requireAuthorizationForCacheControl

      public final Boolean requireAuthorizationForCacheControl()

      Specifies whether authorization is required for a cache invalidation request.

      Returns:
      Specifies whether authorization is required for a cache invalidation request.

    • unauthorizedCacheControlHeaderStrategy

      public final UnauthorizedCacheControlHeaderStrategy unauthorizedCacheControlHeaderStrategy()

      Specifies how to handle unauthorized requests for cache invalidation.

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

      Returns:
      Specifies how to handle unauthorized requests for cache invalidation.
      See Also:

    • unauthorizedCacheControlHeaderStrategyAsString

      public final String unauthorizedCacheControlHeaderStrategyAsString()

      Specifies how to handle unauthorized requests for cache invalidation.

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

      Returns:
      Specifies how to handle unauthorized requests for cache invalidation.
      See Also:

    • toBuilder

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

    • builder

      public static MethodSetting.Builder builder()

    • serializableBuilderClass

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