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.GetFindingsStatisticsRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetFindingsStatisticsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static GetFindingsStatisticsRequest.Builder`	`builder()`
`String`	`detectorId()`	The ID of the detector whose findings statistics you want to retrieve.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FindingCriteria`	`findingCriteria()`	Represents the criteria that is used for querying findings.
`List<FindingStatisticType>`	`findingStatisticTypes()`	Deprecated. This parameter is deprecated, please use GroupBy instead
`List<String>`	`findingStatisticTypesAsStrings()`	Deprecated. This parameter is deprecated, please use GroupBy instead
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`GroupByType`	`groupBy()`	Displays the findings statistics grouped by one of the listed valid values.
`String`	`groupByAsString()`	Displays the findings statistics grouped by one of the listed valid values.
`boolean`	`hasFindingStatisticTypes()`	Deprecated. This parameter is deprecated, please use GroupBy instead
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of results to be returned in the response.
`OrderBy`	`orderBy()`	Displays the sorted findings in the requested order.
`String`	`orderByAsString()`	Displays the sorted findings in the requested order.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetFindingsStatisticsRequest.Builder>`	`serializableBuilderClass()`
`GetFindingsStatisticsRequest.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
  - detectorId
```
public final String detectorId()
```
    The ID of the detector whose findings statistics you want to retrieve.
    
    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
    
    Returns:
    
    The ID of the detector whose findings statistics you want to retrieve.
    
    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
  - findingStatisticTypes
```
@Deprecated
public final List<FindingStatisticType> findingStatisticTypes()
```
    Deprecated.
    This parameter is deprecated, please use GroupBy instead
    
    The types of finding statistics to retrieve.
    
    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 hasFindingStatisticTypes() method.
    
    Returns:
    
    The types of finding statistics to retrieve.
  - hasFindingStatisticTypes
```
@Deprecated
public final boolean hasFindingStatisticTypes()
```
    Deprecated.
    This parameter is deprecated, please use GroupBy instead
    
    For responses, this returns true if the service returned a value for the FindingStatisticTypes 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.
  - findingStatisticTypesAsStrings
```
@Deprecated
public final List<String> findingStatisticTypesAsStrings()
```
    Deprecated.
    This parameter is deprecated, please use GroupBy instead
    
    The types of finding statistics to retrieve.
    
    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 hasFindingStatisticTypes() method.
    
    Returns:
    
    The types of finding statistics to retrieve.
  - findingCriteria
```
public final FindingCriteria findingCriteria()
```
    Represents the criteria that is used for querying findings.
    
    Returns:
    
    Represents the criteria that is used for querying findings.
  - groupBy
```
public final GroupByType groupBy()
```
    Displays the findings statistics grouped by one of the listed valid values.
    
    If the service returns an enum value that is not available in the current SDK version, groupBy will return GroupByType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupByAsString().
    
    Returns:
    
    Displays the findings statistics grouped by one of the listed valid values.
    
    See Also:
    
    GroupByType
  - groupByAsString
```
public final String groupByAsString()
```
    Displays the findings statistics grouped by one of the listed valid values.
    
    If the service returns an enum value that is not available in the current SDK version, groupBy will return GroupByType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupByAsString().
    
    Returns:
    
    Displays the findings statistics grouped by one of the listed valid values.
    
    See Also:
    
    GroupByType
  - orderBy
```
public final OrderBy orderBy()
```
    Displays the sorted findings in the requested order. The default value of orderBy is DESC.
    
    You can use this parameter only with the groupBy parameter.
    
    If the service returns an enum value that is not available in the current SDK version, orderBy will return OrderBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderByAsString().
    
    Returns:
    
    Displays the sorted findings in the requested order. The default value of orderBy is DESC.
    
    You can use this parameter only with the groupBy parameter.
    
    See Also:
    
    OrderBy
  - orderByAsString
```
public final String orderByAsString()
```
    Displays the sorted findings in the requested order. The default value of orderBy is DESC.
    
    You can use this parameter only with the groupBy parameter.
    
    If the service returns an enum value that is not available in the current SDK version, orderBy will return OrderBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderByAsString().
    
    Returns:
    
    Displays the sorted findings in the requested order. The default value of orderBy is DESC.
    
    You can use this parameter only with the groupBy parameter.
    
    See Also:
    
    OrderBy
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to be returned in the response. The default value is 25.
    
    You can use this parameter only with the groupBy parameter.
    
    Returns:
    
    The maximum number of results to be returned in the response. The default value is 25.
    
    You can use this parameter only with the groupBy parameter.
  - toBuilder
```
public GetFindingsStatisticsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetFindingsStatisticsRequest.Builder,GetFindingsStatisticsRequest>
    
    Specified by:
    
    toBuilder in class GuardDutyRequest
  - builder
```
public static GetFindingsStatisticsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetFindingsStatisticsRequest.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 GetFindingsStatisticsRequest

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

detectorId

findingStatisticTypes

hasFindingStatisticTypes

findingStatisticTypesAsStrings

findingCriteria

groupBy

groupByAsString

orderBy

orderByAsString

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField