google_api_pub_sub v0.0.1 GoogleApi.PubSub.V1.Api.Projects View Source
API calls for all endpoints tagged Projects.
Link to this section Summary
Functions
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set
Sets the access control policy on the specified resource. Replaces any existing policy
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning
Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error
Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request
Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified
Gets the configuration details of a subscription
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set
Lists matching subscriptions
Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages
Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription
Sets the access control policy on the specified resource. Replaces any existing policy
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning
Creates the given topic with the given name
Deletes the topic with the given name. Returns `NOTFOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic`
Gets the configuration of a topic
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set
Lists matching topics
Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute
Sets the access control policy on the specified resource. Replaces any existing policy
Lists the name of the subscriptions for this topic
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning
Link to this section Functions
pubsub_projects_snapshots_get_iam_policy(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Policy.t} | {:error, Tesla.Env.t}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
- snapshots_id (String): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Policy{}} on success {:error, info} on failure
pubsub_projects_snapshots_set_iam_policy(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Policy.t} | {:error, Tesla.Env.t}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
- snapshots_id (String): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (SetIamPolicyRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Policy{}} on success {:error, info} on failure
pubsub_projects_snapshots_test_iam_permissions(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.TestIamPermissionsResponse.t} | {:error, Tesla.Env.t}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
- snapshots_id (String): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (TestIamPermissionsRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
pubsub_projects_subscriptions_acknowledge(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Empty.t} | {:error, Tesla.Env.t}
Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `subscription`. The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`.
- subscriptions_id (String): Part of `subscription`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (AcknowledgeRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Empty{}} on success {:error, info} on failure
pubsub_projects_subscriptions_create(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Subscription.t} | {:error, Tesla.Env.t}
Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projectsid (String): Part of `name`. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (``), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
- subscriptions_id (String): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (Subscription):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Subscription{}} on success {:error, info} on failure
pubsub_projects_subscriptions_delete(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Empty.t} | {:error, Tesla.Env.t}
Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `subscription`. The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`.
- subscriptions_id (String): Part of `subscription`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Empty{}} on success {:error, info} on failure
pubsub_projects_subscriptions_get(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Subscription.t} | {:error, Tesla.Env.t}
Gets the configuration details of a subscription.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `subscription`. The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`.
- subscriptions_id (String): Part of `subscription`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Subscription{}} on success {:error, info} on failure
pubsub_projects_subscriptions_get_iam_policy(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Policy.t} | {:error, Tesla.Env.t}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
- subscriptions_id (String): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Policy{}} on success {:error, info} on failure
pubsub_projects_subscriptions_list(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.ListSubscriptionsResponse.t} | {:error, Tesla.Env.t}
Lists matching subscriptions.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `project`. The name of the cloud project that subscriptions belong to. Format is `projects/{project}`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :page_token (String): The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.
- :page_size (Integer): Maximum number of subscriptions to return.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.ListSubscriptionsResponse{}} on success {:error, info} on failure
pubsub_projects_subscriptions_modify_ack_deadline(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Empty.t} | {:error, Tesla.Env.t}
Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `subscription`. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.
- subscriptions_id (String): Part of `subscription`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (ModifyAckDeadlineRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Empty{}} on success {:error, info} on failure
pubsub_projects_subscriptions_modify_push_config(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Empty.t} | {:error, Tesla.Env.t}
Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `subscription`. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.
- subscriptions_id (String): Part of `subscription`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (ModifyPushConfigRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Empty{}} on success {:error, info} on failure
pubsub_projects_subscriptions_pull(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.PullResponse.t} | {:error, Tesla.Env.t}
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `subscription`. The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`.
- subscriptions_id (String): Part of `subscription`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (PullRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.PullResponse{}} on success {:error, info} on failure
pubsub_projects_subscriptions_set_iam_policy(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Policy.t} | {:error, Tesla.Env.t}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
- subscriptions_id (String): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (SetIamPolicyRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Policy{}} on success {:error, info} on failure
pubsub_projects_subscriptions_test_iam_permissions(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.TestIamPermissionsResponse.t} | {:error, Tesla.Env.t}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
- subscriptions_id (String): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (TestIamPermissionsRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
pubsub_projects_topics_create(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Topic.t} | {:error, Tesla.Env.t}
Creates the given topic with the given name.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projectsid (String): Part of `name`. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (``), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
- topics_id (String): Part of `name`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (Topic):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Topic{}} on success {:error, info} on failure
pubsub_projects_topics_delete(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Empty.t} | {:error, Tesla.Env.t}
Deletes the topic with the given name. Returns `NOTFOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic`.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `topic`. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`.
- topics_id (String): Part of `topic`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Empty{}} on success {:error, info} on failure
pubsub_projects_topics_get(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Topic.t} | {:error, Tesla.Env.t}
Gets the configuration of a topic.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `topic`. The name of the topic to get. Format is `projects/{project}/topics/{topic}`.
- topics_id (String): Part of `topic`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Topic{}} on success {:error, info} on failure
pubsub_projects_topics_get_iam_policy(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Policy.t} | {:error, Tesla.Env.t}
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
- topics_id (String): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Policy{}} on success {:error, info} on failure
pubsub_projects_topics_list(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.ListTopicsResponse.t} | {:error, Tesla.Env.t}
Lists matching topics.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `project`. The name of the cloud project that topics belong to. Format is `projects/{project}`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :page_token (String): The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.
- :page_size (Integer): Maximum number of topics to return.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.ListTopicsResponse{}} on success {:error, info} on failure
pubsub_projects_topics_publish(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.PublishResponse.t} | {:error, Tesla.Env.t}
Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `topic`. The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`.
- topics_id (String): Part of `topic`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (PublishRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.PublishResponse{}} on success {:error, info} on failure
pubsub_projects_topics_set_iam_policy(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.Policy.t} | {:error, Tesla.Env.t}
Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
- topics_id (String): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (SetIamPolicyRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.Policy{}} on success {:error, info} on failure
pubsub_projects_topics_subscriptions_list(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.ListTopicSubscriptionsResponse.t} | {:error, Tesla.Env.t}
Lists the name of the subscriptions for this topic.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `topic`. The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`.
- topics_id (String): Part of `topic`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :page_token (String): The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.
- :page_size (Integer): Maximum number of subscription names to return.
Returns
{:ok, %GoogleApi.PubSub.V1.Model.ListTopicSubscriptionsResponse{}} on success {:error, info} on failure
pubsub_projects_topics_test_iam_permissions(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.PubSub.V1.Model.TestIamPermissionsResponse.t} | {:error, Tesla.Env.t}
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters
- connection (GoogleApi.PubSub.V1.Connection): Connection to server
- projects_id (String): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
- topics_id (String): Part of `resource`. See documentation of `projectsId`.
opts (KeywordList): [optional] Optional parameters
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :access_token (String): OAuth access token.
- :key (String): 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.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String): Selector specifying which fields to include in a partial response.
- :body (TestIamPermissionsRequest):
Returns
{:ok, %GoogleApi.PubSub.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure