Class GetUsageRequest

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

The GET request to get the usage data of a usage plan in a specified time interval.

  • Method Details

    • usagePlanId

      public final String usagePlanId()

      The Id of the usage plan associated with the usage data.

      Returns:
      The Id of the usage plan associated with the usage data.

    • keyId

      public final String keyId()

      The Id of the API key associated with the resultant usage data.

      Returns:
      The Id of the API key associated with the resultant usage data.

    • startDate

      public final String startDate()

      The starting date (e.g., 2016-01-01) of the usage data.

      Returns:
      The starting date (e.g., 2016-01-01) of the usage data.

    • endDate

      public final String endDate()

      The ending date (e.g., 2016-12-31) of the usage data.

      Returns:
      The ending date (e.g., 2016-12-31) of the usage data.

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

    • toBuilder

      public GetUsageRequest.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<GetUsageRequest.Builder,GetUsageRequest>
      Specified by:
      toBuilder in class ApiGatewayRequest
      Returns:
      a builder for type T

    • builder

      public static GetUsageRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetUsageRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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