View Source GoogleApi.PubSubLite.V1.Api.Cursor (google_api_pub_sub_lite v0.9.0)

API calls for all endpoints tagged Cursor.

Summary

Functions

Link to this function

pubsublite_cursor_projects_locations_subscriptions_commit_cursor(connection, subscription, optional_params \\ [], opts \\ [])

View Source
@spec pubsublite_cursor_projects_locations_subscriptions_commit_cursor(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.CommitCursorResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the committed cursor.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • subscription (type: String.t) - The subscription for which to update 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.CommitCursorRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.PubSubLite.V1.Model.CommitCursorResponse{}} on success
  • {:error, info} on failure
Link to this function

pubsublite_cursor_projects_locations_subscriptions_cursors_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec pubsublite_cursor_projects_locations_subscriptions_cursors_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.ListPartitionCursorsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns all committed cursor information for a subscription.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The subscription for which to retrieve cursors. Structured like projects/{project_number}/locations/{location}/subscriptions/{subscription_id}.
  • 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").
    • :pageSize (type: integer()) - The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.
    • :pageToken (type: String.t) - A page token, received from a previous ListPartitionCursors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitionCursors must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.PubSubLite.V1.Model.ListPartitionCursorsResponse{}} on success
  • {:error, info} on failure