Cloud Pub/Sub API: projects. Provides reliable, many-to-many, asynchronous messaging between applications. See: https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects
Cloud Pub/Sub API: projects. Provides reliable, many-to-many, asynchronous messaging between applications. See: https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects
(schemas-create$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/create
Required parameters: parent
Optional parameters: schemaId
Body:
{:type string, :definition string, :name string}
Creates a schema.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/create Required parameters: parent Optional parameters: schemaId Body: {:type string, :definition string, :name string} Creates a schema.
(schemas-delete$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/delete
Required parameters: name
Optional parameters: none
Deletes a schema.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/delete Required parameters: name Optional parameters: none Deletes a schema.
(schemas-get$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/get
Required parameters: name
Optional parameters: view
Gets a schema.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/get Required parameters: name Optional parameters: view Gets a schema.
(schemas-getIamPolicy$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/getIamPolicy
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(schemas-list$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/list
Required parameters: parent
Optional parameters: pageToken, pageSize, view
Lists schemas in a project.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/list Required parameters: parent Optional parameters: pageToken, pageSize, view Lists schemas in a project.
(schemas-setIamPolicy$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(schemas-testIamPermissions$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/testIamPermissions
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(schemas-validate$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/validate
Required parameters: parent
Optional parameters: none
Body:
{:schema {:type string, :definition string, :name string}}
Validates a schema.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/validate Required parameters: parent Optional parameters: none Body: {:schema {:type string, :definition string, :name string}} Validates a schema.
(schemas-validateMessage$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/validateMessage
Required parameters: parent
Optional parameters: none
Body:
{:name string, :message string, :schema {:type string, :definition string, :name string}, :encoding string}
Validates a message against a schema.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/schemas/validateMessage Required parameters: parent Optional parameters: none Body: {:name string, :message string, :schema {:type string, :definition string, :name string}, :encoding string} Validates a message against a schema.
(snapshots-create$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/create
Required parameters: name
Optional parameters: none
Body:
{:subscription string, :labels {}}
Creates a snapshot from the requested subscription. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. If the snapshot already exists, returns ALREADY_EXISTS
. If the requested subscription doesn't exist, returns NOT_FOUND
. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then FAILED_PRECONDITION
is returned. See also the Snapshot.expire_time
field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/create Required parameters: name Optional parameters: none Body: {:subscription string, :labels {}} Creates a snapshot from the requested subscription. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.
(snapshots-delete$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/delete
Required parameters: snapshot
Optional parameters: none
Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/delete Required parameters: snapshot Optional parameters: none Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.
(snapshots-get$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/get
Required parameters: snapshot
Optional parameters: none
Gets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/get Required parameters: snapshot Optional parameters: none Gets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
(snapshots-getIamPolicy$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/getIamPolicy
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(snapshots-list$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/list
Required parameters: project
Optional parameters: pageToken, pageSize
Lists the existing snapshots. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/list Required parameters: project Optional parameters: pageToken, pageSize Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
(snapshots-patch$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/patch
Required parameters: name
Optional parameters: none
Body:
{:updateMask string, :snapshot {:name string, :topic string, :expireTime string, :labels {}}}
Updates an existing snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/patch Required parameters: name Optional parameters: none Body: {:updateMask string, :snapshot {:name string, :topic string, :expireTime string, :labels {}}} Updates an existing snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
(snapshots-setIamPolicy$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(snapshots-testIamPermissions$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/testIamPermissions
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/snapshots/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(subscriptions-acknowledge$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/acknowledge
Required parameters: subscription
Optional parameters: none
Body:
{:ackIds [string]}
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.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/acknowledge Required parameters: subscription Optional parameters: none Body: {:ackIds [string]} 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.
(subscriptions-create$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/create
Required parameters: name
Optional parameters: none
Body:
{:expirationPolicy {:ttl string}, :labels {}, :name string, :retryPolicy {:maximumBackoff string, :minimumBackoff string}, :messageRetentionDuration string, :detached boolean, :topic string, :deadLetterPolicy {:maxDeliveryAttempts integer, :deadLetterTopic string}, :retainAckedMessages boolean, :filter string, :enableMessageOrdering boolean, :topicMessageRetentionDuration string, :pushConfig {:attributes {}, :oidcToken OidcToken, :pushEndpoint string}, :ackDeadlineSeconds integer}
Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). 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] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/create Required parameters: name Optional parameters: none Body: {:expirationPolicy {:ttl string}, :labels {}, :name string, :retryPolicy {:maximumBackoff string, :minimumBackoff string}, :messageRetentionDuration string, :detached boolean, :topic string, :deadLetterPolicy {:maxDeliveryAttempts integer, :deadLetterTopic string}, :retainAckedMessages boolean, :filter string, :enableMessageOrdering boolean, :topicMessageRetentionDuration string, :pushConfig {:attributes {}, :oidcToken OidcToken, :pushEndpoint string}, :ackDeadlineSeconds integer} Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). 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] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
(subscriptions-delete$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/delete
Required parameters: subscription
Optional parameters: none
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.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/delete Required parameters: subscription Optional parameters: none 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.
(subscriptions-detach$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/detach
Required parameters: subscription
Optional parameters: none
Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent Pull
and StreamingPull
requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/detach Required parameters: subscription Optional parameters: none Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.
(subscriptions-get$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/get
Required parameters: subscription
Optional parameters: none
Gets the configuration details of a subscription.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/get Required parameters: subscription Optional parameters: none Gets the configuration details of a subscription.
(subscriptions-getIamPolicy$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/getIamPolicy
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(subscriptions-list$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/list
Required parameters: project
Optional parameters: pageToken, pageSize
Lists matching subscriptions.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/list Required parameters: project Optional parameters: pageToken, pageSize Lists matching subscriptions.
(subscriptions-modifyAckDeadline$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/modifyAckDeadline
Required parameters: subscription
Optional parameters: none
Body:
{:ackDeadlineSeconds integer, :ackIds [string]}
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.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/modifyAckDeadline Required parameters: subscription Optional parameters: none Body: {:ackDeadlineSeconds integer, :ackIds [string]} 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.
(subscriptions-modifyPushConfig$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/modifyPushConfig
Required parameters: subscription
Optional parameters: none
Body:
{:pushConfig {:attributes {}, :oidcToken OidcToken, :pushEndpoint string}}
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
.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/modifyPushConfig Required parameters: subscription Optional parameters: none Body: {:pushConfig {:attributes {}, :oidcToken OidcToken, :pushEndpoint string}} 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`.
(subscriptions-patch$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/patch
Required parameters: name
Optional parameters: none
Body:
{:subscription {:expirationPolicy ExpirationPolicy, :labels {}, :name string, :retryPolicy RetryPolicy, :messageRetentionDuration string, :detached boolean, :topic string, :deadLetterPolicy DeadLetterPolicy, :retainAckedMessages boolean, :filter string, :enableMessageOrdering boolean, :topicMessageRetentionDuration string, :pushConfig PushConfig, :ackDeadlineSeconds integer}, :updateMask string}
Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/patch Required parameters: name Optional parameters: none Body: {:subscription {:expirationPolicy ExpirationPolicy, :labels {}, :name string, :retryPolicy RetryPolicy, :messageRetentionDuration string, :detached boolean, :topic string, :deadLetterPolicy DeadLetterPolicy, :retainAckedMessages boolean, :filter string, :enableMessageOrdering boolean, :topicMessageRetentionDuration string, :pushConfig PushConfig, :ackDeadlineSeconds integer}, :updateMask string} Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
(subscriptions-pull$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/pull
Required parameters: subscription
Optional parameters: none
Body:
{:maxMessages integer, :returnImmediately boolean}
Pulls messages from the server. The server may return UNAVAILABLE
if there are too many concurrent pull requests pending for the given subscription.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/pull Required parameters: subscription Optional parameters: none Body: {:maxMessages integer, :returnImmediately boolean} Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.
(subscriptions-seek$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/seek
Required parameters: subscription
Optional parameters: none
Body:
{:snapshot string, :time string}
Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/seek Required parameters: subscription Optional parameters: none Body: {:snapshot string, :time string} Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic.
(subscriptions-setIamPolicy$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(subscriptions-testIamPermissions$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/testIamPermissions
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/subscriptions/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
(topics-create$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/create
Required parameters: name
Optional parameters: none
Body:
{:name string, :satisfiesPzs boolean, :messageRetentionDuration string, :schemaSettings {:schema string, :encoding string}, :messageStoragePolicy {:allowedPersistenceRegions [string]}, :labels {}, :kmsKeyName string}
Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names).
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/create Required parameters: name Optional parameters: none Body: {:name string, :satisfiesPzs boolean, :messageRetentionDuration string, :schemaSettings {:schema string, :encoding string}, :messageStoragePolicy {:allowedPersistenceRegions [string]}, :labels {}, :kmsKeyName string} Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names).
(topics-delete$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/delete
Required parameters: topic
Optional parameters: none
Deletes the topic with the given name. Returns NOT_FOUND
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_
.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/delete Required parameters: topic Optional parameters: none Deletes the topic with the given name. Returns `NOT_FOUND` 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_`.
(topics-get$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/get
Required parameters: topic
Optional parameters: none
Gets the configuration of a topic.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/get Required parameters: topic Optional parameters: none Gets the configuration of a topic.
(topics-getIamPolicy$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/getIamPolicy
Required parameters: resource
Optional parameters: options.requestedPolicyVersion
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/getIamPolicy Required parameters: resource Optional parameters: options.requestedPolicyVersion Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(topics-list$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/list
Required parameters: project
Optional parameters: pageSize, pageToken
Lists matching topics.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/list Required parameters: project Optional parameters: pageSize, pageToken Lists matching topics.
(topics-patch$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/patch
Required parameters: name
Optional parameters: none
Body:
{:updateMask string, :topic {:name string, :satisfiesPzs boolean, :messageRetentionDuration string, :schemaSettings SchemaSettings, :messageStoragePolicy MessageStoragePolicy, :labels {}, :kmsKeyName string}}
Updates an existing topic. Note that certain properties of a topic are not modifiable.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/patch Required parameters: name Optional parameters: none Body: {:updateMask string, :topic {:name string, :satisfiesPzs boolean, :messageRetentionDuration string, :schemaSettings SchemaSettings, :messageStoragePolicy MessageStoragePolicy, :labels {}, :kmsKeyName string}} Updates an existing topic. Note that certain properties of a topic are not modifiable.
(topics-publish$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/publish
Required parameters: topic
Optional parameters: none
Body:
{:messages [{:messageId string, :orderingKey string, :attributes {}, :data string, :publishTime string}]}
Adds one or more messages to the topic. Returns NOT_FOUND
if the topic does not exist.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/publish Required parameters: topic Optional parameters: none Body: {:messages [{:messageId string, :orderingKey string, :attributes {}, :data string, :publishTime string}]} Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist.
(topics-setIamPolicy$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:policy {:etag string, :version integer, :bindings [Binding]}}
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/setIamPolicy Required parameters: resource Optional parameters: none Body: {:policy {:etag string, :version integer, :bindings [Binding]}} Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
(topics-snapshots-list$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/snapshots/list
Required parameters: topic
Optional parameters: pageSize, pageToken
Lists the names of the snapshots on this topic. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/snapshots/list Required parameters: topic Optional parameters: pageSize, pageToken Lists the names of the snapshots on this topic. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.
(topics-subscriptions-list$ auth parameters)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/subscriptions/list
Required parameters: topic
Optional parameters: pageSize, pageToken
Lists the names of the attached subscriptions on this topic.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/subscriptions/list Required parameters: topic Optional parameters: pageSize, pageToken Lists the names of the attached subscriptions on this topic.
(topics-testIamPermissions$ auth parameters body)
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/testIamPermissions
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
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.
https://cloud.google.com/pubsub/docsapi/reference/rest/v1/projects/topics/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} 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.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close