@Generated(value="software.amazon.awssdk:codegen") public final class MethodSetting extends Object implements SdkPojo, Serializable, 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 affects the log entries pushed to Amazon
CloudWatch Logs.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<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.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
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.
|
copy
public final 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 final String loggingLevel()
Specifies the logging level for this method, which affects 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
. 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.
/{method_setting_key}/logging/loglevel
, and the
available levels 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.public final Boolean dataTraceEnabled()
Specifies whether data trace logging is enabled for this method, which affects 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 final 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 final 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 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. 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 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. 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 final 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 final 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 final 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 unauthorizedCacheControlHeaderStrategyAsString()
.
/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy
, and the available
values are FAIL_WITH_403
, SUCCEED_WITH_RESPONSE_HEADER
,
SUCCEED_WITHOUT_RESPONSE_HEADER
.UnauthorizedCacheControlHeaderStrategy
public final String unauthorizedCacheControlHeaderStrategyAsString()
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 unauthorizedCacheControlHeaderStrategyAsString()
.
/{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 final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()