Package software.amazon.awssdk.services.apigateway.model

Interface MethodSetting.Builder

    • Method Detail

      • metricsEnabled

        MethodSetting.Builder metricsEnabled​(Boolean metricsEnabled)

        Specifies whether Amazon CloudWatch metrics are enabled for this method.

        Parameters:
        metricsEnabled - Specifies whether Amazon CloudWatch metrics are enabled for this method.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • loggingLevel

        MethodSetting.Builder loggingLevel​(String loggingLevel)

        Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values 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.

        Parameters:
        loggingLevel - Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataTraceEnabled

        MethodSetting.Builder dataTraceEnabled​(Boolean dataTraceEnabled)

        Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.

        Parameters:
        dataTraceEnabled - Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • throttlingBurstLimit

        MethodSetting.Builder throttlingBurstLimit​(Integer throttlingBurstLimit)

        Specifies the throttling burst limit.

        Parameters:
        throttlingBurstLimit - Specifies the throttling burst limit.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • throttlingRateLimit

        MethodSetting.Builder throttlingRateLimit​(Double throttlingRateLimit)

        Specifies the throttling rate limit.

        Parameters:
        throttlingRateLimit - Specifies the throttling rate limit.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cachingEnabled

        MethodSetting.Builder cachingEnabled​(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.

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

      • cacheTtlInSeconds

        MethodSetting.Builder cacheTtlInSeconds​(Integer cacheTtlInSeconds)

        Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.

        Parameters:
        cacheTtlInSeconds - Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cacheDataEncrypted

        MethodSetting.Builder cacheDataEncrypted​(Boolean cacheDataEncrypted)

        Specifies whether the cached responses are encrypted.

        Parameters:
        cacheDataEncrypted - Specifies whether the cached responses are encrypted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requireAuthorizationForCacheControl

        MethodSetting.Builder requireAuthorizationForCacheControl​(Boolean requireAuthorizationForCacheControl)

        Specifies whether authorization is required for a cache invalidation request.

        Parameters:
        requireAuthorizationForCacheControl - Specifies whether authorization is required for a cache invalidation request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • unauthorizedCacheControlHeaderStrategy

        MethodSetting.Builder unauthorizedCacheControlHeaderStrategy​(String unauthorizedCacheControlHeaderStrategy)

        Specifies how to handle unauthorized requests for cache invalidation.

        Parameters:
        unauthorizedCacheControlHeaderStrategy - Specifies how to handle unauthorized requests for cache invalidation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UnauthorizedCacheControlHeaderStrategy, UnauthorizedCacheControlHeaderStrategy