java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.macie2.model.Macie2Request
    - - software.amazon.awssdk.services.macie2.model.GetUsageStatisticsRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetUsageStatisticsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetUsageStatisticsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<UsageStatisticsFilter>`	`filterBy()`	An array of objects, one for each condition to use to filter the query results.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFilterBy()`	For responses, this returns true if the service returned a value for the FilterBy property.
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of items to include in each page of the response.
`String`	`nextToken()`	The nextToken string that specifies which page of results to return in a paginated response.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetUsageStatisticsRequest.Builder>`	`serializableBuilderClass()`
`UsageStatisticsSortBy`	`sortBy()`	The criteria to use to sort the query results.
`TimeRange`	`timeRange()`	The inclusive time period to query usage data for.
`String`	`timeRangeAsString()`	The inclusive time period to query usage data for.
`GetUsageStatisticsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - hasFilterBy
```
public final boolean hasFilterBy()
```
    For responses, this returns true if the service returned a value for the FilterBy 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.
  - filterBy
```
public final List<UsageStatisticsFilter> filterBy()
```
    An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.
    
    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 hasFilterBy() method.
    
    Returns:
    
    An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of items to include in each page of the response.
    
    Returns:
    
    The maximum number of items to include in each page of the response.
  - nextToken
```
public final String nextToken()
```
    The nextToken string that specifies which page of results to return in a paginated response.
    
    Returns:
    
    The nextToken string that specifies which page of results to return in a paginated response.
  - sortBy
```
public final UsageStatisticsSortBy sortBy()
```
    The criteria to use to sort the query results.
    
    Returns:
    
    The criteria to use to sort the query results.
  - timeRange
```
public final TimeRange timeRange()
```
    The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.
    
    If the service returns an enum value that is not available in the current SDK version, timeRange will return TimeRange.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeRangeAsString().
    
    Returns:
    
    The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.
    
    See Also:
    
    TimeRange
  - timeRangeAsString
```
public final String timeRangeAsString()
```
    The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.
    
    If the service returns an enum value that is not available in the current SDK version, timeRange will return TimeRange.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeRangeAsString().
    
    Returns:
    
    The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.
    
    See Also:
    
    TimeRange
  - toBuilder
```
public GetUsageStatisticsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetUsageStatisticsRequest.Builder,GetUsageStatisticsRequest>
    
    Specified by:
    
    toBuilder in class Macie2Request
  - builder
```
public static GetUsageStatisticsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetUsageStatisticsRequest.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

Class GetUsageStatisticsRequest

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

hasFilterBy

filterBy

maxResults

nextToken

sortBy

timeRange

timeRangeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField