Class AwsApiGatewayMethodSettings

java.lang.Object
software.amazon.awssdk.services.securityhub.model.AwsApiGatewayMethodSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AwsApiGatewayMethodSettings.Builder,AwsApiGatewayMethodSettings>
@Generated("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.

See Also:

  • Method Details

    • metricsEnabled

      public final Boolean metricsEnabled()

      Indicates whether CloudWatch metrics are enabled for the method.

      Returns:
      Indicates whether CloudWatch metrics are enabled for the method.

    • loggingLevel

      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

      Returns:
      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

    • dataTraceEnabled

      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.

      Returns:
      Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

    • throttlingBurstLimit

      public final Integer throttlingBurstLimit()

      The throttling burst limit for the method.

      Returns:
      The throttling burst limit for the method.

    • throttlingRateLimit

      public final Double throttlingRateLimit()

      The throttling rate limit for the method.

      Returns:
      The throttling rate limit for the method.

    • cachingEnabled

      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.

      Returns:
      Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.

    • cacheTtlInSeconds

      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.

      Returns:
      Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.

    • cacheDataEncrypted

      public final Boolean cacheDataEncrypted()

      Indicates whether the cached responses are encrypted.

      Returns:
      Indicates whether the cached responses are encrypted.

    • requireAuthorizationForCacheControl

      public final Boolean requireAuthorizationForCacheControl()

      Indicates whether authorization is required for a cache invalidation request.

      Returns:
      Indicates whether authorization is required for a cache invalidation request.

    • unauthorizedCacheControlHeaderStrategy

      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

      Returns:
      Indicates how to handle unauthorized requests for cache invalidation.

      Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

    • httpMethod

      public final String httpMethod()

      The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

      Returns:
      The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

    • resourcePath

      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.

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

    • toBuilder

      public AwsApiGatewayMethodSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AwsApiGatewayMethodSettings.Builder,AwsApiGatewayMethodSettings>
      Returns:
      a builder for type T

    • builder

      public static AwsApiGatewayMethodSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AwsApiGatewayMethodSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.