Index
AdminService
(Schnittstelle)CursorService
(Schnittstelle)PublisherService
(Schnittstelle)SubscriberService
(Schnittstelle)AttributeValues
(Meldung)CommitCursorRequest
(Meldung)CommitCursorResponse
(Meldung)CreateSubscriptionRequest
(Meldung)CreateTopicRequest
(Meldung)Cursor
(Meldung)DeleteSubscriptionRequest
(Meldung)DeleteTopicRequest
(Meldung)FlowControlRequest
(Meldung)GetSubscriptionRequest
(Meldung)GetTopicPartitionsRequest
(Meldung)GetTopicRequest
(Meldung)InitialCommitCursorRequest
(Meldung)InitialCommitCursorResponse
(Meldung)InitialPublishRequest
(Meldung)InitialPublishResponse
(Meldung)InitialSubscribeRequest
(Meldung)InitialSubscribeResponse
(Meldung)ListPartitionCursorsRequest
(Meldung)ListPartitionCursorsResponse
(Meldung)ListSubscriptionsRequest
(Meldung)ListSubscriptionsResponse
(Meldung)ListTopicSubscriptionsRequest
(Meldung)ListTopicSubscriptionsResponse
(Meldung)ListTopicsRequest
(Meldung)ListTopicsResponse
(Meldung)MessagePublishRequest
(Meldung)MessagePublishResponse
(Meldung)MessageResponse
(Meldung)PartitionCursor
(Meldung)PubSubMessage
(Meldung)PublishRequest
(Meldung)PublishResponse
(Meldung)SeekRequest
(Meldung)SeekRequest.NamedTarget
(Aufzählung)SeekResponse
(Meldung)SequencedCommitCursorRequest
(Meldung)SequencedCommitCursorResponse
(Meldung)SequencedMessage
(Meldung)StreamingCommitCursorRequest
(Meldung)StreamingCommitCursorResponse
(Meldung)SubscribeRequest
(Meldung)SubscribeResponse
(Meldung)Subscription
(Meldung)Subscription.DeliveryConfig
(Meldung)Subscription.DeliveryConfig.DeliveryRequirement
(Aufzählung)Topic
(Meldung)Topic.PartitionConfig
(Meldung)Topic.RetentionConfig
(Meldung)TopicPartitions
(Meldung)UpdateSubscriptionRequest
(Meldung)UpdateTopicRequest
(Meldung)
AdminService
Der Dienst, mit dem eine Clientanwendung Themen und Abos verwaltet, z. B. das Erstellen, Auflisten und Löschen von Themen und Abos.
CreateSubscription | |
---|---|
Erstellt ein neues Abo.
|
CreateTopic | |
---|---|
Erstellt ein neues Thema.
|
DeleteSubscription | |
---|---|
Löscht das angegebene Abo.
|
DeleteTopic | |
---|---|
Löscht das angegebene Thema.
|
GetSubscription | |
---|---|
Gibt die Abo-Konfiguration zurück.
|
GetTopic | |
---|---|
Gibt die Konfiguration des Themas zurück.
|
GetTopicPartitions | |
---|---|
Gibt die Partitionsinformationen für das angeforderte Thema zurück.
|
ListSubscriptions | |
---|---|
Gibt die Liste der Abos für das angegebene Projekt zurück.
|
ListTopicSubscriptions | |
---|---|
Listet die Abos auf, die mit dem angegebenen Thema verknüpft sind.
|
ListTopics | |
---|---|
Gibt die Liste der Themen für das angegebene Projekt zurück.
|
UpdateSubscription | |
---|---|
Aktualisiert die Attribute des angegebenen Abos.
|
UpdateTopic | |
---|---|
Aktualisiert die Attribute des angegebenen Themas.
|
CursorService
Der Dienst, den eine Abonnentenclientanwendung verwendet, um zugesicherte Cursor zu verwalten, während Nachrichten empfangen werden. Ein Cursor stellt den Fortschritt eines Abonnenten innerhalb einer Themenpartition für ein bestimmtes Abo dar.
CommitCursor | |
---|---|
Aktualisiert den Commit-Cursor.
|
ListPartitionCursors | |
---|---|
Gibt alle Commit-Cursor-Informationen für ein Abo zurück.
|
StreamingCommitCursor | |
---|---|
Richtet einen Stream mit dem Server für die Verwaltung von Commit-Cursors ein.
|
PublisherService
Der Dienst, den eine Publisher-Client-Anwendung zum Veröffentlichen von Nachrichten zu Themen verwendet. Veröffentlichte Nachrichten werden vom Dienst für die Dauer des für das jeweilige Thema konfigurierten Aufbewahrungsdauer aufbewahrt und werden auf Anfrage über SubscriberService
an Abonnentenclients gesendet.
Veröffentlichen | |
---|---|
Richtet einen Stream mit dem Server für die Veröffentlichung von Nachrichten ein. Nachdem der Stream initialisiert wurde, veröffentlicht der Client Nachrichten, indem er Veröffentlichungsanfragen im Stream sendet. Der Server antwortet mit einer PublishResponse für jede vom Client gesendete PublishRequest in der Reihenfolge, in der die Anfragen gesendet wurden. Beachten Sie, dass mehrere PublishRequests gleichzeitig ausgeführt werden können, aber vom Server in der Reihenfolge verarbeitet werden, in der sie vom Client in einem bestimmten Stream gesendet werden.
|
SubscriberService
Der Dienst, den eine Abonnentenclientanwendung zum Empfangen von Nachrichten von Abonnements verwendet.
Abonnieren | |
---|---|
Richtet einen Stream mit dem Server für den Empfang von Nachrichten ein.
|
AttributeValues
Die mit einem Schlüssel eines Attributs verknüpften Werte.
Felder | |
---|---|
values[] |
Die Liste der mit einem Schlüssel verknüpften Werte. |
CommitCursorRequest
Anfrage für CommitCursor.
Felder | |
---|---|
subscription |
Das Abo, für das der Cursor aktualisiert werden soll. |
partition |
Die Partition, für die der Cursor aktualisiert werden soll. Partitionen sind null indexiert, daher muss |
cursor |
Der neue Wert für den Commit-Cursor. |
CommitCursorResponse
Antwort für CommitCursor.
CreateSubscriptionRequest
Anfrage für CreateSubscription.
Felder | |
---|---|
parent |
Erforderlich Der übergeordnete Standort, an dem das Abo erstellt werden soll. Strukturiert wie |
subscription |
Erforderlich Konfiguration des zu erstellenden Abos. Das Feld |
subscription_id |
Erforderlich Die für das Abo zu verwendende ID, die die letzte Komponente des Abonamens wird. Dieser Wert ist strukturiert wie: |
CreateTopicRequest
Anfrage für CreateTopic.
Felder | |
---|---|
parent |
Erforderlich Der übergeordnete Speicherort, an dem das Thema erstellt werden soll. Strukturiert wie |
topic |
Erforderlich Konfiguration des zu erstellenden Themas. Das Feld |
topic_id |
Erforderlich Die für das Thema zu verwendende ID, die die letzte Komponente des Themennamens wird. Dieser Wert ist strukturiert wie: |
Cursor
Ein Cursor, der die Position einer Nachricht innerhalb einer Themenpartition beschreibt.
Felder | |
---|---|
offset |
Der Offset einer Nachricht innerhalb einer Themenpartition. Muss größer oder gleich 0 sein. |
DeleteSubscriptionRequest
Anfrage für DeleteSubscription.
Felder | |
---|---|
name |
Erforderlich Der Name des zu löschenden Abos. |
DeleteTopicRequest
Anfrage für DeleteTopic.
Felder | |
---|---|
name |
Erforderlich Der Name des zu löschenden Themas. |
FlowControlRequest
Anfrage zum Erteilen von Tokens an den Server, die die Zustellung von Nachrichten anfordert, sobald sie verfügbar sind.
Felder | |
---|---|
allowed_messages |
Die Anzahl der zu erteilenden Nachrichtentokens. muss größer oder gleich 0 sein. |
allowed_bytes |
Die Anzahl der zu erteilenden Byte-Tokens. muss größer oder gleich 0 sein. |
GetSubscriptionRequest
Anfrage für GetSubscription.
Felder | |
---|---|
name |
Erforderlich Der Name des Abos, dessen Konfiguration zurückgegeben werden soll. |
GetTopicPartitionsRequest
Anfrage für GetTopicPartitions.
Felder | |
---|---|
name |
Erforderlich Das Thema, dessen Partitionsinformationen zurückgegeben werden sollen. |
GetTopicRequest
Anfrage für GetTopic.
Felder | |
---|---|
name |
Erforderlich Der Name des Themas, dessen Konfiguration zurückgegeben werden soll. |
InitialCommitCursorRequest
Die erste Streaming-Anfrage, die über einen neu geöffneten Stream gesendet werden muss. Der Client muss auf die Antwort warten, bevor er weitere Anfragen über den Stream sendet.
Felder | |
---|---|
subscription |
Das Abo, für das Commited-Cursors verwaltet werden sollen. |
partition |
Die Partition, für die zugesicherte Cursor verwaltet werden sollen. Partitionen sind null indexiert, daher muss |
InitialCommitCursorResponse
Antwort auf eine InitialCommitCursorRequest.
InitialPublishRequest
Die erste Anfrage, die über einen neu geöffneten Stream gesendet werden muss.
Felder | |
---|---|
topic |
Das Thema, in das Nachrichten geschrieben werden. |
partition |
Die Partition innerhalb des Themas, in die Nachrichten geschrieben werden. Partitionen sind null indexiert, daher muss |
InitialPublishResponse
Antwort auf eine InitialPublishRequest.
InitialSubscribeRequest
Die erste Anfrage, die über einen neu geöffneten Stream gesendet werden muss. Der Client muss auf die Antwort warten, bevor er weitere Anfragen über den Stream sendet.
Felder | |
---|---|
subscription |
Das Abo, von dem Nachrichten empfangen werden sollen. |
partition |
Die Partition, von der Nachrichten empfangen werden sollen. Partitionen sind null indexiert, daher muss |
InitialSubscribeResponse
Antwort auf eine InitialSubscribeRequest.
Felder | |
---|---|
cursor |
Der Cursor, ab dessen Position der Abonnent Nachrichten empfängt, sobald Ablaufsteuerungstokens verfügbar sind. |
ListPartitionCursorsRequest
Anfrage für ListPartitionCursors.
Felder | |
---|---|
parent |
Erforderlich Das Abo, für das Cursors abgerufen werden sollen. Strukturiert wie |
page_size |
Die maximale Anzahl der zurückzugebenden Cursor. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht festgelegt oder null, werden alle Cursor für das übergeordnete Element zurückgegeben. |
page_token |
Ein Seitentoken, das von einem vorherigen Beim Paginieren müssen alle anderen für |
ListPartitionCursorsResponse
Antwort für ListPartitionCursors
Felder | |
---|---|
partition_cursors[] |
Die Partitions-Cursors dieser Anfrage. |
next_page_token |
Ein Token, das als |
ListSubscriptionsRequest
Anfrage für ListSubscriptions.
Felder | |
---|---|
parent |
Erforderlich Das übergeordnete Element, dessen Abos aufgelistet werden sollen. Strukturiert wie |
page_size |
Die maximale Anzahl von Abos, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht festgelegt oder null, werden alle Abos für das übergeordnete Element zurückgegeben. |
page_token |
Ein Seitentoken, das von einem vorherigen Beim Paginieren müssen alle anderen für |
ListSubscriptionsResponse
Antwort für ListSubscriptions.
Felder | |
---|---|
subscriptions[] |
Die Liste der Abos im angeforderten übergeordneten Element. Die Reihenfolge der Abos ist nicht angegeben. |
next_page_token |
Ein Token, das als |
ListTopicSubscriptionsRequest
Anfrage für ListTopicSubscriptions.
Felder | |
---|---|
name |
Erforderlich Der Name des Themas, dessen Abos aufgelistet werden sollen. |
page_size |
Die maximale Anzahl von Abos, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht festgelegt oder null, werden alle Abos für das angegebene Thema zurückgegeben. |
page_token |
Ein Seitentoken, das von einem vorherigen Beim Paginieren müssen alle anderen für |
ListTopicSubscriptionsResponse
Antwort für ListTopicSubscriptions.
Felder | |
---|---|
subscriptions[] |
Die Namen der mit dem Thema verknüpften Abos. Die Reihenfolge der Abos ist nicht angegeben. |
next_page_token |
Ein Token, das als |
ListTopicsRequest
Anfrage für ListTopics.
Felder | |
---|---|
parent |
Erforderlich Das übergeordnete Element, dessen Themen aufgelistet werden sollen. Strukturiert wie |
page_size |
Die maximale Anzahl der zurückzugebenden Themen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht festgelegt oder null, werden alle Themen für das übergeordnete Element zurückgegeben. |
page_token |
Ein Seitentoken, das von einem vorherigen Beim Paginieren müssen alle anderen für |
ListTopicsResponse
Antwort für ListTopics.
Felder | |
---|---|
topics[] |
Die Liste der Themen im angeforderten übergeordneten Element. Die Reihenfolge der Themen ist nicht angegeben. |
next_page_token |
Ein Token, das als |
MessagePublishRequest
Anfrage zum Veröffentlichen von Nachrichten zu dem Thema
Felder | |
---|---|
messages[] |
MessagePublishResponse
Antwort auf eine MessagePublishRequest.
Felder | |
---|---|
start_cursor |
Der Cursor der ersten veröffentlichten Nachricht im Batch. Die Cursors für alle verbleibenden Nachrichten im Batch sind sequenziell. |
MessageResponse
Antwort mit einer Liste von Nachrichten. Nach der Zustellung einer MessageResponse an den Client: *Aktualisiert den Zustellungscursor des Streams auf einen Wert, der größer als der Cursor der letzten Nachricht in der Liste ist. *Subtrahiert die Gesamtzahl der Byte und Nachrichten aus den für den Server verfügbaren Tokens.
Felder | |
---|---|
messages[] |
Nachrichten aus der Themenpartition |
PartitionCursor
Ein Paar aus einem Cursor und der Partition, für die er vorgesehen ist.
Felder | |
---|---|
partition |
Die Partition, für die dies vorgesehen ist. |
cursor |
Der Wert des Cursors. |
PubSubMessage
Eine Nachricht, die von Publishern veröffentlicht und an Abonnenten gesendet wird.
Felder | |
---|---|
key |
Der Schlüssel, der zum Weiterleiten von Nachrichten an Partitionen oder zur Verdichtung verwendet wird (z. B. die letzten N Nachrichten pro Schlüssel behalten). Wenn der Schlüssel leer ist, wird die Nachricht an eine beliebige Partition weitergeleitet. |
data |
Die Nutzlast der Nachricht. |
attributes |
Optionale Attribute, die für Metadaten/Header von Nachrichten verwendet werden können. |
event_time |
Eine optionale, benutzerdefinierte Ereigniszeit. |
PublishRequest
Anfrage, die vom Client an den Server über einen Stream gesendet wird.
Felder | ||
---|---|---|
Union-Feld Für |
||
initial_request |
Erste Anfrage auf dem Stream. |
|
message_publish_request |
Anfrage zur Veröffentlichung von Nachrichten. |
PublishResponse
Antwort auf eine PublishRequest.
Felder | ||
---|---|---|
Union-Feld Für |
||
initial_response |
Erste Antwort im Stream. |
|
message_response |
Antwort auf die Veröffentlichung von Nachrichten. |
SeekRequest
Anfrage zum Aktualisieren des Zustellungscursors des Streams basierend auf dem angegebenen Ziel. Setzt die verfügbaren Server-Tokens auf 0 zurück. SeekRequests dürfen nicht gesendet werden, solange ein anderer SeekRequest auf demselben Stream aussteht (d. h. keine SeekResponse erhalten hat). SeekRequests nach dem Head führen zu einer Unterbrechung des Streams.
Felder | ||
---|---|---|
Union-Feld target . Das Ziel, zu dem gesprungen werden soll. darf nicht leer bleiben Für target ist nur einer der folgenden Werte zulässig: |
||
named_target |
Ein benanntes Ziel. |
|
cursor |
Ein Ziel, das dem Cursor entspricht und auf eine beliebige Stelle in der Themenpartition verweist. |
NamedTarget
Ein spezielles Ziel in der Partition, das keine anderen Parameter nimmt.
Enums | |
---|---|
NAMED_TARGET_UNSPECIFIED |
Standardwert Dieser Wert wird nicht verwendet. |
HEAD |
Ein Ziel, das der zuletzt veröffentlichten Nachricht in der Partition entspricht. |
COMMITTED_CURSOR |
Ein Ziel, das dem Commit-Cursor für die angegebene Abo- und Themenpartition entspricht. |
SeekResponse
Antwort auf eine SeekRequest.
Felder | |
---|---|
cursor |
Der neue Zustellungscursor für den aktuellen Stream. |
SequencedCommitCursorRequest
Streaming-Anfrage zum Aktualisieren des zugesicherten Cursors. Nachfolgende SequencedCommitCursorRequests überschreiben ausstehende.
Felder | |
---|---|
cursor |
Der neue Wert für den Commit-Cursor. |
SequencedCommitCursorResponse
Antwort auf eine SequencedCommitCurser-Anfrage.
Felder | |
---|---|
acknowledged_commits |
Die Anzahl ausstehender SequencedCommitCursorRequests, die von dieser Antwort bestätigt wurden. Beachten Sie, dass SequencedCommitCursorRequests in der Reihenfolge ihres Eingangs bestätigt werden. |
SequencedMessage
Felder | |
---|---|
cursor |
Die Position einer Nachricht innerhalb der Partition, in der sie gespeichert ist. |
publish_time |
Der Zeitpunkt, zu dem die Nachricht vom Server bei der ersten Veröffentlichung empfangen wurde. |
message |
Die Nachricht des Nutzers. |
size_bytes |
Die Größe dieser Nachricht in Byte für Ablaufsteuerungs- und Kontingentzwecke. |
StreamingCommitCursorRequest
Anfrage, die vom Client an den Server über einen Stream gesendet wird.
Felder | ||
---|---|---|
Union-Feld Für |
||
initial |
Erste Anfrage auf dem Stream. |
|
commit |
Anfrage zum Commit eines neuen Cursorwerts. |
StreamingCommitCursorResponse
Antwort auf eine StreamingCommitCursorRequest.
Felder | ||
---|---|---|
Union-Feld Für |
||
initial |
Erste Antwort im Stream. |
|
commit |
Antwort auf das Committen eines neuen Cursorwerts. |
SubscribeRequest
Anfrage, die vom Client an den Server über einen Stream gesendet wird.
Felder | ||
---|---|---|
Union-Feld Für |
||
initial |
Erste Anfrage auf dem Stream. |
|
seek |
Anfrage zur Aktualisierung des Zustellungscursors des Streams. |
|
flow_control |
Anfrage zum Zuweisen von Tokens an den Server, |
SubscribeResponse
Antwort auf SubscribeRequest
Felder | ||
---|---|---|
Union-Feld Für |
||
initial |
Erste Antwort im Stream. |
|
seek |
Antwort auf einen Suchvorgang. |
|
messages |
Antwort, die Nachrichten von der Themenpartition enthält. |
Abo
Metadaten zu einer Aboressource.
Felder | |
---|---|
name |
Der Name des Abos. Strukturiert wie: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} |
topic |
Der Name des Themas, mit dem dieses Abo verknüpft ist. Strukturiert wie: projects/{project_number}/locations/{location}/topics/{topic_id} |
delivery_config |
Die Einstellungen für die Nachrichtenzustellung dieses Abos. |
DeliveryConfig
Die Einstellungen für die Nachrichtenzustellung eines Abos.
Felder | |
---|---|
delivery_requirement |
Die Auslieferungsanforderung für dieses Abo. |
DeliveryRequirement
Gibt an, wann dieses Abo Nachrichten an Abonnenten im Verhältnis zur Persistenz von Nachrichten senden soll. Weitere Informationen finden Sie unter Lite-Abos erstellen.
Enums | |
---|---|
DELIVERY_REQUIREMENT_UNSPECIFIED |
Standardwert Dieser Wert wird nicht verwendet. |
DELIVER_IMMEDIATELY |
Der Server wartet nicht darauf, dass eine veröffentlichte Nachricht erfolgreich in den Speicher geschrieben wird, bevor sie an Abonnenten gesendet wird. |
DELIVER_AFTER_STORED |
Der Server sendet eine veröffentlichte Nachricht erst dann an Abonnenten, wenn die Nachricht erfolgreich in den Speicher geschrieben wurde. Dies führt zu einer höheren End-to-End-Latenz, aber einer konsistenten Bereitstellung. |
Topic
Metadaten zu einer Themenressource.
Felder | |
---|---|
name |
Der Name des Themas. Strukturiert wie: projects/{project_number}/locations/{location}/topics/{topic_id} |
partition_config |
Die Einstellungen für die Partitionen dieses Themas. |
retention_config |
Die Einstellungen für die Nachrichtenaufbewahrung dieses Themas. |
PartitionConfig
Die Einstellungen für die Partitionen eines Themas.
Felder | |
---|---|
count |
Die Anzahl der Partitionen im Thema. Muss mindestens 1 sein |
scale |
Jeder Partition im Thema wird ein Durchsatz zugewiesen, der dem |
RetentionConfig
Die Einstellungen für die Nachrichtenaufbewahrung eines Themas.
Felder | |
---|---|
per_partition_bytes |
Der bereitgestellte Speicher in Byte pro Partition. Wenn die Anzahl der in einer der Partitionen des Themas gespeicherten Byte diesen Wert überschreitet, werden ältere Nachrichten gelöscht, um Platz für neuere Nachrichten zu schaffen, unabhängig vom Wert von |
period |
Die Aufbewahrungsdauer einer veröffentlichten Nachricht. Wenn nicht weiter festgelegt, werden Nachrichten aufbewahrt, solange die für jede Partition aufbewahrten Byte unter |
TopicPartitions
Antwort für GetTopicPartitions.
Felder | |
---|---|
partition_count |
Die Anzahl der Partitionen im Thema. |
UpdateSubscriptionRequest
Anfrage für UpdateSubscription.
Felder | |
---|---|
subscription |
Erforderlich Das zu aktualisierende Abo. Das Feld |
update_mask |
Erforderlich Eine Maske, die die zu ändernden Abofelder angibt. |
UpdateTopicRequest
Anfrage für UpdateTopic.
Felder | |
---|---|
topic |
Erforderlich Das zu aktualisierende Thema. Das Feld |
update_mask |
Erforderlich Eine Maske, die die zu ändernden Themenfelder angibt. |