Interface GetFindingsStatisticsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetFindingsStatisticsRequest.Builder,GetFindingsStatisticsRequest>, GuardDutyRequest.Builder, SdkBuilder<GetFindingsStatisticsRequest.Builder,GetFindingsStatisticsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetFindingsStatisticsRequest
@Mutable @NotThreadSafe public static interface GetFindingsStatisticsRequest.Builder extends GuardDutyRequest.Builder, SdkPojo, CopyableBuilder<GetFindingsStatisticsRequest.Builder,GetFindingsStatisticsRequest>

  • Method Details

    • detectorId

      GetFindingsStatisticsRequest.Builder detectorId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • findingStatisticTypesWithStrings

      @Deprecated GetFindingsStatisticsRequest.Builder findingStatisticTypesWithStrings(Collection<String> findingStatisticTypes)
      Deprecated.
      This parameter is deprecated, please use GroupBy instead

      The types of finding statistics to retrieve.

      Parameters:
      findingStatisticTypes - The types of finding statistics to retrieve.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • findingStatisticTypesWithStrings

      @Deprecated GetFindingsStatisticsRequest.Builder findingStatisticTypesWithStrings(String... findingStatisticTypes)
      Deprecated.
      This parameter is deprecated, please use GroupBy instead

      The types of finding statistics to retrieve.

      Parameters:
      findingStatisticTypes - The types of finding statistics to retrieve.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • findingStatisticTypes

      @Deprecated GetFindingsStatisticsRequest.Builder findingStatisticTypes(Collection<FindingStatisticType> findingStatisticTypes)
      Deprecated.
      This parameter is deprecated, please use GroupBy instead

      The types of finding statistics to retrieve.

      Parameters:
      findingStatisticTypes - The types of finding statistics to retrieve.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • findingStatisticTypes

      @Deprecated GetFindingsStatisticsRequest.Builder findingStatisticTypes(FindingStatisticType... findingStatisticTypes)
      Deprecated.
      This parameter is deprecated, please use GroupBy instead

      The types of finding statistics to retrieve.

      Parameters:
      findingStatisticTypes - The types of finding statistics to retrieve.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • findingCriteria

      GetFindingsStatisticsRequest.Builder findingCriteria(FindingCriteria findingCriteria)

      Represents the criteria that is used for querying findings.

      Parameters:
      findingCriteria - Represents the criteria that is used for querying findings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • findingCriteria

      default GetFindingsStatisticsRequest.Builder findingCriteria(Consumer<FindingCriteria.Builder> findingCriteria)

      Represents the criteria that is used for querying findings.

      This is a convenience method that creates an instance of the FindingCriteria.Builder avoiding the need to create one manually via FindingCriteria.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to findingCriteria(FindingCriteria).

      Parameters:
      findingCriteria - a consumer that will call methods on FindingCriteria.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupBy

      GetFindingsStatisticsRequest.Builder groupBy(String groupBy)

      Displays the findings statistics grouped by one of the listed valid values.

      Parameters:
      groupBy - Displays the findings statistics grouped by one of the listed valid values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupBy

      GetFindingsStatisticsRequest.Builder groupBy(GroupByType groupBy)

      Displays the findings statistics grouped by one of the listed valid values.

      Parameters:
      groupBy - Displays the findings statistics grouped by one of the listed valid values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • orderBy

      GetFindingsStatisticsRequest.Builder orderBy(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • orderBy

      GetFindingsStatisticsRequest.Builder orderBy(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      GetFindingsStatisticsRequest.Builder maxResults(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetFindingsStatisticsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetFindingsStatisticsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.