View Source GoogleApi.PubSubLite.V1.Api.TopicStats (google_api_pub_sub_lite v0.9.0)
API calls for all endpoints tagged TopicStats
.
Summary
Functions
Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.
Compute statistics about a range of messages in a given topic and partition.
Compute the corresponding cursor for a publish or event time in a topic partition.
Functions
pubsublite_topic_stats_projects_locations_topics_compute_head_cursor(connection, topic, optional_params \\ [], opts \\ [])
View Source@spec pubsublite_topic_stats_projects_locations_topics_compute_head_cursor( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PubSubLite.V1.Model.ComputeHeadCursorResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.
Parameters
-
connection
(type:GoogleApi.PubSubLite.V1.Connection.t
) - Connection to server -
topic
(type:String.t
) - Required. The topic for which we should compute the head cursor. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.PubSubLite.V1.Model.ComputeHeadCursorRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.PubSubLite.V1.Model.ComputeHeadCursorResponse{}}
on success -
{:error, info}
on failure
pubsublite_topic_stats_projects_locations_topics_compute_message_stats(connection, topic, optional_params \\ [], opts \\ [])
View Source@spec pubsublite_topic_stats_projects_locations_topics_compute_message_stats( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PubSubLite.V1.Model.ComputeMessageStatsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Compute statistics about a range of messages in a given topic and partition.
Parameters
-
connection
(type:GoogleApi.PubSubLite.V1.Connection.t
) - Connection to server -
topic
(type:String.t
) - Required. The topic for which we should compute message stats. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.PubSubLite.V1.Model.ComputeMessageStatsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.PubSubLite.V1.Model.ComputeMessageStatsResponse{}}
on success -
{:error, info}
on failure
pubsublite_topic_stats_projects_locations_topics_compute_time_cursor(connection, topic, optional_params \\ [], opts \\ [])
View Source@spec pubsublite_topic_stats_projects_locations_topics_compute_time_cursor( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.PubSubLite.V1.Model.ComputeTimeCursorResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Compute the corresponding cursor for a publish or event time in a topic partition.
Parameters
-
connection
(type:GoogleApi.PubSubLite.V1.Connection.t
) - Connection to server -
topic
(type:String.t
) - Required. The topic for which we should compute the cursor. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.PubSubLite.V1.Model.ComputeTimeCursorRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.PubSubLite.V1.Model.ComputeTimeCursorResponse{}}
on success -
{:error, info}
on failure