Class MethodSetting

    • 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.
      • setRequireAuthorizationForCacheControl

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

        Parameters:
        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.
      • getRequireAuthorizationForCacheControl

        public Boolean getRequireAuthorizationForCacheControl()

        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.

        Returns:
        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.
      • withRequireAuthorizationForCacheControl

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

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isRequireAuthorizationForCacheControl

        public Boolean isRequireAuthorizationForCacheControl()

        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.

        Returns:
        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.
      • setUnauthorizedCacheControlHeaderStrategy

        public void setUnauthorizedCacheControlHeaderStrategy​(String unauthorizedCacheControlHeaderStrategy)

        Specifies the strategy on how to handle the 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.

        Parameters:
        unauthorizedCacheControlHeaderStrategy - Specifies the strategy on how to handle the 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.
        See Also:
        UnauthorizedCacheControlHeaderStrategy
      • getUnauthorizedCacheControlHeaderStrategy

        public String getUnauthorizedCacheControlHeaderStrategy()

        Specifies the strategy on how to handle the 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.

        Returns:
        Specifies the strategy on how to handle the 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.
        See Also:
        UnauthorizedCacheControlHeaderStrategy
      • withUnauthorizedCacheControlHeaderStrategy

        public MethodSetting withUnauthorizedCacheControlHeaderStrategy​(String unauthorizedCacheControlHeaderStrategy)

        Specifies the strategy on how to handle the 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.

        Parameters:
        unauthorizedCacheControlHeaderStrategy - Specifies the strategy on how to handle the 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UnauthorizedCacheControlHeaderStrategy
      • setUnauthorizedCacheControlHeaderStrategy

        public void setUnauthorizedCacheControlHeaderStrategy​(UnauthorizedCacheControlHeaderStrategy unauthorizedCacheControlHeaderStrategy)

        Specifies the strategy on how to handle the 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.

        Parameters:
        unauthorizedCacheControlHeaderStrategy - Specifies the strategy on how to handle the 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.
        See Also:
        UnauthorizedCacheControlHeaderStrategy
      • withUnauthorizedCacheControlHeaderStrategy

        public MethodSetting withUnauthorizedCacheControlHeaderStrategy​(UnauthorizedCacheControlHeaderStrategy unauthorizedCacheControlHeaderStrategy)

        Specifies the strategy on how to handle the 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.

        Parameters:
        unauthorizedCacheControlHeaderStrategy - Specifies the strategy on how to handle the 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UnauthorizedCacheControlHeaderStrategy
      • 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()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object