Constructor Detail

Method Detail

• startTime

   final UsageImagesParams.Builder startTime(Long startTime)

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

• apiKeyIds

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

  Return only usage for these API keys.

• apiKeyIds

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

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

• addApiKeyId

   final UsageImagesParams.Builder addApiKeyId(String apiKeyId)

  Adds a single String to apiKeyIds.

• bucketWidth

   final UsageImagesParams.Builder bucketWidth(UsageImagesParams.BucketWidth bucketWidth)

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

• bucketWidth

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

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

• endTime

   final UsageImagesParams.Builder endTime(Long endTime)

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

• endTime

   final UsageImagesParams.Builder endTime(Long endTime)

  Alias for Builder.endTime.

  This unboxed primitive overload exists for backwards compatibility.

• endTime

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

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

• groupBy

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

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

• groupBy

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

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

• addGroupBy

   final UsageImagesParams.Builder addGroupBy(UsageImagesParams.GroupBy groupBy)

  Adds a single GroupBy to Builder.groupBy.

• limit

   final UsageImagesParams.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 UsageImagesParams.Builder limit(Long limit)

  Alias for Builder.limit.

  This unboxed primitive overload exists for backwards compatibility.

• limit

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

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

• models

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

  Return only usage for these models.

• models

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

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

• addModel

   final UsageImagesParams.Builder addModel(String model)

  Adds a single String to models.

• page

   final UsageImagesParams.Builder page(String page)

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

• page

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

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

• projectIds

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

  Return only usage for these projects.

• projectIds

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

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

• addProjectId

   final UsageImagesParams.Builder addProjectId(String projectId)

  Adds a single String to projectIds.

• sizes

   final UsageImagesParams.Builder sizes(List<UsageImagesParams.Size> sizes)

  Return only usages for these image sizes. Possible values are 256x256, 512x512, 1024x1024, 1792x1792, 1024x1792 or any combination of them.

• sizes

   final UsageImagesParams.Builder sizes(Optional<List<UsageImagesParams.Size>> sizes)

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

• addSize

   final UsageImagesParams.Builder addSize(UsageImagesParams.Size size)

  Adds a single Size to sizes.

• sources

   final UsageImagesParams.Builder sources(List<UsageImagesParams.Source> sources)

  Return only usages for these sources. Possible values are image.generation, image.edit, image.variation or any combination of them.

• sources

   final UsageImagesParams.Builder sources(Optional<List<UsageImagesParams.Source>> sources)

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

• addSource

   final UsageImagesParams.Builder addSource(UsageImagesParams.Source source)

  Adds a single Source to sources.

• userIds

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

  Return only usage for these users.

• userIds

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

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

• addUserId

   final UsageImagesParams.Builder addUserId(String userId)

  Adds a single String to userIds.

• additionalHeaders

   final UsageImagesParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final UsageImagesParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final UsageImagesParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final UsageImagesParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final UsageImagesParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final UsageImagesParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final UsageImagesParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final UsageImagesParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final UsageImagesParams build()

  Returns an immutable instance of UsageImagesParams.

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

  The following fields are required:

  .startTime()