GoogleApi.PubSubLite.V1.Api.Admin (google_api_pub_sub_lite v0.3.0) View Source

API calls for all endpoints tagged Admin.

Link to this section Summary

Functions

Link to this section Functions

Link to this function

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

View Source

Specs

pubsublite_admin_projects_locations_subscriptions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.Subscription.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new subscription.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent location in which to create the subscription. Structured like projects/{project_number}/locations/{location}.
  • 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").
    • :subscriptionId (type: String.t) - Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: my-sub-name.
    • :body (type: GoogleApi.PubSubLite.V1.Model.Subscription.t) -
  • opts (type: keyword()) - Call options

Returns

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

pubsublite_admin_projects_locations_subscriptions_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

pubsublite_admin_projects_locations_subscriptions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes the specified subscription.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the subscription to delete.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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

pubsublite_admin_projects_locations_subscriptions_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

pubsublite_admin_projects_locations_subscriptions_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.Subscription.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns the subscription configuration.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the subscription whose configuration to return.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

pubsublite_admin_projects_locations_subscriptions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.ListSubscriptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns the list of subscriptions for the given project.

Parameters

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

Returns

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

pubsublite_admin_projects_locations_subscriptions_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

pubsublite_admin_projects_locations_subscriptions_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.Subscription.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates properties of the specified subscription.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the subscription. 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").
    • :updateMask (type: String.t) - Required. A mask specifying the subscription fields to change.
    • :body (type: GoogleApi.PubSubLite.V1.Model.Subscription.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

pubsublite_admin_projects_locations_topics_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.Topic.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new topic.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent location in which to create the topic. Structured like projects/{project_number}/locations/{location}.
  • 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").
    • :topicId (type: String.t) - Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.
    • :body (type: GoogleApi.PubSubLite.V1.Model.Topic.t) -
  • opts (type: keyword()) - Call options

Returns

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

pubsublite_admin_projects_locations_topics_delete(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

pubsublite_admin_projects_locations_topics_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Deletes the specified topic.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the topic to delete.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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

pubsublite_admin_projects_locations_topics_get(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

pubsublite_admin_projects_locations_topics_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.Topic.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns the topic configuration.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the topic whose configuration to return.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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

pubsublite_admin_projects_locations_topics_get_partitions(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

pubsublite_admin_projects_locations_topics_get_partitions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.TopicPartitions.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns the partition information for the requested topic.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The topic whose partition information to return.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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

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

View Source

Specs

pubsublite_admin_projects_locations_topics_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.ListTopicsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns the list of topics for the given project.

Parameters

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

Returns

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

pubsublite_admin_projects_locations_topics_patch(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

pubsublite_admin_projects_locations_topics_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.Topic.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates properties of the specified topic.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_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").
    • :updateMask (type: String.t) - Required. A mask specifying the topic fields to change.
    • :body (type: GoogleApi.PubSubLite.V1.Model.Topic.t) -
  • opts (type: keyword()) - Call options

Returns

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

pubsublite_admin_projects_locations_topics_subscriptions_list(connection, name, optional_params \\ [], opts \\ [])

View Source

Specs

pubsublite_admin_projects_locations_topics_subscriptions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PubSubLite.V1.Model.ListTopicSubscriptionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists the subscriptions attached to the specified topic.

Parameters

  • connection (type: GoogleApi.PubSubLite.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the topic whose subscriptions to list.
  • 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 subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned.
    • :pageToken (type: String.t) - A page token, received from a previous ListTopicSubscriptions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTopicSubscriptions must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

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