google.cloud.pubsublite.v1 软件包

索引

AdminService

客户端应用用于管理主题和订阅(例如创建,列出和删除主题和订阅)的服务。

CreateSubscription

rpc CreateSubscription(CreateSubscriptionRequest) returns (Subscription)

创建新订阅。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

CreateTopic

rpc CreateTopic(CreateTopicRequest) returns (Topic)

创建一个新主题。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

DeleteSubscription

rpc DeleteSubscription(DeleteSubscriptionRequest) returns (Empty)

删除指定的订阅。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

DeleteTopic

rpc DeleteTopic(DeleteTopicRequest) returns (Empty)

删除指定的主题。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

GetSubscription

rpc GetSubscription(GetSubscriptionRequest) returns (Subscription)

返回订阅配置。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

GetTopic

rpc GetTopic(GetTopicRequest) returns (Topic)

返回主题配置。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

GetTopicPartitions

rpc GetTopicPartitions(GetTopicPartitionsRequest) returns (TopicPartitions)

返回所请求主题的分区信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

ListSubscriptions

rpc ListSubscriptions(ListSubscriptionsRequest) returns (ListSubscriptionsResponse)

返回给定项目的订阅列表。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

ListTopicSubscriptions

rpc ListTopicSubscriptions(ListTopicSubscriptionsRequest) returns (ListTopicSubscriptionsResponse)

列出附加到指定主题的订阅。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

ListTopics

rpc ListTopics(ListTopicsRequest) returns (ListTopicsResponse)

返回给定项目的主题列表。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

UpdateSubscription

rpc UpdateSubscription(UpdateSubscriptionRequest) returns (Subscription)

更新指定订阅的属性。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

UpdateTopic

rpc UpdateTopic(UpdateTopicRequest) returns (Topic)

更新指定主题的属性。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

CursorService

订阅者客户端应用在接收消息时用于管理提交的光标的服务。光标表示订阅者在给定订阅的主题分区中的进度。

CommitCursor

rpc CommitCursor(CommitCursorRequest) returns (CommitCursorResponse)

更新提交的光标。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

ListPartitionCursors

rpc ListPartitionCursors(ListPartitionCursorsRequest) returns (ListPartitionCursorsResponse)

返回订阅的所有提交的光标信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

StreamingCommitCursor

rpc StreamingCommitCursor(StreamingCommitCursorRequest) returns (StreamingCommitCursorResponse)

与服务器建立数据流,用于管理提交的光标。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

PublisherService

发布者客户端应用用于将消息发布到主题的服务。已发布的消息会在为相应主题配置的保留期限内由服务保留,并根据请求(通过 SubscriberService)传送给订阅者客户端。

发布

rpc Publish(PublishRequest) returns (PublishResponse)

与服务器建立数据流,用于发布消息。数据流初始化后,客户端通过在数据流上发送发布请求来发布消息。对于客户端发送的每个 PublishRequest,服务器都用 PublishResponse 响应,其顺序与请求顺序相同。请注意,多个 PublishRequest 可以同时进行,但是它们将由服务器按照客户端在给定流上发送它们的顺序进行处理。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

SubscriberService

订阅者客户端应用用于接收来自订阅的消息的服务。

订阅

rpc Subscribe(SubscribeRequest) returns (SubscribeResponse)

与服务器建立数据流,用于接收消息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

AttributeValues

与特性的键相关联的值。

字段
values[]

bytes

与键关联的值的列表。

CommitCursorRequest

对 CommitCursor 的请求。

字段
subscription

string

要为其更新光标的订阅。

partition

int64

要为其更新光标的分区。分区是零索引,因此 partition 必须在 [0, topic.num_partitions) 范围内。

cursor

Cursor

提交的光标的新值。

CommitCursorResponse

对 CommitCursor 的响应。

CreateSubscriptionRequest

对 CreateSubscription 的请求。

字段
parent

string

必需。要在其中创建订阅的父级位置。结构类似 projects/{project_number}/locations/{location}

subscription

Subscription

必需。要创建的订阅的配置。其 name 字段被忽略。

subscription_id

string

必需。用于订阅的 ID,将成为订阅名称的最终组成部分。

此值的结构类似于:my-sub-name

CreateTopicRequest

