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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface MethodSetting.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MethodSetting.Builder`	`builder()`
`Boolean`	`cacheDataEncrypted()`	Specifies whether the cached responses are encrypted.
`Integer`	`cacheTtlInSeconds()`	Specifies the time to live (TTL), in seconds, for cached responses.
`Boolean`	`cachingEnabled()`	Specifies whether responses should be cached and returned for requests.
`Boolean`	`dataTraceEnabled()`	Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`loggingLevel()`	Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
`Boolean`	`metricsEnabled()`	Specifies whether Amazon CloudWatch metrics are enabled for this method.
`Boolean`	`requireAuthorizationForCacheControl()`	Specifies whether authorization is required for a cache invalidation request.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MethodSetting.Builder>`	`serializableBuilderClass()`
`Integer`	`throttlingBurstLimit()`	Specifies the throttling burst limit.
`Double`	`throttlingRateLimit()`	Specifies the throttling rate limit.
`MethodSetting.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`UnauthorizedCacheControlHeaderStrategy`	`unauthorizedCacheControlHeaderStrategy()`	Specifies how to handle unauthorized requests for cache invalidation.
`String`	`unauthorizedCacheControlHeaderStrategyAsString()`	Specifies how to handle unauthorized requests for cache invalidation.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    UnauthorizedCacheControlHeaderStrategy
  - 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:
    
    UnauthorizedCacheControlHeaderStrategy
  - toBuilder
```
public MethodSetting.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MethodSetting.Builder,MethodSetting>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class MethodSetting

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

metricsEnabled

loggingLevel

dataTraceEnabled

throttlingBurstLimit

throttlingRateLimit

cachingEnabled

cacheTtlInSeconds

cacheDataEncrypted

requireAuthorizationForCacheControl

unauthorizedCacheControlHeaderStrategy

unauthorizedCacheControlHeaderStrategyAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField