@Generated(value="software.amazon.awssdk:codegen") public class MethodSetting extends Object implements StructuredPojo, ToCopyableBuilder<MethodSetting.Builder,MethodSetting>
Specifies the method setting properties.
Modifier and Type | Class and Description |
---|---|
static interface |
MethodSetting.Builder |
Modifier and Type | Method and 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 effects the log entries pushed to Amazon
CloudWatch Logs.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
loggingLevel()
Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Boolean |
metricsEnabled()
Specifies whether Amazon CloudWatch metrics are enabled for this method.
|
Boolean |
requireAuthorizationForCacheControl()
Specifies whether authorization is required for a cache invalidation request.
|
static Class<? extends MethodSetting.Builder> |
serializableBuilderClass() |
Integer |
throttlingBurstLimit()
Specifies the throttling burst limit.
|
Double |
throttlingRateLimit()
Specifies the throttling rate limit.
|
MethodSetting.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
UnauthorizedCacheControlHeaderStrategy |
unauthorizedCacheControlHeaderStrategy()
Specifies how to handle unauthorized requests for cache invalidation.
|
String |
unauthorizedCacheControlHeaderStrategyString()
Specifies how to handle unauthorized requests for cache invalidation.
|
copy
public Boolean metricsEnabled()
Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is
/{method_setting_key}/metrics/enabled
, and the value is a Boolean.
/{method_setting_key}/metrics/enabled
, and the value is a Boolean.public String loggingLevel()
Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The
PATCH path for this setting is /{method_setting_key}/logging/loglevel
, and the available levels are
OFF
, ERROR
, and INFO
.
/{method_setting_key}/logging/loglevel
, and the
available levels are OFF
, ERROR
, and INFO
.public Boolean dataTraceEnabled()
Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon
CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace
, and the
value is a Boolean.
/{method_setting_key}/logging/dataTrace
, and the value is a Boolean.public Integer throttlingBurstLimit()
Specifies the throttling burst limit. The PATCH path for this setting is
/{method_setting_key}/throttling/burstLimit
, and the value is an integer.
/{method_setting_key}/throttling/burstLimit
, and the value is an integer.public Double throttlingRateLimit()
Specifies the throttling rate limit. The PATCH path for this setting is
/{method_setting_key}/throttling/rateLimit
, and the value is a double.
/{method_setting_key}/throttling/rateLimit
, and the value is a double.public 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. The PATCH path for this setting is
/{method_setting_key}/caching/enabled
, and the value is a Boolean.
/{method_setting_key}/caching/enabled
, and the value is a Boolean.public Integer cacheTtlInSeconds()
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response
will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds
, and
the value is an integer.
/{method_setting_key}/caching/ttlInSeconds
, and the value is an integer.public Boolean cacheDataEncrypted()
Specifies whether the cached responses are encrypted. The PATCH path for this setting is
/{method_setting_key}/caching/dataEncrypted
, and the value is a Boolean.
/{method_setting_key}/caching/dataEncrypted
, and the value is a Boolean.public Boolean requireAuthorizationForCacheControl()
Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is
/{method_setting_key}/caching/requireAuthorizationForCacheControl
, and the value is a Boolean.
/{method_setting_key}/caching/requireAuthorizationForCacheControl
, and the value
is a Boolean.public UnauthorizedCacheControlHeaderStrategy unauthorizedCacheControlHeaderStrategy()
Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is
/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy
, and the available values are
FAIL_WITH_403
, SUCCEED_WITH_RESPONSE_HEADER
,
SUCCEED_WITHOUT_RESPONSE_HEADER
.
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 unauthorizedCacheControlHeaderStrategyString()
.
/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy
, and the available
values are FAIL_WITH_403
, SUCCEED_WITH_RESPONSE_HEADER
,
SUCCEED_WITHOUT_RESPONSE_HEADER
.UnauthorizedCacheControlHeaderStrategy
public String unauthorizedCacheControlHeaderStrategyString()
Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is
/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy
, and the available values are
FAIL_WITH_403
, SUCCEED_WITH_RESPONSE_HEADER
,
SUCCEED_WITHOUT_RESPONSE_HEADER
.
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 unauthorizedCacheControlHeaderStrategyString()
.
/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy
, and the available
values are FAIL_WITH_403
, SUCCEED_WITH_RESPONSE_HEADER
,
SUCCEED_WITHOUT_RESPONSE_HEADER
.UnauthorizedCacheControlHeaderStrategy
public MethodSetting.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<MethodSetting.Builder,MethodSetting>
public static MethodSetting.Builder builder()
public static Class<? extends MethodSetting.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.