对 CreateTopic 的请求。

字段
parent

string

必需。要在其中创建主题的父级位置。结构类似 projects/{project_number}/locations/{location}

topic

Topic

必需。要创建的主题的配置。其 name 字段被忽略。

topic_id

string

必需。主题使用的 ID,将成为主题名称的最终组成部分。

此值的结构类似于:my-topic-name

光标

描述消息在主题分区中的位置的光标。

字段
offset

int64

消息在主题分区中的偏移量。必须大于或等于 0。

DeleteSubscriptionRequest

对 DeleteSubscription 的请求。

字段
name

string

必需。要删除的订阅名称。

DeleteTopicRequest

对 DeleteTopic 的请求。

字段
name

string

必需。要删除的主题的名称。

FlowControlRequest

请求向服务器授予令牌,并在令牌可用时请求传送消息。

字段
allowed_messages

int64

要授予的消息令牌数。必须大于等于 0。

allowed_bytes

int64

要授予的字节令牌数。必须大于等于 0。

GetSubscriptionRequest

对 GetSubscription 的请求。

字段
name

string

必需。要返回其配置的订阅的名称。

GetTopicPartitionsRequest

对 GetTopicPartitions 的请求。

字段
name

string

必需。要返回其分区信息的主题。

GetTopicRequest

对 GetTopic 的请求。

字段
name

string

必需。要返回其配置的主题的名称。

InitialCommitCursorRequest

必须在新打开的数据流上发送的第一个流式请求。客户端必须先等待响应,然后才能在数据流上发送后续请求。

字段
subscription

string

要为其管理提交的光标的订阅。

partition

int64

要管理所提交的光标的分区。分区是零索引,因此 partition 必须在 [0, topic.num_partitions) 范围内。

InitialCommitCursorResponse

对 InitialCommitCursorRequest 的响应.

InitialPublishRequest

必须在新打开的数据流上发送的第一个请求。

字段
topic

string

消息将写入的主题。

partition

int64

主题中将写入消息的分区。分区是零索引,因此 partition 必须在 [0, topic.num_partitions) 范围内。

InitialPublishResponse

对 InitialPublishRequest 的响应。

InitialSubscribeRequest

必须在新打开的数据流上发送的第一个请求。客户端必须先等待响应,然后才能在数据流上发送后续请求。

字段
subscription

string

从中接收消息的订阅。

partition

int64

从中接收消息的分区。分区是零索引,因此 partition 必须在 [0, topic.num_partitions) 范围内。

InitialSubscribeResponse

对 InitialSubscribeRequest 的响应。

字段
cursor

Cursor

一旦流控制令牌可用,订阅者将从其中开始接收消息的光标。

ListPartitionCursorsRequest

对 ListPartitionCursors 的请求。

字段
parent

string

必需。用于检索光标的订阅。结构类似 projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

page_size

int32

要返回的光标数量上限。服务返回的值可能小于此值。如果值未设置或为零,则返回父级的所有光标。

page_token

string

从之前的 ListPartitionCursors 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListPartitionCursors 的所有其他参数必须与提供页面令牌的调用匹配。

ListPartitionCursorsResponse

对 ListPartitionCursors 的响应

字段
partition_cursors[]

PartitionCursor

此请求中的分区光标。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListSubscriptionsRequest

对 ListSubscriptions 的请求。

字段
parent

string

必需。要列出其订阅的父级。结构类似 projects/{project_number}/locations/{location}

page_size

int32

要返回的最大订阅数。服务返回的值可能小于此值。如果值未设置或为零,则返回父级的所有订阅。

page_token

string

从之前的 ListSubscriptions 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListSubscriptions 的所有其他参数必须与提供页面令牌的调用匹配。

ListSubscriptionsResponse

对 ListSubscriptions 的响应。

字段
subscriptions[]

Subscription

请求的父级中的订阅列表。未指定订阅的顺序。

next_page_token

string

可以作为 page_token 发送的令牌可用于检索下一页结果。如果省略此字段,则没有更多结果。

ListTopicSubscriptionsRequest

对 ListTopicSubscriptions 的请求。

字段
name

string

必需。要列出其订阅的主题的名称。

page_size

int32

要返回的最大订阅数。服务返回的值可能小于此值。如果值未设置或为零,将返回给定主题的所有订阅。

