Constructor Detail

Method Detail

• startTime

   final UsageWebSearchCallsParams.Builder startTime(Long startTime)

  Start time (Unix seconds) of the query time range, inclusive.

• apiKeyIds

   final UsageWebSearchCallsParams.Builder apiKeyIds(List<String> apiKeyIds)

  Return only usage for these API keys.

• apiKeyIds

   final UsageWebSearchCallsParams.Builder apiKeyIds(Optional<List<String>> apiKeyIds)

  Alias for calling Builder.apiKeyIds with apiKeyIds.orElse(null).

• addApiKeyId

   final UsageWebSearchCallsParams.Builder addApiKeyId(String apiKeyId)

  Adds a single String to apiKeyIds.

• bucketWidth

   final UsageWebSearchCallsParams.Builder bucketWidth(UsageWebSearchCallsParams.BucketWidth bucketWidth)

  Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

• bucketWidth

   final UsageWebSearchCallsParams.Builder bucketWidth(Optional<UsageWebSearchCallsParams.BucketWidth> bucketWidth)

  Alias for calling Builder.bucketWidth with bucketWidth.orElse(null).

• contextLevels

   final UsageWebSearchCallsParams.Builder contextLevels(List<UsageWebSearchCallsParams.ContextLevel> contextLevels)

  Return only web search usage for these context levels.

• contextLevels

   final UsageWebSearchCallsParams.Builder contextLevels(Optional<List<UsageWebSearchCallsParams.ContextLevel>> contextLevels)

  Alias for calling Builder.contextLevels with contextLevels.orElse(null).

• addContextLevel

   final UsageWebSearchCallsParams.Builder addContextLevel(UsageWebSearchCallsParams.ContextLevel contextLevel)

  Adds a single ContextLevel to contextLevels.

• endTime

   final UsageWebSearchCallsParams.Builder endTime(Long endTime)

  End time (Unix seconds) of the query time range, exclusive.

• endTime

   final UsageWebSearchCallsParams.Builder endTime(Long endTime)

  Alias for Builder.endTime.

  This unboxed primitive overload exists for backwards compatibility.

• endTime

   final UsageWebSearchCallsParams.Builder endTime(Optional<Long> endTime)

  Alias for calling Builder.endTime with endTime.orElse(null).

• groupBy

   final UsageWebSearchCallsParams.Builder groupBy(List<UsageWebSearchCallsParams.GroupBy> groupBy)

  Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, context_level or any combination of them.

• groupBy

   final UsageWebSearchCallsParams.Builder groupBy(Optional<List<UsageWebSearchCallsParams.GroupBy>> groupBy)

  Alias for calling Builder.groupBy with groupBy.orElse(null).

• addGroupBy

   final UsageWebSearchCallsParams.Builder addGroupBy(UsageWebSearchCallsParams.GroupBy groupBy)

  Adds a single GroupBy to Builder.groupBy.

• limit

   final UsageWebSearchCallsParams.Builder limit(Long limit)

  Specifies the number of buckets to return.

  • bucket_width=1d: default: 7, max: 31

  • bucket_width=1h: default: 24, max: 168

  • bucket_width=1m: default: 60, max: 1440

• limit

   final UsageWebSearchCallsParams.Builder limit(Long limit)

  Alias for Builder.limit.

  This unboxed primitive overload exists for backwards compatibility.

• limit

   final UsageWebSearchCallsParams.Builder limit(Optional<Long> limit)

  Alias for calling Builder.limit with limit.orElse(null).

• models

   final UsageWebSearchCallsParams.Builder models(List<String> models)

  Return only usage for these models.

• models

   final UsageWebSearchCallsParams.Builder models(Optional<List<String>> models)

  Alias for calling Builder.models with models.orElse(null).

• addModel

   final UsageWebSearchCallsParams.Builder addModel(String model)

  Adds a single String to models.

• page

   final UsageWebSearchCallsParams.Builder page(String page)

  A cursor for use in pagination. Corresponding to the next_page field from the previous response.

• page

   final UsageWebSearchCallsParams.Builder page(Optional<String> page)

  Alias for calling Builder.page with page.orElse(null).

• projectIds

   final UsageWebSearchCallsParams.Builder projectIds(List<String> projectIds)

  Return only usage for these projects.

• projectIds

   final UsageWebSearchCallsParams.Builder projectIds(Optional<List<String>> projectIds)

  Alias for calling Builder.projectIds with projectIds.orElse(null).

• addProjectId

   final UsageWebSearchCallsParams.Builder addProjectId(String projectId)

  Adds a single String to projectIds.

• userIds

   final UsageWebSearchCallsParams.Builder userIds(List<String> userIds)

  Return only usage for these users.

• userIds

   final UsageWebSearchCallsParams.Builder userIds(Optional<List<String>> userIds)

  Alias for calling Builder.userIds with userIds.orElse(null).

• addUserId

   final UsageWebSearchCallsParams.Builder addUserId(String userId)

  Adds a single String to userIds.

• additionalHeaders

   final UsageWebSearchCallsParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final UsageWebSearchCallsParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final UsageWebSearchCallsParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final UsageWebSearchCallsParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final UsageWebSearchCallsParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final UsageWebSearchCallsParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final UsageWebSearchCallsParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final UsageWebSearchCallsParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final UsageWebSearchCallsParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final UsageWebSearchCallsParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final UsageWebSearchCallsParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final UsageWebSearchCallsParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final UsageWebSearchCallsParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final UsageWebSearchCallsParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final UsageWebSearchCallsParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final UsageWebSearchCallsParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final UsageWebSearchCallsParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final UsageWebSearchCallsParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final UsageWebSearchCallsParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final UsageWebSearchCallsParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final UsageWebSearchCallsParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final UsageWebSearchCallsParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final UsageWebSearchCallsParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final UsageWebSearchCallsParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final UsageWebSearchCallsParams build()

  Returns an immutable instance of UsageWebSearchCallsParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .startTime()