Package software.amazon.awssdk.services.securityhub.model

Class GetFindingStatisticsV2Request

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.securityhub.model.SecurityHubRequest

software.amazon.awssdk.services.securityhub.model.GetFindingStatisticsV2Request

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetFindingStatisticsV2Request.Builder,GetFindingStatisticsV2Request>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetFindingStatisticsV2Request.Builder

Method Summary

Modifier and Type	Method	Description
static GetFindingStatisticsV2Request.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<GroupByRule>	groupByRules()	Specifies how security findings should be aggregated and organized in the statistical analysis.
boolean	hasGroupByRules()	For responses, this returns true if the service returned a value for the GroupByRules property.
int	hashCode()
Integer	maxStatisticResults()	The maximum number of results to be returned.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetFindingStatisticsV2Request.Builder>	serializableBuilderClass()
SortOrder	sortOrder()	Orders the aggregation count in descending or ascending order.
String	sortOrderAsString()	Orders the aggregation count in descending or ascending order.
GetFindingStatisticsV2Request.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

hasGroupByRules

public final boolean hasGroupByRules()

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

groupByRules

public final List<GroupByRule> groupByRules()

Specifies how security findings should be aggregated and organized in the statistical analysis. It can accept up to 5 groupBy fields in a single call.

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

Returns:

Specifies how security findings should be aggregated and organized in the statistical analysis. It can accept up to 5 groupBy fields in a single call.

sortOrder

public final SortOrder sortOrder()

Orders the aggregation count in descending or ascending order. Descending order is the default.

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

Returns:

Orders the aggregation count in descending or ascending order. Descending order is the default.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

Orders the aggregation count in descending or ascending order. Descending order is the default.

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

Returns:

Orders the aggregation count in descending or ascending order. Descending order is the default.

See Also:

SortOrder

maxStatisticResults

public final Integer maxStatisticResults()

The maximum number of results to be returned.

Returns:

The maximum number of results to be returned.

toBuilder

public GetFindingStatisticsV2Request.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetFindingStatisticsV2Request.Builder,GetFindingStatisticsV2Request>

Specified by:

toBuilder in class SecurityHubRequest

builder

public static GetFindingStatisticsV2Request.Builder builder()

serializableBuilderClass

public static Class<? extends GetFindingStatisticsV2Request.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