Interface PathStatistics.Builder

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

  • Method Details

    • source

      PathStatistics.Builder source(FilterSource source)

      Information about the bot filter that was applied to generate these statistics. This field is only populated when you filter by bot category, organization, or name.

      Parameters:
      source - Information about the bot filter that was applied to generate these statistics. This field is only populated when you filter by bot category, organization, or name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      default PathStatistics.Builder source(Consumer<FilterSource.Builder> source)

      Information about the bot filter that was applied to generate these statistics. This field is only populated when you filter by bot category, organization, or name.

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

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

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

    • path

      PathStatistics.Builder path(String path)

      The URI path. For example, /api/ or /api/v1/users.

      Parameters:
      path - The URI path. For example, /api/ or /api/v1/users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestCount

      PathStatistics.Builder requestCount(Long requestCount)

      The number of requests to this path within the specified time window.

      Parameters:
      requestCount - The number of requests to this path within the specified time window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • percentage

      PathStatistics.Builder percentage(Double percentage)

      The percentage of total requests that were made to this path.

      Parameters:
      percentage - The percentage of total requests that were made to this path.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • topBots

      PathStatistics.Builder topBots(Collection<BotStatistics> topBots)

      The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the NumberOfTopTrafficBotsPerPath parameter in the request.

      Parameters:
      topBots - The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the NumberOfTopTrafficBotsPerPath parameter in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • topBots

      PathStatistics.Builder topBots(BotStatistics... topBots)

      The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the NumberOfTopTrafficBotsPerPath parameter in the request.

      Parameters:
      topBots - The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the NumberOfTopTrafficBotsPerPath parameter in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • topBots

      PathStatistics.Builder topBots(Consumer<BotStatistics.Builder>... topBots)

      The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the NumberOfTopTrafficBotsPerPath parameter in the request.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to topBots(List<BotStatistics>).

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