com.amazonaws.services.apigateway.model

Class MethodSetting

java.lang.Object

com.amazonaws.services.apigateway.model.MethodSetting

All Implemented Interfaces:

Serializable, Cloneable

public class MethodSetting
extends Object
implements Serializable, Cloneable

Specifies the method setting properties.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MethodSetting()

Method Summary

Methods

Modifier and Type	Method and Description
MethodSetting	clone()
boolean	equals(Object obj)
Boolean	getCacheDataEncrypted() Specifies whether the cached responses are encrypted.
Integer	getCacheTtlInSeconds() Specifies the time to live (TTL) in seconds, for cached responses.
Boolean	getCachingEnabled() Specifies whether responses should be cached and returned for requests.
Boolean	getDataTraceEnabled() Specifies the whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
String	getLoggingLevel() Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
Boolean	getMetricsEnabled() Specifies whether Amazon CloudWatch metrics are enabled for this method.
Integer	getThrottlingBurstLimit() Specifies the throttling burst limit.
Double	getThrottlingRateLimit() Specifies the throttling rate limit.
int	hashCode()
Boolean	isCacheDataEncrypted() Specifies whether the cached responses are encrypted.
Boolean	isCachingEnabled() Specifies whether responses should be cached and returned for requests.
Boolean	isDataTraceEnabled() Specifies the whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
Boolean	isMetricsEnabled() Specifies whether Amazon CloudWatch metrics are enabled for this method.
void	setCacheDataEncrypted(Boolean cacheDataEncrypted) Specifies 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) Specifies whether responses should be cached and returned for requests.
void	setDataTraceEnabled(Boolean dataTraceEnabled) Specifies the whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
void	setLoggingLevel(String loggingLevel) Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
void	setMetricsEnabled(Boolean metricsEnabled) Specifies whether Amazon CloudWatch metrics are enabled for this method.
void	setThrottlingBurstLimit(Integer throttlingBurstLimit) Specifies the throttling burst limit.
void	setThrottlingRateLimit(Double throttlingRateLimit) Specifies the throttling rate limit.
String	toString() Returns a string representation of this object; useful for testing and debugging.
MethodSetting	withCacheDataEncrypted(Boolean cacheDataEncrypted) Specifies whether the cached responses are encrypted.
MethodSetting	withCacheTtlInSeconds(Integer cacheTtlInSeconds) Specifies the time to live (TTL) in seconds, for cached responses.
MethodSetting	withCachingEnabled(Boolean cachingEnabled) Specifies whether responses should be cached and returned for requests.
MethodSetting	withDataTraceEnabled(Boolean dataTraceEnabled) Specifies the whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
MethodSetting	withLoggingLevel(String loggingLevel) Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
MethodSetting	withMetricsEnabled(Boolean metricsEnabled) Specifies whether Amazon CloudWatch metrics are enabled for this method.
MethodSetting	withThrottlingBurstLimit(Integer throttlingBurstLimit) Specifies the throttling burst limit.
MethodSetting	withThrottlingRateLimit(Double throttlingRateLimit) Specifies the throttling rate limit.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MethodSetting

public MethodSetting()

Method Detail

setMetricsEnabled

public void setMetricsEnabled(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.

Parameters:

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.

getMetricsEnabled

public Boolean getMetricsEnabled()

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.

Returns:

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.

withMetricsEnabled

public MethodSetting withMetricsEnabled(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isMetricsEnabled

public Boolean isMetricsEnabled()

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.

Returns:

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.

setLoggingLevel

public void setLoggingLevel(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.

Parameters:

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.

getLoggingLevel

public String getLoggingLevel()

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.

Returns:

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.

withLoggingLevel

public MethodSetting withLoggingLevel(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataTraceEnabled

public void setDataTraceEnabled(Boolean dataTraceEnabled)

Specifies the 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.

Parameters:

dataTraceEnabled - Specifies the 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.

getDataTraceEnabled

public Boolean getDataTraceEnabled()

Specifies the 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.

Returns:

Specifies the 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.

withDataTraceEnabled

public MethodSetting withDataTraceEnabled(Boolean dataTraceEnabled)

Specifies the 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.

Parameters:

dataTraceEnabled - Specifies the 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDataTraceEnabled

public Boolean isDataTraceEnabled()

Specifies the 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.

Returns:

Specifies the 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.

setThrottlingBurstLimit

public void setThrottlingBurstLimit(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.

Parameters:

throttlingBurstLimit - Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

getThrottlingBurstLimit

public Integer getThrottlingBurstLimit()

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

Returns:

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

withThrottlingBurstLimit

public MethodSetting withThrottlingBurstLimit(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.

Parameters:

throttlingBurstLimit - Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

Returns:

Returns a reference to this object so that method calls can be chained together.

setThrottlingRateLimit

public void setThrottlingRateLimit(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.

Parameters:

throttlingRateLimit - Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit , and the value is a double.

getThrottlingRateLimit

public Double getThrottlingRateLimit()

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

Returns:

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

withThrottlingRateLimit

public MethodSetting withThrottlingRateLimit(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.

Parameters:

throttlingRateLimit - Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit , and the value is a double.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCachingEnabled

public void setCachingEnabled(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.

Parameters:

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.

getCachingEnabled

public Boolean getCachingEnabled()

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.

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. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

withCachingEnabled

public MethodSetting withCachingEnabled(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isCachingEnabled

public Boolean isCachingEnabled()

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.

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. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

setCacheTtlInSeconds

public void setCacheTtlInSeconds(Integer cacheTtlInSeconds)

Specifies the time to live (TTL) in seconds, for cached responses. The higher a 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.

Parameters:

cacheTtlInSeconds - Specifies the time to live (TTL) in seconds, for cached responses. The higher a 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.

getCacheTtlInSeconds

public Integer getCacheTtlInSeconds()

Specifies the time to live (TTL) in seconds, for cached responses. The higher a 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.

Returns:

Specifies the time to live (TTL) in seconds, for cached responses. The higher a 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.

withCacheTtlInSeconds

public MethodSetting withCacheTtlInSeconds(Integer cacheTtlInSeconds)

Specifies the time to live (TTL) in seconds, for cached responses. The higher a 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.

Parameters:

cacheTtlInSeconds - Specifies the time to live (TTL) in seconds, for cached responses. The higher a 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCacheDataEncrypted

public void setCacheDataEncrypted(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.

Parameters:

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.

getCacheDataEncrypted

public Boolean getCacheDataEncrypted()

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.

Returns:

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.

withCacheDataEncrypted

public MethodSetting withCacheDataEncrypted(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isCacheDataEncrypted

public Boolean isCacheDataEncrypted()

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.

Returns:

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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public MethodSetting clone()

Overrides:

clone in class Object