Pub/Sub Lite API . topicStats . projects . locations . topics

Instance Methods

close()

Close httplib2 connections.

computeMessageStats(topic, body=None, x__xgafv=None)

Compute statistics about a range of messages in a given topic and partition.

Method Details

close()
Close httplib2 connections.
computeMessageStats(topic, body=None, x__xgafv=None)
Compute statistics about a range of messages in a given topic and partition.

Args:
  topic: string, Required. The topic for which we should compute message stats. (required)
  body: object, The request body.
    The object takes the form of:

{ # Compute statistics about a range of messages in a given topic and partition.
  "endCursor": { # A cursor that describes the position of a message within a topic partition. # The exclusive end of the range. The range is empty if end_cursor <= start_cursor. Specifying a start_cursor before the first message and an end_cursor after the last message will retrieve all messages.
    "offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0.
  },
  "partition": "A String", # Required. The partition for which we should compute message stats.
  "startCursor": { # A cursor that describes the position of a message within a topic partition. # The inclusive start of the range.
    "offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response containing stats for messages in the requested topic and partition.
  "messageBytes": "A String", # The number of quota bytes accounted to these messages.
  "messageCount": "A String", # The count of messages.
  "minimumEventTime": "A String", # The minimum event timestamp across these messages. For the purposes of this computation, if a message does not have an event time, we use the publish time. The timestamp will be unset if there are no messages.
  "minimumPublishTime": "A String", # The minimum publish timestamp across these messages. Note that publish timestamps within a partition are not guaranteed to be non-decreasing. The timestamp will be unset if there are no messages.
}