@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AwsApiGatewayMethodSettings extends Object implements Serializable, Cloneable, StructuredPojo
Defines settings for a method for the stage.
Constructor and Description |
---|
AwsApiGatewayMethodSettings() |
Modifier and Type | Method and Description |
---|---|
AwsApiGatewayMethodSettings |
clone() |
boolean |
equals(Object obj) |
Boolean |
getCacheDataEncrypted()
Indicates whether the cached responses are encrypted.
|
Integer |
getCacheTtlInSeconds()
Specifies the time to live (TTL), in seconds, for cached responses.
|
Boolean |
getCachingEnabled()
Indicates whether responses are cached and returned for requests.
|
Boolean |
getDataTraceEnabled()
Indicates whether data trace logging is enabled for the method.
|
String |
getHttpMethod()
The HTTP method.
|
String |
getLoggingLevel()
The logging level for this method.
|
Boolean |
getMetricsEnabled()
Indicates whether CloudWatch metrics are enabled for the method.
|
Boolean |
getRequireAuthorizationForCacheControl()
Indicates whether authorization is required for a cache invalidation request.
|
String |
getResourcePath()
The resource path for this method.
|
Integer |
getThrottlingBurstLimit()
The throttling burst limit for the method.
|
Double |
getThrottlingRateLimit()
The throttling rate limit for the method.
|
String |
getUnauthorizedCacheControlHeaderStrategy()
Indicates how to handle unauthorized requests for cache invalidation.
|
int |
hashCode() |
Boolean |
isCacheDataEncrypted()
Indicates whether the cached responses are encrypted.
|
Boolean |
isCachingEnabled()
Indicates whether responses are cached and returned for requests.
|
Boolean |
isDataTraceEnabled()
Indicates whether data trace logging is enabled for the method.
|
Boolean |
isMetricsEnabled()
Indicates whether CloudWatch metrics are enabled for the method.
|
Boolean |
isRequireAuthorizationForCacheControl()
Indicates whether authorization is required for a cache invalidation request.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCacheDataEncrypted(Boolean cacheDataEncrypted)
Indicates whether the cached responses are encrypted.
|
void |
setCacheTtlInSeconds(Integer cacheTtlInSeconds)
Specifies the time to live (TTL), in seconds, for cached responses.
|
void |
setCachingEnabled(Boolean cachingEnabled)
Indicates whether responses are cached and returned for requests.
|
void |
setDataTraceEnabled(Boolean dataTraceEnabled)
Indicates whether data trace logging is enabled for the method.
|
void |
setHttpMethod(String httpMethod)
The HTTP method.
|
void |
setLoggingLevel(String loggingLevel)
The logging level for this method.
|
void |
setMetricsEnabled(Boolean metricsEnabled)
Indicates whether CloudWatch metrics are enabled for the method.
|
void |
setRequireAuthorizationForCacheControl(Boolean requireAuthorizationForCacheControl)
Indicates whether authorization is required for a cache invalidation request.
|
void |
setResourcePath(String resourcePath)
The resource path for this method.
|
void |
setThrottlingBurstLimit(Integer throttlingBurstLimit)
The throttling burst limit for the method.
|
void |
setThrottlingRateLimit(Double throttlingRateLimit)
The throttling rate limit for the method.
|
void |
setUnauthorizedCacheControlHeaderStrategy(String unauthorizedCacheControlHeaderStrategy)
Indicates how to handle unauthorized requests for cache invalidation.
|
String |
toString()
Returns a string representation of this object.
|
AwsApiGatewayMethodSettings |
withCacheDataEncrypted(Boolean cacheDataEncrypted)
Indicates whether the cached responses are encrypted.
|
AwsApiGatewayMethodSettings |
withCacheTtlInSeconds(Integer cacheTtlInSeconds)
Specifies the time to live (TTL), in seconds, for cached responses.
|
AwsApiGatewayMethodSettings |
withCachingEnabled(Boolean cachingEnabled)
Indicates whether responses are cached and returned for requests.
|
AwsApiGatewayMethodSettings |
withDataTraceEnabled(Boolean dataTraceEnabled)
Indicates whether data trace logging is enabled for the method.
|
AwsApiGatewayMethodSettings |
withHttpMethod(String httpMethod)
The HTTP method.
|
AwsApiGatewayMethodSettings |
withLoggingLevel(String loggingLevel)
The logging level for this method.
|
AwsApiGatewayMethodSettings |
withMetricsEnabled(Boolean metricsEnabled)
Indicates whether CloudWatch metrics are enabled for the method.
|
AwsApiGatewayMethodSettings |
withRequireAuthorizationForCacheControl(Boolean requireAuthorizationForCacheControl)
Indicates whether authorization is required for a cache invalidation request.
|
AwsApiGatewayMethodSettings |
withResourcePath(String resourcePath)
The resource path for this method.
|
AwsApiGatewayMethodSettings |
withThrottlingBurstLimit(Integer throttlingBurstLimit)
The throttling burst limit for the method.
|
AwsApiGatewayMethodSettings |
withThrottlingRateLimit(Double throttlingRateLimit)
The throttling rate limit for the method.
|
AwsApiGatewayMethodSettings |
withUnauthorizedCacheControlHeaderStrategy(String unauthorizedCacheControlHeaderStrategy)
Indicates how to handle unauthorized requests for cache invalidation.
|
public void setMetricsEnabled(Boolean metricsEnabled)
Indicates whether CloudWatch metrics are enabled for the method.
metricsEnabled
- Indicates whether CloudWatch metrics are enabled for the method.public Boolean getMetricsEnabled()
Indicates whether CloudWatch metrics are enabled for the method.
public AwsApiGatewayMethodSettings withMetricsEnabled(Boolean metricsEnabled)
Indicates whether CloudWatch metrics are enabled for the method.
metricsEnabled
- Indicates whether CloudWatch metrics are enabled for the method.public Boolean isMetricsEnabled()
Indicates whether CloudWatch metrics are enabled for the method.
public void setLoggingLevel(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
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
public String getLoggingLevel()
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 AwsApiGatewayMethodSettings withLoggingLevel(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
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
public void setDataTraceEnabled(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.
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 Boolean getDataTraceEnabled()
Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.
public AwsApiGatewayMethodSettings withDataTraceEnabled(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.
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 Boolean isDataTraceEnabled()
Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.
public void setThrottlingBurstLimit(Integer throttlingBurstLimit)
The throttling burst limit for the method.
throttlingBurstLimit
- The throttling burst limit for the method.public Integer getThrottlingBurstLimit()
The throttling burst limit for the method.
public AwsApiGatewayMethodSettings withThrottlingBurstLimit(Integer throttlingBurstLimit)
The throttling burst limit for the method.
throttlingBurstLimit
- The throttling burst limit for the method.public void setThrottlingRateLimit(Double throttlingRateLimit)
The throttling rate limit for the method.
throttlingRateLimit
- The throttling rate limit for the method.public Double getThrottlingRateLimit()
The throttling rate limit for the method.
public AwsApiGatewayMethodSettings withThrottlingRateLimit(Double throttlingRateLimit)
The throttling rate limit for the method.
throttlingRateLimit
- The throttling rate limit for the method.public void setCachingEnabled(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.
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 Boolean getCachingEnabled()
Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.
public AwsApiGatewayMethodSettings withCachingEnabled(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.
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 Boolean isCachingEnabled()
Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.
public void setCacheTtlInSeconds(Integer cacheTtlInSeconds)
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.
cacheTtlInSeconds
- Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the
response is cached.public Integer getCacheTtlInSeconds()
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.
public AwsApiGatewayMethodSettings withCacheTtlInSeconds(Integer cacheTtlInSeconds)
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.
cacheTtlInSeconds
- Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the
response is cached.public void setCacheDataEncrypted(Boolean cacheDataEncrypted)
Indicates whether the cached responses are encrypted.
cacheDataEncrypted
- Indicates whether the cached responses are encrypted.public Boolean getCacheDataEncrypted()
Indicates whether the cached responses are encrypted.
public AwsApiGatewayMethodSettings withCacheDataEncrypted(Boolean cacheDataEncrypted)
Indicates whether the cached responses are encrypted.
cacheDataEncrypted
- Indicates whether the cached responses are encrypted.public Boolean isCacheDataEncrypted()
Indicates whether the cached responses are encrypted.
public void setRequireAuthorizationForCacheControl(Boolean requireAuthorizationForCacheControl)
Indicates whether authorization is required for a cache invalidation request.
requireAuthorizationForCacheControl
- Indicates whether authorization is required for a cache invalidation request.public Boolean getRequireAuthorizationForCacheControl()
Indicates whether authorization is required for a cache invalidation request.
public AwsApiGatewayMethodSettings withRequireAuthorizationForCacheControl(Boolean requireAuthorizationForCacheControl)
Indicates whether authorization is required for a cache invalidation request.
requireAuthorizationForCacheControl
- Indicates whether authorization is required for a cache invalidation request.public Boolean isRequireAuthorizationForCacheControl()
Indicates whether authorization is required for a cache invalidation request.
public void setUnauthorizedCacheControlHeaderStrategy(String unauthorizedCacheControlHeaderStrategy)
Indicates how to handle unauthorized requests for cache invalidation.
Valid values: FAIL_WITH_403
| SUCCEED_WITH_RESPONSE_HEADER
|
SUCCEED_WITHOUT_RESPONSE_HEADER
unauthorizedCacheControlHeaderStrategy
- Indicates how to handle unauthorized requests for cache invalidation.
Valid values: FAIL_WITH_403
| SUCCEED_WITH_RESPONSE_HEADER
|
SUCCEED_WITHOUT_RESPONSE_HEADER
public String getUnauthorizedCacheControlHeaderStrategy()
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 AwsApiGatewayMethodSettings withUnauthorizedCacheControlHeaderStrategy(String unauthorizedCacheControlHeaderStrategy)
Indicates how to handle unauthorized requests for cache invalidation.
Valid values: FAIL_WITH_403
| SUCCEED_WITH_RESPONSE_HEADER
|
SUCCEED_WITHOUT_RESPONSE_HEADER
unauthorizedCacheControlHeaderStrategy
- Indicates how to handle unauthorized requests for cache invalidation.
Valid values: FAIL_WITH_403
| SUCCEED_WITH_RESPONSE_HEADER
|
SUCCEED_WITHOUT_RESPONSE_HEADER
public void setHttpMethod(String httpMethod)
The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
httpMethod
- The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.public String getHttpMethod()
The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
public AwsApiGatewayMethodSettings withHttpMethod(String httpMethod)
The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
httpMethod
- The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.public void setResourcePath(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.
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.
public String getResourcePath()
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 withResourcePath(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.
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.
public String toString()
toString
in class Object
Object.toString()
public AwsApiGatewayMethodSettings clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.