page_token

string

从之前的 ListTopicSubscriptions 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListTopicSubscriptions 的所有其他参数必须与提供页面令牌的调用匹配。

ListTopicSubscriptionsResponse

对 ListTopicSubscriptions 的响应。

字段
subscriptions[]

string

附加到主题的订阅名称。未指定订阅的顺序。

next_page_token

string

可以作为 page_token 发送的令牌可用于检索下一页结果。如果省略此字段,则没有更多结果。

ListTopicsRequest

对 ListTopics 的请求。

字段
parent

string

必需。要列出其主题的父级。结构类似 projects/{project_number}/locations/{location}

page_size

int32

要返回的最大主题数。服务返回的值可能小于此值。如果值未设置或为零,则返回父级的所有主题。

page_token

string

从之前的 ListTopics 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListTopics 的所有其他参数必须与提供页面令牌的调用匹配。

ListTopicsResponse

对 ListTopics 的响应。

字段
topics[]

Topic

请求的父级中的主题列表。未指定主题的顺序。

next_page_token

string

可以作为 page_token 发送的令牌可用于检索下一页结果。如果省略此字段,则没有更多结果。

MessagePublishRequest

请求向该主题发布消息。

字段
messages[]

PubSubMessage

MessagePublishResponse

对 MessagePublishRequest 的响应。

字段
start_cursor

Cursor

批量中第一条已发布消息的光标。批量中其余消息的光标保证是依序的。

MessageResponse

包含消息列表的响应。将 MessageResponse 传送到客户端时,服务器:*将数据流的传送光标更新为大于列表中最后一条消息的光标。* 从服务器可用的令牌中减去总字节数和消息数。

字段
messages[]

SequencedMessage

来自主题分区的消息。

PartitionCursor

一对光标及其针对的分区。

字段
partition

int64

此操作所针对的分区。

cursor

Cursor

光标的值。

PubSubMessage

由发布者发布并传送给订阅者的消息。

字段
key

bytes

用于将消息路由到分区或进行压缩的键(例如,保留每个键的最后 N 条消息)。如果键为空,则消息将路由到任意分区。

data

bytes

消息的负载。

attributes

map<string, AttributeValues>

可用于消息元数据/标头的可选属性。

event_time

Timestamp

一个可选的、用户指定的事件时间。

PublishRequest

从客户端向数据流上的服务器发送的请求。

字段

联合字段 request_type

request_type 只能是下列其中一项:

initial_request

InitialPublishRequest

数据流的初始请求。

message_publish_request

MessagePublishRequest

请求发布消息。

PublishResponse

对 PublishRequest 的响应。

字段

联合字段 response_type

response_type 只能是下列其中一项:

initial_response

InitialPublishResponse

数据流的初始响应。

message_response

MessagePublishResponse

对发布消息的响应。

SeekRequest

根据给定目标,请求更新数据流的传送光标。将服务器可用令牌重置为 0。当同一数据流中的一个 SeekRequest 尚未完成(即未收到 SeekResponse)时,可能无法发送其他 SeekRequest。在数据流中断时,SeekRequest 会返回过去的标头结果。

字段
联合字段 target。要跳转的目标。必须设置。target 只能是下列其中一项:
named_target

NamedTarget

已命名的目标。

cursor

Cursor

与光标对应的目标,指向主题分区中的任何位置。

NamedTarget

分区中不接受其他参数的特殊目标。

枚举
NAMED_TARGET_UNSPECIFIED 默认值。此值未使用。
HEAD 与分区中最新发布的消息相对应的目标。
COMMITTED_CURSOR 与给定订阅和主题分区的已提交光标对应的目标。

SeekResponse

对 SeekRequest 的响应。

字段
cursor

Cursor

当前数据流的新传送光标。

SequencedCommitCursorRequest

用于更新提交的光标的流式请求。后续的 SequencedCommitCursorRequests 会覆盖未完成的请求。

字段
cursor

Cursor

提交的光标的新值。

SequencedCommitCursorResponse

对 SequencedCommitCursorRequest 的响应。

字段
acknowledged_commits

int64

此响应所确认的待处理的 SequencedCommitCursorRequests 的数量。请注意,SequencedCommitCursorRequest 按接收顺序进行确认。

