java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.redshift.model.RedshiftRequest
    - - software.amazon.awssdk.services.redshift.model.DescribeUsageLimitsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeUsageLimitsRequest.Builder,DescribeUsageLimitsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeUsageLimitsRequest
extends RedshiftRequest
implements ToCopyableBuilder<DescribeUsageLimitsRequest.Builder,DescribeUsageLimitsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeUsageLimitsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeUsageLimitsRequest.Builder`	`builder()`
`String`	`clusterIdentifier()`	The identifier of the cluster for which you want to describe usage limits.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`UsageLimitFeatureType`	`featureType()`	The feature type for which you want to describe usage limits.
`String`	`featureTypeAsString()`	The feature type for which you want to describe usage limits.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTagKeys()`	For responses, this returns true if the service returned a value for the TagKeys property.
`boolean`	`hasTagValues()`	For responses, this returns true if the service returned a value for the TagValues property.
`String`	`marker()`	An optional parameter that specifies the starting point to return a set of response records.
`Integer`	`maxRecords()`	The maximum number of response records to return in each call.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeUsageLimitsRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`tagKeys()`	A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys.
`List<String>`	`tagValues()`	A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values.
`DescribeUsageLimitsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`usageLimitId()`	The identifier of the usage limit to describe.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - usageLimitId
```
public final String usageLimitId()
```
    The identifier of the usage limit to describe.
    
    Returns:
    
    The identifier of the usage limit to describe.
  - clusterIdentifier
```
public final String clusterIdentifier()
```
    The identifier of the cluster for which you want to describe usage limits.
    
    Returns:
    
    The identifier of the cluster for which you want to describe usage limits.
  - featureType
```
public final UsageLimitFeatureType featureType()
```
    The feature type for which you want to describe usage limits.
    
    If the service returns an enum value that is not available in the current SDK version, featureType will return UsageLimitFeatureType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureTypeAsString().
    
    Returns:
    
    The feature type for which you want to describe usage limits.
    
    See Also:
    
    UsageLimitFeatureType
  - featureTypeAsString
```
public final String featureTypeAsString()
```
    The feature type for which you want to describe usage limits.
    
    If the service returns an enum value that is not available in the current SDK version, featureType will return UsageLimitFeatureType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from featureTypeAsString().
    
    Returns:
    
    The feature type for which you want to describe usage limits.
    
    See Also:
    
    UsageLimitFeatureType
  - maxRecords
```
public final Integer maxRecords()
```
    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
    
    Default: 100
    
    Constraints: minimum 20, maximum 100.
    
    Returns:
    
    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
    
    Default: 100
    
    Constraints: minimum 20, maximum 100.
  - marker
```
public final String marker()
```
    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
    
    Returns:
    
    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
  - hasTagKeys
```
public final boolean hasTagKeys()
```
    For responses, this returns true if the service returned a value for the TagKeys property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - tagKeys
```
public final List<String> tagKeys()
```
    A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.
    
    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 hasTagKeys() method.
    
    Returns:
    
    A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.
  - hasTagValues
```
public final boolean hasTagValues()
```
    For responses, this returns true if the service returned a value for the TagValues property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - tagValues
```
public final List<String> tagValues()
```
    A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.
    
    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 hasTagValues() method.
    
    Returns:
    
    A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.
  - toBuilder
```
public DescribeUsageLimitsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeUsageLimitsRequest.Builder,DescribeUsageLimitsRequest>
    
    Specified by:
    
    toBuilder in class RedshiftRequest
  - builder
```
public static DescribeUsageLimitsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeUsageLimitsRequest.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

Class DescribeUsageLimitsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

usageLimitId

clusterIdentifier

featureType

featureTypeAsString

maxRecords

marker

hasTagKeys

tagKeys

hasTagValues

tagValues

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields