software.amazon.awssdk.services.guardduty.model

Class GetUsageStatisticsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.guardduty.model.GuardDutyRequest

software.amazon.awssdk.services.guardduty.model.GetUsageStatisticsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUsageStatisticsRequest.Builder,GetUsageStatisticsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetUsageStatisticsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetUsageStatisticsRequest.Builder	builder()
String	detectorId() The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of results to return in the response.
String	nextToken() A token to use for paginating results that are returned in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends GetUsageStatisticsRequest.Builder>	serializableBuilderClass()
GetUsageStatisticsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	unit() The currency unit you would like to view your usage statistics in.
UsageCriteria	usageCriteria() Represents the criteria used for querying usage.
UsageStatisticType	usageStatisticType() The type of usage statistics to retrieve.
String	usageStatisticTypeAsString() The type of usage statistics to retrieve.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

detectorId

public final String detectorId()

The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.

Returns:

The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.

usageStatisticType

public final UsageStatisticType usageStatisticType()

The type of usage statistics to retrieve.

If the service returns an enum value that is not available in the current SDK version, usageStatisticType will return UsageStatisticType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from usageStatisticTypeAsString().

Returns:

The type of usage statistics to retrieve.

See Also:

UsageStatisticType

usageStatisticTypeAsString

public final String usageStatisticTypeAsString()

The type of usage statistics to retrieve.

If the service returns an enum value that is not available in the current SDK version, usageStatisticType will return UsageStatisticType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from usageStatisticTypeAsString().

Returns:

The type of usage statistics to retrieve.

See Also:

UsageStatisticType

usageCriteria

public final UsageCriteria usageCriteria()

Represents the criteria used for querying usage.

Returns:

Represents the criteria used for querying usage.

unit

public final String unit()

The currency unit you would like to view your usage statistics in. Current valid values are USD.

Returns:

The currency unit you would like to view your usage statistics in. Current valid values are USD.

maxResults

public final Integer maxResults()

The maximum number of results to return in the response.

Returns:

The maximum number of results to return in the response.

nextToken

public final String nextToken()

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Returns:

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

toBuilder

public GetUsageStatisticsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetUsageStatisticsRequest.Builder,GetUsageStatisticsRequest>

Specified by:

toBuilder in class GuardDutyRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.