SequencedMessage

字段
cursor

Cursor

消息在存储它的分区中的位置。

publish_time

Timestamp

消息首次发布时服务器接收到消息的时间。

message

PubSubMessage

用户消息。

size_bytes

int64

此消息的大小(以字节为单位),用于流控制和配额。

StreamingCommitCursorRequest

从客户端向数据流上的服务器发送的请求。

字段

联合字段 request

request 只能是下列其中一项:

initial

InitialCommitCursorRequest

数据流的初始请求。

commit

SequencedCommitCursorRequest

请求提交一个新的光标值。

StreamingCommitCursorResponse

对 StreamingCommitCursorRequest 的响应。

字段

联合字段 request

request 只能是下列其中一项:

initial

InitialCommitCursorResponse

数据流的初始响应。

commit

SequencedCommitCursorResponse

对提交新光标值的响应。

SubscribeRequest

从客户端向数据流上的服务器发送的请求。

字段

联合字段 request

request 只能是下列其中一项:

initial

InitialSubscribeRequest

数据流的初始请求。

seek

SeekRequest

更新数据流的传送光标的请求。

flow_control

FlowControlRequest

向服务器授予令牌的请求,

SubscribeResponse

对 SubscribeRequest 的响应。

字段

联合字段 response

response 只能是下列其中一项:

initial

InitialSubscribeResponse

数据流的初始响应。

seek

SeekResponse

对还原操作的响应。

messages

MessageResponse

包含主题分区中消息的响应。

订阅

有关订阅资源的元数据。

字段
name

string

订阅的名称。结构如下:projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

topic

string

此订阅附加的主题的名称。结构如下:projects/{project_number}/locations/{location}/topics/{topic_id}

delivery_config

DeliveryConfig

此订阅消息的传送设置。

DeliveryConfig

订阅的消息传送设置。

字段
delivery_requirement

DeliveryRequirement

此订阅的传送要求。

DeliveryRequirement

此订阅何时应向存储空间中的永久性消息订阅者发送消息。 如需了解详情,请参阅创建精简版订阅

枚举
DELIVERY_REQUIREMENT_UNSPECIFIED 默认值。此值未使用。
DELIVER_IMMEDIATELY 在将已发布的消息传送给订阅者之前,服务器不会等待将已发布的消息成功写入存储器。
DELIVER_AFTER_STORED 只有在消息成功写入存储空间后,服务器才会向订阅者传送已发布的消息。这会导致端到端延迟时间变长,但传送会保持一致。

主题

有关主题资源的元数据。

字段
name

string

主题的名称。结构如下:projects/{project_number}/locations/{location}/topics/{topic_id}

partition_config

PartitionConfig

此主题的分区的设置。

retention_config

RetentionConfig

此主题的消息保留设置。

PartitionConfig

主题分区的设置。

字段
count

int64

主题中的分区数量。不得低于 1。

scale

int32

主题中的每个分区都分配有相当于标准分区吞吐量 (4 MiB/s)scale 倍的吞吐量。这也会反映在此主题的费用中;对于 scale 为 2 且计数为 10 的主题,您需要为 20 个分区支付费用。此值必须在范围 [1,4] 内。

RetentionConfig

主题的消息保留设置。

字段
per_partition_bytes

int64

为每个分区预配的存储空间(以字节为单位)。如果主题的任何分区中存储的字节数超过此值,则无论 period 的值如何,较旧的消息都将被舍弃以容纳新的消息。

period

Duration

已发布消息的保留时间。如果未设置,只要每个分区保留的字节数低于 per_partition_bytes,系统就会保留消息。

TopicPartitions

对 GetTopicPartitions 的响应。

字段
partition_count

int64

主题中的分区数量。

UpdateSubscriptionRequest

对 UpdateSubscription 的请求。

字段
subscription

Subscription

必需。要更新的订阅。必须填充其 name 字段。 主题字段不得为必填字段。

update_mask

FieldMask

必需。指定要更改的订阅字段的掩码。

UpdateTopicRequest

对 UpdateTopic 的请求。

字段
topic

Topic

必需。要更新的主题。必须填充其 name 字段。

update_mask

FieldMask

必需。指定要更改的主题字段的掩码。