@Generated(value="software.amazon.awssdk:codegen") public final class AwsApiGatewayMethodSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsApiGatewayMethodSettings.Builder,AwsApiGatewayMethodSettings>
Defines settings for a method for the stage.
Modifier and Type | Class and Description |
---|---|
static interface |
AwsApiGatewayMethodSettings.Builder |
Modifier and Type | Method and Description |
---|---|
static AwsApiGatewayMethodSettings.Builder |
builder() |
Boolean |
cacheDataEncrypted()
Indicates whether the cached responses are encrypted.
|
Integer |
cacheTtlInSeconds()
Specifies the time to live (TTL), in seconds, for cached responses.
|
Boolean |
cachingEnabled()
Indicates whether responses are cached and returned for requests.
|
Boolean |
dataTraceEnabled()
Indicates whether data trace logging is enabled for the method.
|
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 |
httpMethod()
The HTTP method.
|
String |
loggingLevel()
The logging level for this method.
|
Boolean |
metricsEnabled()
Indicates whether CloudWatch metrics are enabled for the method.
|
Boolean |
requireAuthorizationForCacheControl()
Indicates whether authorization is required for a cache invalidation request.
|
String |
resourcePath()
The resource path for this method.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AwsApiGatewayMethodSettings.Builder> |
serializableBuilderClass() |
Integer |
throttlingBurstLimit()
The throttling burst limit for the method.
|
Double |
throttlingRateLimit()
The throttling rate limit for the method.
|
AwsApiGatewayMethodSettings.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.
|
String |
unauthorizedCacheControlHeaderStrategy()
Indicates how to handle unauthorized requests for cache invalidation.
|
copy
public final Boolean metricsEnabled()
Indicates whether CloudWatch metrics are enabled for the method.
public final String loggingLevel()
The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.
If the logging level is ERROR
, then the logs only include error-level entries.
If the logging level is INFO
, then the logs include both ERROR
events and extra
informational events.
Valid values: OFF
| ERROR
| INFO
If the logging level is ERROR
, then the logs only include error-level entries.
If the logging level is INFO
, then the logs include both ERROR
events and extra
informational events.
Valid values: OFF
| ERROR
| INFO
public final Boolean dataTraceEnabled()
Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.
public final Integer throttlingBurstLimit()
The throttling burst limit for the method.
public final Double throttlingRateLimit()
The throttling rate limit for the method.
public final Boolean cachingEnabled()
Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.
public final Integer cacheTtlInSeconds()
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.
public final Boolean cacheDataEncrypted()
Indicates whether the cached responses are encrypted.
public final Boolean requireAuthorizationForCacheControl()
Indicates whether authorization is required for a cache invalidation request.
public final String unauthorizedCacheControlHeaderStrategy()
Indicates how to handle unauthorized requests for cache invalidation.
Valid values: FAIL_WITH_403
| SUCCEED_WITH_RESPONSE_HEADER
|
SUCCEED_WITHOUT_RESPONSE_HEADER
Valid values: FAIL_WITH_403
| SUCCEED_WITH_RESPONSE_HEADER
|
SUCCEED_WITHOUT_RESPONSE_HEADER
public final String httpMethod()
The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
public final String resourcePath()
The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.
For example, the path value /resource/subresource
must be encoded as
/~1resource~1subresource
.
To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
For example, the path value /resource/subresource
must be encoded as
/~1resource~1subresource
.
To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
public AwsApiGatewayMethodSettings.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AwsApiGatewayMethodSettings.Builder,AwsApiGatewayMethodSettings>
public static AwsApiGatewayMethodSettings.Builder builder()
public static Class<? extends AwsApiGatewayMethodSettings.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()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.