GetUsageRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.apigateway.model.GetUsageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetUsageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
The GET request to get the usage data of a usage plan in a specified time interval.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

GetUsageRequest()

Constructors
Constructor and Description
`GetUsageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetUsageRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getEndDate()` The ending date (e.g., 2016-12-31) of the usage data.
`String`	`getKeyId()` The Id of the API key associated with the resultant usage data.
`Integer`	`getLimit()` The maximum number of returned results per page.
`String`	`getPosition()` The current pagination position in the paged result set.
`String`	`getStartDate()` The starting date (e.g., 2016-01-01) of the usage data.
`String`	`getUsagePlanId()` The Id of the usage plan associated with the usage data.
`int`	`hashCode()`
`void`	`setEndDate(String endDate)` The ending date (e.g., 2016-12-31) of the usage data.
`void`	`setKeyId(String keyId)` The Id of the API key associated with the resultant usage data.
`void`	`setLimit(Integer limit)` The maximum number of returned results per page.
`void`	`setPosition(String position)` The current pagination position in the paged result set.
`void`	`setStartDate(String startDate)` The starting date (e.g., 2016-01-01) of the usage data.
`void`	`setUsagePlanId(String usagePlanId)` The Id of the usage plan associated with the usage data.
`String`	`toString()` Returns a string representation of this object.
`GetUsageRequest`	`withEndDate(String endDate)` The ending date (e.g., 2016-12-31) of the usage data.
`GetUsageRequest`	`withKeyId(String keyId)` The Id of the API key associated with the resultant usage data.
`GetUsageRequest`	`withLimit(Integer limit)` The maximum number of returned results per page.
`GetUsageRequest`	`withPosition(String position)` The current pagination position in the paged result set.
`GetUsageRequest`	`withStartDate(String startDate)` The starting date (e.g., 2016-01-01) of the usage data.
`GetUsageRequest`	`withUsagePlanId(String usagePlanId)` The Id of the usage plan associated with the usage data.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetUsageRequest
```
public GetUsageRequest()
```
- Method Detail
  - setUsagePlanId
```
public void setUsagePlanId(String usagePlanId)
```
    The Id of the usage plan associated with the usage data.
    
    Parameters:
    
    usagePlanId - The Id of the usage plan associated with the usage data.
  - getUsagePlanId
```
public String getUsagePlanId()
```
    The Id of the usage plan associated with the usage data.
    
    Returns:
    
    The Id of the usage plan associated with the usage data.
  - withUsagePlanId
```
public GetUsageRequest withUsagePlanId(String usagePlanId)
```
    The Id of the usage plan associated with the usage data.
    
    Parameters:
    
    usagePlanId - The Id of the usage plan associated with the usage data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyId
```
public void setKeyId(String keyId)
```
    The Id of the API key associated with the resultant usage data.
    
    Parameters:
    
    keyId - The Id of the API key associated with the resultant usage data.
  - getKeyId
```
public String getKeyId()
```
    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.
  - withKeyId
```
public GetUsageRequest withKeyId(String keyId)
```
    The Id of the API key associated with the resultant usage data.
    
    Parameters:
    
    keyId - The Id of the API key associated with the resultant usage data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartDate
```
public void setStartDate(String startDate)
```
    The starting date (e.g., 2016-01-01) of the usage data.
    
    Parameters:
    
    startDate - The starting date (e.g., 2016-01-01) of the usage data.
  - getStartDate
```
public String getStartDate()
```
    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.
  - withStartDate
```
public GetUsageRequest withStartDate(String startDate)
```
    The starting date (e.g., 2016-01-01) of the usage data.
    
    Parameters:
    
    startDate - The starting date (e.g., 2016-01-01) of the usage data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndDate
```
public void setEndDate(String endDate)
```
    The ending date (e.g., 2016-12-31) of the usage data.
    
    Parameters:
    
    endDate - The ending date (e.g., 2016-12-31) of the usage data.
  - getEndDate
```
public String getEndDate()
```
    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.
  - withEndDate
```
public GetUsageRequest withEndDate(String endDate)
```
    The ending date (e.g., 2016-12-31) of the usage data.
    
    Parameters:
    
    endDate - The ending date (e.g., 2016-12-31) of the usage data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPosition
```
public void setPosition(String position)
```
    The current pagination position in the paged result set.
    
    Parameters:
    
    position - The current pagination position in the paged result set.
  - getPosition
```
public String getPosition()
```
    The current pagination position in the paged result set.
    
    Returns:
    
    The current pagination position in the paged result set.
  - withPosition
```
public GetUsageRequest withPosition(String position)
```
    The current pagination position in the paged result set.
    
    Parameters:
    
    position - The current pagination position in the paged result set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLimit
```
public void setLimit(Integer limit)
```
    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    
    Parameters:
    
    limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
  - getLimit
```
public Integer getLimit()
```
    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.
  - withLimit
```
public GetUsageRequest withLimit(Integer limit)
```
    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    
    Parameters:
    
    limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetUsageRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.777

Class GetUsageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetUsageRequest

Method Detail

setUsagePlanId

getUsagePlanId

withUsagePlanId

setKeyId

getKeyId

withKeyId

setStartDate

getStartDate

withStartDate

setEndDate

getEndDate

withEndDate

setPosition

getPosition

withPosition

setLimit

getLimit

withLimit

toString

equals

hashCode

clone