- projects-locations-operations-cancel$
- projects-locations-operations-delete$
- projects-locations-operations-get$
- projects-locations-operations-list$
- projects-locations-reservations-create$
- projects-locations-reservations-delete$
- projects-locations-reservations-get$
- projects-locations-reservations-list$
- projects-locations-reservations-patch$
- projects-locations-reservations-topics-list$
- projects-locations-subscriptions-create$
- projects-locations-subscriptions-delete$
- projects-locations-subscriptions-get$
- projects-locations-subscriptions-list$
- projects-locations-subscriptions-patch$
- projects-locations-subscriptions-seek$
- projects-locations-topics-create$
- projects-locations-topics-delete$
- projects-locations-topics-get$
- projects-locations-topics-getPartitions$
- projects-locations-topics-list$
- projects-locations-topics-patch$
- projects-locations-topics-subscriptions-list$
happygapi.pubsublite.admin
Pub/Sub Lite API: admin.
See: https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin
Pub/Sub Lite API: admin. See: https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin
projects-locations-operations-cancel$clj
(projects-locations-operations-cancel$ auth parameters body)Required parameters: name
Optional parameters: none
Body:
{}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/operations/cancel
Required parameters: name
Optional parameters: none
Body:
{}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.projects-locations-operations-delete$clj
(projects-locations-operations-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/operations/delete Required parameters: name Optional parameters: none Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
projects-locations-operations-get$clj
(projects-locations-operations-get$ auth parameters)Required parameters: name
Optional parameters: none
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/operations/get Required parameters: name Optional parameters: none Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
projects-locations-operations-list$clj
(projects-locations-operations-list$ auth parameters)Required parameters: name
Optional parameters: pageToken, pageSize, filter
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/operations/list
Required parameters: name
Optional parameters: pageToken, pageSize, filter
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.projects-locations-reservations-create$clj
(projects-locations-reservations-create$ auth parameters body)Required parameters: parent
Optional parameters: reservationId
Body:
{:name string, :throughputCapacity string}
Creates a new reservation.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/reservations/create
Required parameters: parent
Optional parameters: reservationId
Body:
{:name string, :throughputCapacity string}
Creates a new reservation.projects-locations-reservations-delete$clj
(projects-locations-reservations-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes the specified reservation.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/reservations/delete Required parameters: name Optional parameters: none Deletes the specified reservation.
projects-locations-reservations-get$clj
(projects-locations-reservations-get$ auth parameters)Required parameters: name
Optional parameters: none
Returns the reservation configuration.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/reservations/get Required parameters: name Optional parameters: none Returns the reservation configuration.
projects-locations-reservations-list$clj
(projects-locations-reservations-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of reservations for the given project.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/reservations/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of reservations for the given project.
projects-locations-reservations-patch$clj
(projects-locations-reservations-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :throughputCapacity string}
Updates properties of the specified reservation.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/reservations/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :throughputCapacity string}
Updates properties of the specified reservation.projects-locations-reservations-topics-list$clj
(projects-locations-reservations-topics-list$ auth parameters)Required parameters: name
Optional parameters: pageToken, pageSize
Lists the topics attached to the specified reservation.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/reservations/topics/list Required parameters: name Optional parameters: pageToken, pageSize Lists the topics attached to the specified reservation.
projects-locations-subscriptions-create$clj
(projects-locations-subscriptions-create$ auth parameters body)Required parameters: parent
Optional parameters: subscriptionId, skipBacklog
Body:
{:topic string, :name string, :deliveryConfig {:deliveryRequirement string}}
Creates a new subscription.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/subscriptions/create
Required parameters: parent
Optional parameters: subscriptionId, skipBacklog
Body:
{:topic string,
:name string,
:deliveryConfig {:deliveryRequirement string}}
Creates a new subscription.projects-locations-subscriptions-delete$clj
(projects-locations-subscriptions-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes the specified subscription.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/subscriptions/delete Required parameters: name Optional parameters: none Deletes the specified subscription.
projects-locations-subscriptions-get$clj
(projects-locations-subscriptions-get$ auth parameters)Required parameters: name
Optional parameters: none
Returns the subscription configuration.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/subscriptions/get Required parameters: name Optional parameters: none Returns the subscription configuration.
projects-locations-subscriptions-list$clj
(projects-locations-subscriptions-list$ auth parameters)Required parameters: parent
Optional parameters: pageToken, pageSize
Returns the list of subscriptions for the given project.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/subscriptions/list Required parameters: parent Optional parameters: pageToken, pageSize Returns the list of subscriptions for the given project.
projects-locations-subscriptions-patch$clj
(projects-locations-subscriptions-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:topic string, :name string, :deliveryConfig {:deliveryRequirement string}}
Updates properties of the specified subscription.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/subscriptions/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:topic string,
:name string,
:deliveryConfig {:deliveryRequirement string}}
Updates properties of the specified subscription.projects-locations-subscriptions-seek$clj
(projects-locations-subscriptions-seek$ auth parameters body)Required parameters: name
Optional parameters: none
Body:
{:timeTarget {:eventTime string, :publishTime string}, :namedTarget string}
Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/subscriptions/seek
Required parameters: name
Optional parameters: none
Body:
{:timeTarget {:eventTime string, :publishTime string},
:namedTarget string}
Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.projects-locations-topics-create$clj
(projects-locations-topics-create$ auth parameters body)Required parameters: parent
Optional parameters: topicId
Body:
{:partitionConfig {:capacity Capacity, :count string, :scale integer}, :retentionConfig {:period string, :perPartitionBytes string}, :name string, :reservationConfig {:throughputReservation string}}
Creates a new topic.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/create
Required parameters: parent
Optional parameters: topicId
Body:
{:partitionConfig {:capacity Capacity, :count string, :scale integer},
:retentionConfig {:period string, :perPartitionBytes string},
:name string,
:reservationConfig {:throughputReservation string}}
Creates a new topic.projects-locations-topics-delete$clj
(projects-locations-topics-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes the specified topic.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/delete Required parameters: name Optional parameters: none Deletes the specified topic.
projects-locations-topics-get$clj
(projects-locations-topics-get$ auth parameters)https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/get
Required parameters: name
Optional parameters: none
Returns the topic configuration.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/get Required parameters: name Optional parameters: none Returns the topic configuration.
projects-locations-topics-getPartitions$clj
(projects-locations-topics-getPartitions$ auth parameters)Required parameters: name
Optional parameters: none
Returns the partition information for the requested topic.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/getPartitions Required parameters: name Optional parameters: none Returns the partition information for the requested topic.
projects-locations-topics-list$clj
(projects-locations-topics-list$ auth parameters)https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/list
Required parameters: parent
Optional parameters: pageToken, pageSize
Returns the list of topics for the given project.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/list Required parameters: parent Optional parameters: pageToken, pageSize Returns the list of topics for the given project.
projects-locations-topics-patch$clj
(projects-locations-topics-patch$ auth parameters body)https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:partitionConfig {:capacity Capacity, :count string, :scale integer}, :retentionConfig {:period string, :perPartitionBytes string}, :name string, :reservationConfig {:throughputReservation string}}
Updates properties of the specified topic.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:partitionConfig {:capacity Capacity, :count string, :scale integer},
:retentionConfig {:period string, :perPartitionBytes string},
:name string,
:reservationConfig {:throughputReservation string}}
Updates properties of the specified topic.projects-locations-topics-subscriptions-list$clj
(projects-locations-topics-subscriptions-list$ auth parameters)Required parameters: name
Optional parameters: pageSize, pageToken
Lists the subscriptions attached to the specified topic.
https://cloud.google.com/pubsub/lite/docsapi/reference/rest/v1/admin/projects/locations/topics/subscriptions/list Required parameters: name Optional parameters: pageSize, pageToken Lists the subscriptions attached to the specified topic.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close