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

Class GetUsagePlanKeysRequest

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.GetUsagePlanKeysRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetUsagePlanKeysRequest.Builder,GetUsagePlanKeysRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetUsagePlanKeysRequest extends ApiGatewayRequest implements ToCopyableBuilder<GetUsagePlanKeysRequest.Builder,GetUsagePlanKeysRequest>

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

  • Method Details

    • usagePlanId

      public final String usagePlanId()

      The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

      Returns:
      The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

    • position

      public final String position()

      The current pagination position in the paged result set.

      Returns:
      The current pagination position in the paged result set.

    • limit

      public final Integer limit()

      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

      Returns:
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

    • nameQuery

      public final String nameQuery()

      A query parameter specifying the name of the to-be-returned usage plan keys.

      Returns:
      A query parameter specifying the name of the to-be-returned usage plan keys.

    • toBuilder

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

    • builder

      public static GetUsagePlanKeysRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetUsagePlanKeysRequest.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