@Generated(value="software.amazon.awssdk:codegen") public final class UpdateUsageResponse extends ApiGatewayResponse implements ToCopyableBuilder<UpdateUsageResponse.Builder,UpdateUsageResponse>
Represents the usage data of a usage plan.
| Modifier and Type | Class and Description |
|---|---|
static interface |
UpdateUsageResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static UpdateUsageResponse.Builder |
builder() |
String |
endDate()
The ending date of the usage data.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasItems()
For responses, this returns true if the service returned a value for the Items property.
|
Map<String,List<List<Long>>> |
items()
The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API
keys in a usage plan.
|
String |
position()
Returns the value of the Position property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateUsageResponse.Builder> |
serializableBuilderClass() |
String |
startDate()
The starting date of the usage data.
|
UpdateUsageResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
usagePlanId()
The plan Id associated with this usage data.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String usagePlanId()
The plan Id associated with this usage data.
public final String startDate()
The starting date of the usage data.
public final String endDate()
The ending date of the usage data.
public final String position()
public final boolean hasItems()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final Map<String,List<List<Long>>> items()
The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API
keys in a usage plan. For example,
{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key}
stands for an API key value and the daily log entry is of the format [used quota, remaining quota].
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasItems() method.
{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where
{api_key} stands for an API key value and the daily log entry is of the format
[used quota, remaining quota].public UpdateUsageResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<UpdateUsageResponse.Builder,UpdateUsageResponse>toBuilder in class AwsResponsepublic static UpdateUsageResponse.Builder builder()
public static Class<? extends UpdateUsageResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.