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

Class GetGatewayResponsesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
software.amazon.awssdk.services.apigateway.model.GetGatewayResponsesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetGatewayResponsesRequest.Builder,GetGatewayResponsesRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetGatewayResponsesRequest extends ApiGatewayRequest implements ToCopyableBuilder<GetGatewayResponsesRequest.Builder,GetGatewayResponsesRequest>

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

  • Method Details

    • restApiId

      public final String restApiId()

      The string identifier of the associated RestApi.

      Returns:
      The string identifier of the associated RestApi.

    • position

      public final String position()

      The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

      Returns:
      The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

    • limit

      public final Integer limit()

      The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

      Returns:
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

    • toBuilder

      public GetGatewayResponsesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetGatewayResponsesRequest.Builder,GetGatewayResponsesRequest>
      Specified by:
      toBuilder in class ApiGatewayRequest

    • builder

      public static GetGatewayResponsesRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo