Module api

Module api 

Source

Structs§

AdminMethods
A builder providing access to all methods supported on admin resources. It is not used directly, but through the PubsubLite hub.
AdminProjectLocationOperationCancelCall
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.
AdminProjectLocationOperationDeleteCall
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.
AdminProjectLocationOperationGetCall
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.
AdminProjectLocationOperationListCall
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
AdminProjectLocationReservationCreateCall
Creates a new reservation.
AdminProjectLocationReservationDeleteCall
Deletes the specified reservation.
AdminProjectLocationReservationGetCall
Returns the reservation configuration.
AdminProjectLocationReservationListCall
Returns the list of reservations for the given project.
AdminProjectLocationReservationPatchCall
Updates properties of the specified reservation.
AdminProjectLocationReservationTopicListCall
Lists the topics attached to the specified reservation.
AdminProjectLocationSubscriptionCreateCall
Creates a new subscription.
AdminProjectLocationSubscriptionDeleteCall
Deletes the specified subscription.
AdminProjectLocationSubscriptionGetCall
Returns the subscription configuration.
AdminProjectLocationSubscriptionListCall
Returns the list of subscriptions for the given project.
AdminProjectLocationSubscriptionPatchCall
Updates properties of the specified subscription.
AdminProjectLocationSubscriptionSeekCall
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.
AdminProjectLocationTopicCreateCall
Creates a new topic.
AdminProjectLocationTopicDeleteCall
Deletes the specified topic.
AdminProjectLocationTopicGetCall
Returns the topic configuration.
AdminProjectLocationTopicGetPartitionCall
Returns the partition information for the requested topic.
AdminProjectLocationTopicListCall
Returns the list of topics for the given project.
AdminProjectLocationTopicPatchCall
Updates properties of the specified topic.
AdminProjectLocationTopicSubscriptionListCall
Lists the subscriptions attached to the specified topic.
CancelOperationRequest
The request message for Operations.CancelOperation.
Capacity
The throughput capacity configuration for each partition.
CommitCursorRequest
Request for CommitCursor.
CommitCursorResponse
Response for CommitCursor.
ComputeHeadCursorRequest
Compute the current head cursor for a partition.
ComputeHeadCursorResponse
Response containing the head cursor for the requested topic and partition.
ComputeMessageStatsRequest
Compute statistics about a range of messages in a given topic and partition.
ComputeMessageStatsResponse
Response containing stats for messages in the requested topic and partition.
ComputeTimeCursorRequest
Compute the corresponding cursor for a publish or event time in a topic partition.
ComputeTimeCursorResponse
Response containing the cursor corresponding to a publish or event time in a topic partition.
Cursor
A cursor that describes the position of a message within a topic partition.
CursorMethods
A builder providing access to all methods supported on cursor resources. It is not used directly, but through the PubsubLite hub.
CursorProjectLocationSubscriptionCommitCursorCall
Updates the committed cursor.
CursorProjectLocationSubscriptionCursorListCall
Returns all committed cursor information for a subscription.
DeliveryConfig
The settings for a subscription’s message delivery.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
ExportConfig
Configuration for a Pub/Sub Lite subscription that writes messages to a destination. User subscriber clients must not connect to this subscription.
ListOperationsResponse
The response message for Operations.ListOperations.
ListPartitionCursorsResponse
Response for ListPartitionCursors
ListReservationTopicsResponse
Response for ListReservationTopics.
ListReservationsResponse
Response for ListReservations.
ListSubscriptionsResponse
Response for ListSubscriptions.
ListTopicSubscriptionsResponse
Response for ListTopicSubscriptions.
ListTopicsResponse
Response for ListTopics.
Operation
This resource represents a long-running operation that is the result of a network API call.
PartitionConfig
The settings for a topic’s partitions.
PartitionCursor
A pair of a Cursor and the partition it is for.
PubSubConfig
Configuration for exporting to a Pub/Sub topic.
PubsubLite
Central instance to access all PubsubLite related resource activities
Reservation
Metadata about a reservation resource.
ReservationConfig
The settings for this topic’s Reservation usage.
RetentionConfig
The settings for a topic’s message retention.
SeekSubscriptionRequest
Request for SeekSubscription.
Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Subscription
Metadata about a subscription resource.
TimeTarget
A target publish or event time. Can be used for seeking to or retrieving the corresponding cursor.
Topic
Metadata about a topic resource.
TopicPartitions
Response for GetTopicPartitions.
TopicStatMethods
A builder providing access to all methods supported on topicStat resources. It is not used directly, but through the PubsubLite hub.
TopicStatProjectLocationTopicComputeHeadCursorCall
Compute the head cursor for the partition. The head cursor’s offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.
TopicStatProjectLocationTopicComputeMessageStatCall
Compute statistics about a range of messages in a given topic and partition.
TopicStatProjectLocationTopicComputeTimeCursorCall
Compute the corresponding cursor for a publish or event time in a topic partition.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.