Package software.amazon.awssdk.services.macie2.model

Class GetUsageStatisticsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.macie2.model.Macie2Response

software.amazon.awssdk.services.macie2.model.GetUsageStatisticsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUsageStatisticsResponse.Builder,GetUsageStatisticsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetUsageStatisticsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetUsageStatisticsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRecords()	For responses, this returns true if the service returned a value for the Records property.
String	nextToken()	The string to use in a subsequent request to get the next page of results in a paginated response.
List<UsageRecord>	records()	An array of objects that contains the results of the query.
List<SdkField<?>>	sdkFields()
static Class<? extends GetUsageStatisticsResponse.Builder>	serializableBuilderClass()
TimeRange	timeRange()	The inclusive time period that the usage data applies to.
String	timeRangeAsString()	The inclusive time period that the usage data applies to.
GetUsageStatisticsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.macie2.model.Macie2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

nextToken

public final String nextToken()

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

hasRecords

public final boolean hasRecords()

For responses, this returns true if the service returned a value for the Records 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.

records

public final List<UsageRecord> records()

An array of objects that contains the results of the query. Each object contains the data for an account that matches the filter criteria specified in the request.

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 hasRecords() method.

Returns:

An array of objects that contains the results of the query. Each object contains the data for an account that matches the filter criteria specified in the request.

timeRange

public final TimeRange timeRange()

The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, 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 that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

See Also:

TimeRange

timeRangeAsString

public final String timeRangeAsString()

The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, 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 that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

See Also:

TimeRange

toBuilder

public GetUsageStatisticsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetUsageStatisticsResponse.Builder,GetUsageStatisticsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetUsageStatisticsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetUsageStatisticsResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo