package google.cloud.pubsublite.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service AdminService
admin.proto:39The service that a client application uses to manage topics and subscriptions, such creating, listing, and deleting topics and subscriptions.
rpc CreateTopic (, )
admin.proto:45Creates a new topic.
message
admin.proto:236Request for CreateTopic.
string parent = 1
Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`.
optional topic = 2
Required. Configuration of the topic to create. Its `name` field is ignored.
string topic_id = 3
Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.
rpc GetTopic (, )
admin.proto:54Returns the topic configuration.
message
admin.proto:258Request for GetTopic.
string name = 1
Required. The name of the topic whose configuration to return.
rpc GetTopicPartitions (, )
admin.proto:62Returns the partition information for the requested topic.
message
admin.proto:269Request for GetTopicPartitions.
string name = 1
Required. The topic whose partition information to return.
message
admin.proto:280Response for GetTopicPartitions.
int64 partition_count = 1
The number of partitions in the topic.
rpc ListTopics (, )
admin.proto:70Returns the list of topics for the given project.
message
admin.proto:286Request for ListTopics.
string parent = 1
Required. The parent whose topics are to be listed. Structured like `projects/{project_number}/locations/{location}`.
int32 page_size = 2
The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent will be returned.
string page_token = 3
A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token.
message
admin.proto:310Response for ListTopics.
repeated topics = 1
The list of topic in the requested parent. The order of the topics is unspecified.
string next_page_token = 2
A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
rpc UpdateTopic (, )
admin.proto:78Updates properties of the specified topic.
message
admin.proto:321Request for UpdateTopic.
optional topic = 1
Required. The topic to update. Its `name` field must be populated.
optional update_mask = 2
Required. A mask specifying the topic fields to change.
rpc DeleteTopic (, )
admin.proto:87Deletes the specified topic.
message
admin.proto:331Request for DeleteTopic.
string name = 1
Required. The name of the topic to delete.
rpc ListTopicSubscriptions (, )
admin.proto:95Lists the subscriptions attached to the specified topic.
message
admin.proto:342Request for ListTopicSubscriptions.
string name = 1
Required. The name of the topic whose subscriptions to list.
int32 page_size = 2
The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned.
string page_token = 3
A page token, received from a previous `ListTopicSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopicSubscriptions` must match the call that provided the page token.
message
admin.proto:365Response for ListTopicSubscriptions.
repeated string subscriptions = 1
The names of subscriptions attached to the topic. The order of the subscriptions is unspecified.
string next_page_token = 2
A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
rpc CreateSubscription (, )
admin.proto:104Creates a new subscription.
message
admin.proto:376Request for CreateSubscription.
string parent = 1
Required. The parent location in which to create the subscription. Structured like `projects/{project_number}/locations/{location}`.
optional subscription = 2
Required. Configuration of the subscription to create. Its `name` field is ignored.
string subscription_id = 3
Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-name`.
bool skip_backlog = 4
If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.
rpc GetSubscription (, )
admin.proto:114Returns the subscription configuration.
message
admin.proto:403Request for GetSubscription.
string name = 1
Required. The name of the subscription whose configuration to return.
rpc ListSubscriptions (, )
admin.proto:122Returns the list of subscriptions for the given project.
message
admin.proto:414Request for ListSubscriptions.
string parent = 1
Required. The parent whose subscriptions are to be listed. Structured like `projects/{project_number}/locations/{location}`.
int32 page_size = 2
The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned.
string page_token = 3
A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.
message
admin.proto:438Response for ListSubscriptions.
repeated subscriptions = 1
The list of subscriptions in the requested parent. The order of the subscriptions is unspecified.
string next_page_token = 2
A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
rpc UpdateSubscription (, )
admin.proto:131Updates properties of the specified subscription.
message
admin.proto:449Request for UpdateSubscription.
optional subscription = 1
Required. The subscription to update. Its `name` field must be populated. Topic field must not be populated.
optional update_mask = 2
Required. A mask specifying the subscription fields to change.
rpc DeleteSubscription (, )
admin.proto:140Deletes the specified subscription.
message
admin.proto:460Request for DeleteSubscription.
string name = 1
Required. The name of the subscription to delete.
rpc SeekSubscription (, )
admin.proto:169Performs 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.
message
admin.proto:471Request for SeekSubscription.
string name = 1
Required. The name of the subscription to seek.
oneof target
The target to seek to. Must be set.
SeekSubscriptionRequest.NamedTarget named_target = 2
Seek to a named position with respect to the message backlog.
time_target = 3
Seek to the first message whose publish or event time is greater than or equal to the specified query time. If no such message can be located, will seek to the end of the message backlog.
rpc CreateReservation (, )
admin.proto:182Creates a new reservation.
message
admin.proto:527Request for CreateReservation.
string parent = 1
Required. The parent location in which to create the reservation. Structured like `projects/{project_number}/locations/{location}`.
optional reservation = 2
Required. Configuration of the reservation to create. Its `name` field is ignored.
string reservation_id = 3
Required. The ID to use for the reservation, which will become the final component of the reservation's name. This value is structured like: `my-reservation-name`.
rpc GetReservation (, )
admin.proto:191Returns the reservation configuration.
message
admin.proto:549Request for GetReservation.
string name = 1
Required. The name of the reservation whose configuration to return. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
rpc ListReservations (, )
admin.proto:199Returns the list of reservations for the given project.
message
admin.proto:562Request for ListReservations.
string parent = 1
Required. The parent whose reservations are to be listed. Structured like `projects/{project_number}/locations/{location}`.
int32 page_size = 2
The maximum number of reservations to return. The service may return fewer than this value. If unset or zero, all reservations for the parent will be returned.
string page_token = 3
A page token, received from a previous `ListReservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReservations` must match the call that provided the page token.
message
admin.proto:586Response for ListReservations.
repeated reservations = 1
The list of reservation in the requested parent. The order of the reservations is unspecified.
string next_page_token = 2
A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
rpc UpdateReservation (, )
admin.proto:208Updates properties of the specified reservation.
message
admin.proto:597Request for UpdateReservation.
optional reservation = 1
Required. The reservation to update. Its `name` field must be populated.
optional update_mask = 2
Required. A mask specifying the reservation fields to change.
rpc DeleteReservation (, )
admin.proto:217Deletes the specified reservation.
message
admin.proto:607Request for DeleteReservation.
string name = 1
Required. The name of the reservation to delete. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
rpc ListReservationTopics (, )
admin.proto:226Lists the topics attached to the specified reservation.
message
admin.proto:620Request for ListReservationTopics.
string name = 1
Required. The name of the reservation whose topics to list. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
int32 page_size = 2
The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the given reservation will be returned.
string page_token = 3
A page token, received from a previous `ListReservationTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReservationTopics` must match the call that provided the page token.
message
admin.proto:645Response for ListReservationTopics.
repeated string topics = 1
The names of topics attached to the reservation. The order of the topics is unspecified.
string next_page_token = 2
A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
service CursorService
cursor.proto:37The service that a subscriber client application uses to manage committed cursors while receiving messsages. A cursor represents a subscriber's progress within a topic partition for a given subscription.
rpc StreamingCommitCursor (stream , stream )
cursor.proto:43Establishes a stream with the server for managing committed cursors.
message
cursor.proto:95A request sent from the client to the server on a stream.
oneof request
The type of request this is.
initial = 1
Initial request on the stream.
commit = 2
Request to commit a new cursor value.
message
cursor.proto:107Response to a StreamingCommitCursorRequest.
oneof request
The type of request this is.
initial = 1
Initial response on the stream.
commit = 2
Response to committing a new cursor value.
rpc CommitCursor (, )
cursor.proto:47Updates the committed cursor.
message
cursor.proto:119Request for CommitCursor.
string subscription = 1
The subscription for which to update the cursor.
int64 partition = 2
The partition for which to update the cursor. Partitions are zero indexed, so `partition` must be in the range [0, topic.num_partitions).
optional cursor = 3
The new value for the committed cursor.
message
cursor.proto:132Response for CommitCursor.
(message has no fields)
rpc ListPartitionCursors (, )
cursor.proto:55Returns all committed cursor information for a subscription.
message
cursor.proto:135Request for ListPartitionCursors.
string parent = 1
Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`.
int32 page_size = 2
The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.
string page_token = 3
A page token, received from a previous `ListPartitionCursors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPartitionCursors` must match the call that provided the page token.
message
cursor.proto:169Response for ListPartitionCursors
repeated partition_cursors = 1
The partition cursors from this request.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
The service that a subscriber client application uses to determine which partitions it should connect to.
rpc AssignPartitions (stream , stream )
subscriber.proto:58Assign partitions for this client to handle for the specified subscription. The client must send an InitialPartitionAssignmentRequest first. The server will then send at most one unacknowledged PartitionAssignment outstanding on the stream at a time. The client should send a PartitionAssignmentAck after updating the partitions it is connected to to reflect the new assignment.
message
subscriber.proto:209A request on the PartitionAssignment stream.
oneof request
The type of request this is.
initial = 1
Initial request on the stream.
ack = 2
Acknowledgement of a partition assignment.
message
subscriber.proto:196PartitionAssignments should not race with acknowledgements. There should be exactly one unacknowledged PartitionAssignment at a time. If not, the client must break the stream.
repeated int64 partitions = 1
The list of partition numbers this subscriber is assigned to.
The service that a publisher client application uses to publish messages to topics. Published messages are retained by the service for the duration of the retention period configured for the respective topic, and are delivered to subscriber clients upon request (via the `SubscriberService`).
rpc Publish (stream , stream )
publisher.proto:48Establishes a stream with the server for publishing messages. Once the stream is initialized, the client publishes messages by sending publish requests on the stream. The server responds with a PublishResponse for each PublishRequest sent by the client, in the same order that the requests were sent. Note that multiple PublishRequests can be in flight simultaneously, but they will be processed by the server in the order that they are sent by the client on a given stream.
message
publisher.proto:125Request sent from the client to the server on a stream.
oneof request_type
The type of request this is.
initial_request = 1
Initial request on the stream.
message_publish_request = 2
Request to publish messages.
message
publisher.proto:137Response to a PublishRequest.
oneof response_type
The type of response this is.
initial_response = 1
Initial response on the stream.
message_response = 2
Response to publishing messages.
The service that a subscriber client application uses to receive messages from subscriptions.
rpc Subscribe (stream , stream )
subscriber.proto:41Establishes a stream with the server for receiving messages.
message
subscriber.proto:134A request sent from the client to the server on a stream.
oneof request
The type of request this is.
initial = 1
Initial request on the stream.
seek = 2
Request to update the stream's delivery cursor.
flow_control = 3
Request to grant tokens to the server,
message
subscriber.proto:160Response to SubscribeRequest.
oneof response
The type of response this is.
initial = 1
Initial response on the stream.
seek = 2
Response to a Seek operation.
messages = 3
Response containing messages from the topic partition.
This service allows users to get stats about messages in their topic.
Compute statistics about a range of messages in a given topic and partition.
message
topic_stats.proto:76Compute statistics about a range of messages in a given topic and partition.
string topic = 1
Required. The topic for which we should compute message stats.
int64 partition = 2
Required. The partition for which we should compute message stats.
optional start_cursor = 3
The inclusive start of the range.
optional end_cursor = 4
The exclusive end of the range. The range is empty if end_cursor <= start_cursor. Specifying a start_cursor before the first message and an end_cursor after the last message will retrieve all messages.
message
topic_stats.proto:98Response containing stats for messages in the requested topic and partition.
int64 message_count = 1
The count of messages.
int64 message_bytes = 2
The number of quota bytes accounted to these messages.
optional minimum_publish_time = 3
The minimum publish timestamp across these messages. Note that publish timestamps within a partition are not guaranteed to be non-decreasing. The timestamp will be unset if there are no messages.
optional minimum_event_time = 4
The minimum event timestamp across these messages. For the purposes of this computation, if a message does not have an event time, we use the publish time. The timestamp will be unset if there are no messages.
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.
message
topic_stats.proto:117Compute the current head cursor for a partition.
string topic = 1
Required. The topic for which we should compute the head cursor.
int64 partition = 2
Required. The partition for which we should compute the head cursor.
message
topic_stats.proto:131Response containing the head cursor for the requested topic and partition.
optional head_cursor = 1
The head cursor.
Compute the corresponding cursor for a publish or event time in a topic partition.
message
topic_stats.proto:138Compute the corresponding cursor for a publish or event time in a topic partition.
string topic = 1
Required. The topic for which we should compute the cursor.
int64 partition = 2
Required. The partition for which we should compute the cursor.
optional target = 3
Required. The target publish or event time. Specifying a future time will return an unset cursor.
message
topic_stats.proto:157Response containing the cursor corresponding to a publish or event time in a topic partition.
optional cursor = 1
If present, the cursor references the first message with time greater than or equal to the specified target time. If such a message cannot be found, the cursor will be unset (i.e. `cursor` is not present).
message
common.proto:34The values associated with a key of an attribute.
Used in:
repeated bytes values = 1
The list of values associated with a key.
message
common.proto:57A cursor that describes the position of a message within a topic partition.
Used in: , , , , , , , , , , ,
int64 offset = 1
The offset of a message within a topic partition. Must be greater than or equal 0.
message
common.proto:237Configuration for a Pub/Sub Lite subscription that writes messages to a destination. User subscriber clients must not connect to this subscription.
Used in:
ExportConfig.State desired_state = 1
The desired state of this export. Setting this to values other than `ACTIVE` and `PAUSED` will result in an error.
ExportConfig.State current_state = 6
Output only. The current state of the export, which may be different to the desired state due to errors. This field is output only.
string dead_letter_topic = 5
Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.
oneof destination
The destination to export to. Required.
pubsub_config = 3
Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic.
message
common.proto:257Configuration for exporting to a Pub/Sub topic.
Used in:
string topic = 1
The name of the Pub/Sub topic. Structured like: projects/{project_number}/topics/{topic_id}. The topic may be changed.
The desired export state.
Used in:
STATE_UNSPECIFIED = 0
Default value. This value is unused.
ACTIVE = 1
Messages are being exported.
PAUSED = 2
Exporting messages is suspended.
PERMISSION_DENIED = 3
Messages cannot be exported due to permission denied errors. Output only.
NOT_FOUND = 4
Messages cannot be exported due to missing resources. Output only.
message
subscriber.proto:125Request to grant tokens to the server, requesting delivery of messages when they become available.
Used in:
int64 allowed_messages = 1
The number of message tokens to grant. Must be greater than or equal to 0.
int64 allowed_bytes = 2
The number of byte tokens to grant. Must be greater than or equal to 0.
message
cursor.proto:67The first streaming request that must be sent on a newly-opened stream. The client must wait for the response before sending subsequent requests on the stream.
Used in:
string subscription = 1
The subscription for which to manage committed cursors.
int64 partition = 2
The partition for which to manage committed cursors. Partitions are zero indexed, so `partition` must be in the range [0, topic.num_partitions).
message
cursor.proto:77Response to an InitialCommitCursorRequest.
Used in:
(message has no fields)
message
subscriber.proto:176The first request that must be sent on a newly-opened stream. The client must wait for the response before sending subsequent requests on the stream.
Used in:
string subscription = 1
The subscription name. Structured like: projects/<project number>/locations/<zone name>/subscriptions/<subscription id>
bytes client_id = 2
An opaque, unique client identifier. This field must be exactly 16 bytes long and is interpreted as an unsigned 128 bit integer. Other size values will be rejected and the stream will be failed with a non-retryable error. This field is large enough to fit a uuid from standard uuid algorithms like uuid1 or uuid4, which should be used to generate this number. The same identifier should be reused following disconnections with retryable stream errors.
message
publisher.proto:52The first request that must be sent on a newly-opened stream.
Used in:
string topic = 1
The topic to which messages will be written.
int64 partition = 2
The partition within the topic to which messages will be written. Partitions are zero indexed, so `partition` must be in the range [0, topic.num_partitions).
bytes client_id = 3
Unique identifier for a publisher client. If set, enables publish idempotency within a publisher client session. The length of this field must be exactly 16 bytes long and should be populated with a 128 bit uuid, generated by standard uuid algorithms like uuid1 or uuid4. The same identifier should be reused following disconnections with retryable stream errors.
message
publisher.proto:72Response to an InitialPublishRequest.
Used in:
(message has no fields)
message
subscriber.proto:64The first request that must be sent on a newly-opened stream. The client must wait for the response before sending subsequent requests on the stream.
Used in:
string subscription = 1
The subscription from which to receive messages.
int64 partition = 2
The partition from which to receive messages. Partitions are zero indexed, so `partition` must be in the range [0, topic.num_partitions).
optional initial_location = 4
Optional. Initial target location within the message backlog. If not set, messages will be delivered from the commit cursor for the given subscription and partition.
message
subscriber.proto:79Response to an InitialSubscribeRequest.
Used in:
optional cursor = 1
The cursor from which the subscriber will start receiving messages once flow control tokens become available.
message
publisher.proto:75Request to publish messages to the topic.
Used in:
repeated messages = 1
The messages to publish.
int64 first_sequence_number = 2
The sequence number corresponding to the first message in `messages`. Messages within a batch are ordered and the sequence numbers of all subsequent messages in the batch are assumed to be incremental. Sequence numbers are assigned at the message level and the first message published in a publisher client session must have a sequence number of 0. All messages must have contiguous sequence numbers, which uniquely identify the messages accepted by the publisher client. Since messages are ordered, the client only needs to specify the sequence number of the first message in a published batch. The server deduplicates messages with the same sequence number from the same publisher `client_id`.
message
publisher.proto:94Response to a MessagePublishRequest.
Used in:
optional start_cursor = 1
The cursor of the first published message in the batch. The cursors for any remaining messages in the batch are guaranteed to be sequential.
repeated cursor_ranges = 2
Cursors for messages published in the batch. There will exist multiple ranges when cursors are not contiguous within the batch. The cursor ranges may not account for all messages in the batch when publish idempotency is enabled. A missing range indicates that cursors could not be determined for messages within the range, as they were deduplicated and the necessary data was not available at publish time. These messages will have offsets when received by a subscriber.
message
publisher.proto:96Cursors for a subrange of published messages.
Used in:
optional start_cursor = 1
The cursor of the message at the start index. The cursors for remaining messages up to the end index (exclusive) are sequential.
int32 start_index = 2
Index of the message in the published batch that corresponds to the start cursor. Inclusive.
int32 end_index = 3
Index of the last message in this range. Exclusive.
message
subscriber.proto:154Response containing a list of messages. Upon delivering a MessageResponse to the client, the server: * Updates the stream's delivery cursor to one greater than the cursor of the last message in the list. * Subtracts the total number of bytes and messages from the tokens available to the server.
Used in:
repeated messages = 1
Messages from the topic partition.
message
admin.proto:509Metadata for long running operations.
optional create_time = 1
The time the operation was created.
optional end_time = 2
The time the operation finished running. Not set if the operation has not completed.
string target = 3
Resource path for the target of the operation. For example, targets of seeks are subscription resources, structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
string verb = 4
Name of the verb executed by the operation.
message
subscriber.proto:206Acknowledge receipt and handling of the previous assignment. If not sent within a short period after receiving the assignment, partitions may remain unassigned for a period of time until the client is known to be inactive, after which time the server will break the stream.
Used in:
(message has no fields)
message
cursor.proto:160A pair of a Cursor and the partition it is for.
Used in:
int64 partition = 1
The partition this is for.
optional cursor = 2
The value of the cursor.
message
common.proto:40A message that is published by publishers and delivered to subscribers.
Used in: ,
bytes key = 1
The key used for routing messages to partitions or for compaction (e.g., keep the last N messages per key). If the key is empty, the message is routed to an arbitrary partition.
bytes data = 2
The payload of the message.
map<string, > attributes = 3
Optional attributes that can be used for message metadata/headers.
optional event_time = 4
An optional, user-specified event time.
message
common.proto:80Metadata about a reservation resource.
Used as response type in: AdminService.CreateReservation, AdminService.GetReservation, AdminService.UpdateReservation
Used as field type in: , ,
string name = 1
The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
int64 throughput_capacity = 2
The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
message
subscriber.proto:91Request to update the stream's delivery cursor based on the given target. Resets the server available tokens to 0. SeekRequests past head result in stream breakage. SeekRequests may not be sent while another SeekRequest is outstanding (i.e., has not received a SeekResponse) on the same stream.
Used in: ,
oneof target
The target to seek to. Must be set.
SeekRequest.NamedTarget named_target = 1
A named target.
cursor = 2
A target corresponding to the cursor, pointing to anywhere in the topic partition.
A special target in the partition that takes no other parameters.
Used in:
NAMED_TARGET_UNSPECIFIED = 0
Default value. This value is unused.
HEAD = 1
A target corresponding to the most recently published message in the partition.
COMMITTED_CURSOR = 2
A target corresponding to the committed cursor for the given subscription and topic partition.
message
subscriber.proto:118Response to a SeekRequest.
Used in:
optional cursor = 1
The new delivery cursor for the current stream.
A named position with respect to the message backlog.
Used in:
NAMED_TARGET_UNSPECIFIED = 0
Unspecified named target. Do not use.
TAIL = 1
Seek to the oldest retained message.
HEAD = 2
Seek past all recently published messages, skipping the entire message backlog.
message
admin.proto:506Response for SeekSubscription long running operation.
(message has no fields)
message
cursor.proto:81Streaming request to update the committed cursor. Subsequent SequencedCommitCursorRequests override outstanding ones.
Used in:
optional cursor = 1
The new value for the committed cursor.
message
cursor.proto:87Response to a SequencedCommitCursorRequest.
Used in:
int64 acknowledged_commits = 1
The number of outstanding SequencedCommitCursorRequests acknowledged by this response. Note that SequencedCommitCursorRequests are acknowledged in the order that they are received.
message
common.proto:64A message that has been stored and sequenced by the Pub/Sub Lite system.
Used in:
optional cursor = 1
The position of a message within the partition where it is stored.
optional publish_time = 2
The time when the message was received by the server when it was first published.
optional message = 3
The user message.
int64 size_bytes = 4
The size in bytes of this message for flow control and quota purposes.
message
common.proto:186Metadata about a subscription resource.
Used as response type in: AdminService.CreateSubscription, AdminService.GetSubscription, AdminService.UpdateSubscription
Used as field type in: , ,
string name = 1
The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
string topic = 2
The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
optional delivery_config = 3
The settings for this subscription's message delivery.
optional export_config = 4
If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.
message
common.proto:193The settings for a subscription's message delivery.
Used in:
DeliveryConfig.DeliveryRequirement delivery_requirement = 3
The DeliveryRequirement for this subscription.
When this subscription should send messages to subscribers relative to messages persistence in storage. For details, see [Creating Lite subscriptions](https://cloud.google.com/pubsub/lite/docs/subscriptions#creating_lite_subscriptions).
Used in:
DELIVERY_REQUIREMENT_UNSPECIFIED = 0
Default value. This value is unused.
DELIVER_IMMEDIATELY = 1
The server does not wait for a published message to be successfully written to storage before delivering it to subscribers.
DELIVER_AFTER_STORED = 2
The server will not deliver a published message to subscribers until the message has been successfully written to storage. This will result in higher end-to-end latency, but consistent delivery.
message
common.proto:298A target publish or event time. Can be used for seeking to or retrieving the corresponding cursor.
Used in: ,
oneof time
The type of message time to query.
publish_time = 1
Request the cursor of the first message with publish time greater than or equal to `publish_time`. All messages thereafter are guaranteed to have publish times >= `publish_time`.
event_time = 2
Request the cursor of the first message with event time greater than or equal to `event_time`. If messages are missing an event time, the publish time is used as a fallback. As event times are user supplied, subsequent messages may have event times less than `event_time` and should be filtered by the client, if necessary.
message
common.proto:102Metadata about a topic resource.
Used as response type in: AdminService.CreateTopic, AdminService.GetTopic, AdminService.UpdateTopic
Used as field type in: , ,
string name = 1
The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}
optional partition_config = 2
The settings for this topic's partitions.
optional retention_config = 3
The settings for this topic's message retention.
optional reservation_config = 4
The settings for this topic's Reservation usage.
message
common.proto:109The settings for a topic's partitions.
Used in:
int64 count = 1
The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
oneof dimension
The throughput dimension of this topic.
int32 scale = 2
DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].
capacity = 3
The capacity configuration.
message
common.proto:111The throughput capacity configuration for each partition.
Used in:
int32 publish_mib_per_sec = 1
Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.
int32 subscribe_mib_per_sec = 2
Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.
message
common.proto:161The settings for this topic's Reservation usage.
Used in:
string throughput_reservation = 1
The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
message
common.proto:147The settings for a topic's message retention.
Used in:
int64 per_partition_bytes = 1
The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`.
optional period = 2
How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`.