Package com.stripe.param.billing

Class MeterEventSummaryListParams.Builder

java.lang.Object
com.stripe.param.billing.MeterEventSummaryListParams.Builder
Enclosing class:
MeterEventSummaryListParams
public static class MeterEventSummaryListParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public MeterEventSummaryListParams build()
      Finalize and obtain parameter instance from this builder.

    • setCustomer

      public MeterEventSummaryListParams.Builder setCustomer(String customer)
      Required. The customer for which to fetch event summaries.

    • putDimensionFilter

      public MeterEventSummaryListParams.Builder putDimensionFilter(String key, String value)
      Add a key/value pair to `dimensionFilters` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See MeterEventSummaryListParams.dimensionFilters for the field documentation.

    • putAllDimensionFilter

      public MeterEventSummaryListParams.Builder putAllDimensionFilter(Map<String,String> map)
      Add all map key/value pairs to `dimensionFilters` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See MeterEventSummaryListParams.dimensionFilters for the field documentation.

    • addDimensionGroupByKey

      public MeterEventSummaryListParams.Builder addDimensionGroupByKey(String element)
      Add an element to `dimensionGroupByKeys` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See MeterEventSummaryListParams.dimensionGroupByKeys for the field documentation.

    • addAllDimensionGroupByKey

      public MeterEventSummaryListParams.Builder addAllDimensionGroupByKey(List<String> elements)
      Add all elements to `dimensionGroupByKeys` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See MeterEventSummaryListParams.dimensionGroupByKeys for the field documentation.

    • setEndTime

      public MeterEventSummaryListParams.Builder setEndTime(Long endTime)
      Required. The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.

    • setEndingBefore

      public MeterEventSummaryListParams.Builder setEndingBefore(String endingBefore)
      A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

    • addExpand

      public MeterEventSummaryListParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See MeterEventSummaryListParams.expand for the field documentation.

    • addAllExpand

      public MeterEventSummaryListParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See MeterEventSummaryListParams.expand for the field documentation.

    • putExtraParam

      public MeterEventSummaryListParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See MeterEventSummaryListParams.extraParams for the field documentation.

    • putAllExtraParam

      public MeterEventSummaryListParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See MeterEventSummaryListParams.extraParams for the field documentation.

    • setLimit

      public MeterEventSummaryListParams.Builder setLimit(Long limit)
      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • setStartTime

      public MeterEventSummaryListParams.Builder setStartTime(Long startTime)
      Required. The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.

    • setStartingAfter

      public MeterEventSummaryListParams.Builder setStartingAfter(String startingAfter)
      A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

    • setValueGroupingWindow

      public MeterEventSummaryListParams.Builder setValueGroupingWindow(MeterEventSummaryListParams.ValueGroupingWindow valueGroupingWindow)
      Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).