Class GetFindingsStatisticsRequest

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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<GetFindingsStatisticsRequest.Builder,GetFindingsStatisticsRequest>
      Specified by:
      toBuilder in class GuardDutyRequest
      Returns:
      a builder for type T

    • 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)
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.