Pacote google.cloud.pubsublite.v1

Index

AdminService

O serviço que um aplicativo cliente usa para gerenciar tópicos e assinaturas, como criar, listar e excluir tópicos e assinaturas.

CreateSubscription

rpc CreateSubscription(CreateSubscriptionRequest) returns (Subscription)

Cria uma nova assinatura.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

CreateTopic

rpc CreateTopic(CreateTopicRequest) returns (Topic)

Cria um novo tópico.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

DeleteSubscription

rpc DeleteSubscription(DeleteSubscriptionRequest) returns (Empty)

Exclui a assinatura especificada.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

DeleteTopic

rpc DeleteTopic(DeleteTopicRequest) returns (Empty)

Exclui o tópico especificado.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

GetSubscription

rpc GetSubscription(GetSubscriptionRequest) returns (Subscription)

Retorna a configuração da assinatura.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

GetTopic

rpc GetTopic(GetTopicRequest) returns (Topic)

Retorna a configuração do tópico.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

GetTopicPartitions

rpc GetTopicPartitions(GetTopicPartitionsRequest) returns (TopicPartitions)

Retorna as informações da partição do tópico solicitado.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

ListSubscriptions

rpc ListSubscriptions(ListSubscriptionsRequest) returns (ListSubscriptionsResponse)

Retorna a lista de assinaturas do projeto fornecido.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

ListTopicSubscriptions

rpc ListTopicSubscriptions(ListTopicSubscriptionsRequest) returns (ListTopicSubscriptionsResponse)

Lista as assinaturas anexadas ao tópico especificado.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

ListTopics

rpc ListTopics(ListTopicsRequest) returns (ListTopicsResponse)

Retorna a lista de tópicos para o projeto fornecido.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

UpdateSubscription

rpc UpdateSubscription(UpdateSubscriptionRequest) returns (Subscription)

Atualiza as propriedades da assinatura especificada.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

UpdateTopic

rpc UpdateTopic(UpdateTopicRequest) returns (Topic)

Atualiza as propriedades do tópico especificado.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

CursorService

O serviço que um aplicativo cliente de assinante usa para gerenciar cursores confirmados enquanto recebe mensagens. Um cursor representa o progresso de um assinante em uma partição de tópico para uma determinada assinatura.

CommitCursor

rpc CommitCursor(CommitCursorRequest) returns (CommitCursorResponse)

Atualiza o cursor confirmado.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

ListPartitionCursors

rpc ListPartitionCursors(ListPartitionCursorsRequest) returns (ListPartitionCursorsResponse)

Retorna todas as informações do cursor confirmado para uma assinatura.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

StreamingCommitCursor

rpc StreamingCommitCursor(StreamingCommitCursorRequest) returns (StreamingCommitCursorResponse)

Estabelece um stream com o servidor para gerenciar cursores confirmados.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

PublisherService

O serviço que um aplicativo cliente do editor usa para publicar mensagens em tópicos. As mensagens publicadas são retidas pelo serviço durante o período de retenção configurado para o respectivo tópico e entregues aos clientes assinantes mediante solicitação (por meio do SubscriberService).

Publicar

rpc Publish(PublishRequest) returns (PublishResponse)

Estabelece um stream com o servidor para publicar mensagens. Depois que o stream é inicializado, o cliente publica mensagens enviando solicitações de publicação no stream. O servidor responde com um PublishResponse para cada PublishRequest enviado pelo cliente, na mesma ordem em que as solicitações foram enviadas. Vários PublishRequests podem estar em andamento simultaneamente, mas serão processados pelo servidor na ordem em que forem enviados pelo cliente em um determinado stream.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

SubscriberService

O serviço que um aplicativo cliente de assinante usa para receber mensagens de assinaturas.

Assine

rpc Subscribe(SubscribeRequest) returns (SubscribeResponse)

Estabelece um stream com o servidor para receber mensagens.

Escopos de autorização

Requer o seguinte escopo do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

AttributeValues

Os valores associados a uma chave de um atributo.

Campos
values[]

bytes

A lista de valores associados a uma chave.

CommitCursorRequest

Solicitação de CommitCursor.

Campos
subscription

string

A assinatura para a qual atualizar o cursor.

partition

int64

A partição para a qual atualizar o cursor. As partições não são indexadas. Portanto, partition precisa estar no intervalo [0, topic.num_partitions).

cursor

Cursor

O novo valor do cursor confirmado.

CommitCursorResponse

Resposta para CommitCursor.

CreateSubscriptionRequest

Solicitação para CreateSubscription.

Campos
parent

string

Obrigatório. O local pai no qual a assinatura será criada. Estruturado como projects/{project_number}/locations/{location}.

subscription

Subscription

Obrigatório. Configuração da assinatura a ser criada. O campo name é ignorado.

subscription_id

string

Obrigatório. O código a ser usado para a assinatura, que se tornará o componente final do nome da assinatura.

Esse valor é estruturado como: my-sub-name.

CreateTopicRequest

Solicitação para CreateTopic.

Campos
parent

string

Obrigatório. O local pai no qual o tópico será criado. Estruturado como projects/{project_number}/locations/{location}.

topic

Topic

Obrigatório. Configuração do tópico a ser criado. O campo name é ignorado.

topic_id

string

Obrigatório. O código a ser usado para o tópico, que se tornará o componente final do nome do tópico.

Esse valor é estruturado como: my-topic-name.

Cursor

Um cursor que descreve a posição de uma mensagem dentro de uma partição de tópico.

Campos
offset

int64

O deslocamento de uma mensagem em uma partição de tópico. Precisa ser maior ou igual a 0.

DeleteSubscriptionRequest

Solicitação para DeleteSubscription.

Campos
name

string

Obrigatório. O nome da assinatura a ser excluída.

DeleteTopicRequest

Solicitação para DeleteTopic.

Campos
name

string

Obrigatório. O nome do tópico a ser excluído.

FlowControlRequest

Solicitar a concessão de tokens ao servidor, solicitando a entrega de mensagens quando elas estiverem disponíveis.

Campos
allowed_messages

int64

O número de tokens de mensagem a serem concedidos. Deve ser maior ou igual a 0.

allowed_bytes

int64

O número de tokens de byte a serem concedidos. Deve ser maior ou igual a 0.

GetSubscriptionRequest

Solicitação para GetSubscription.

Campos
name

string

Obrigatório. O nome da assinatura cuja configuração será retornada.

GetTopicPartitionsRequest

Solicitação para GetTopicPartitions.

Campos
name

string

Obrigatório. O tópico cujas informações de partição devem ser retornadas.

GetTopicRequest

Solicitação para GetTopic.

Campos
name

string

Obrigatório. O nome do tópico cuja configuração será retornada.

InitialCommitCursorRequest

A primeira solicitação de streaming que precisa ser enviada em um stream recém-aberto. O cliente precisa aguardar a resposta antes de enviar solicitações subsequentes no stream.

Campos
subscription

string

A assinatura para a qual cursores confirmados.

partition

int64

A partição para a qual cursores confirmados. As partições não são indexadas. Portanto, partition precisa estar no intervalo [0, topic.num_partitions).

InitialCommitCursorResponse

Resposta a uma InitialCommitCursorRequest.

InitialPublishRequest

A primeira solicitação que precisa ser enviada em um stream recém-aberto.

Campos
topic

string

O tópico no qual as mensagens serão gravadas.

partition

int64

A partição no tópico em que as mensagens serão gravadas. As partições não são indexadas. Portanto, partition precisa estar no intervalo [0, topic.num_partitions).

InitialPublishResponse

Resposta a uma InitialPublishRequest.

InitialSubscribeRequest

A primeira solicitação que precisa ser enviada em um stream recém-aberto. O cliente precisa aguardar a resposta antes de enviar solicitações subsequentes no stream.

Campos
subscription

string

A assinatura da qual receber mensagens.

partition

int64

A partição da qual receber mensagens. As partições não são indexadas. Portanto, partition precisa estar no intervalo [0, topic.num_partitions).

InitialSubscribeResponse

Resposta a uma InitialSubscribeRequest.

Campos
cursor

Cursor

O cursor do qual o assinante começará a receber mensagens assim que os tokens de controle de fluxo forem disponibilizados.

ListPartitionCursorsRequest

Solicitação para ListPartitionCursors.

Campos
parent

string

Obrigatório. A assinatura para a qual os cursores serão recuperados. Estruturado como projects/{project_number}/locations/{location}/subscriptions/{subscription_id}.

page_size

int32

O número máximo de cursores a serem retornados. O serviço pode retornar menos que esse valor. Se não for definido ou for zero, todos os cursores do pai serão retornados.

page_token

string

Um token de página recebido de uma chamada ListPartitionCursors anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListPartitionCursors precisam corresponder à chamada que forneceu o token da página.

ListPartitionCursorsResponse

Resposta para ListPartitionCursors

Campos
partition_cursors[]

PartitionCursor

Os cursores de partição dessa solicitação.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListSubscriptionsRequest

Solicitação para ListSubscriptions.

Campos
parent

string

Obrigatório. O pai cujas inscrições serão listadas. Estruturado como projects/{project_number}/locations/{location}.

page_size

int32

O número máximo de assinaturas a serem retornadas. O serviço pode retornar menos que esse valor. Se não for definido ou for zero, todas as assinaturas do pai serão retornadas.

page_token

string

Um token de página recebido de uma chamada ListSubscriptions anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListSubscriptions precisam corresponder à chamada que forneceu o token da página.

ListSubscriptionsResponse

Resposta para ListSubscriptions.

Campos
subscriptions[]

Subscription

A lista de assinaturas no pai solicitado. A ordem das assinaturas não é especificada.

next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página de resultados. Se esse campo for omitido, não haverá mais resultados.

ListTopicSubscriptionsRequest

Solicitação para ListTopicSubscriptions.

Campos
name

string

Obrigatório. O nome do tópico cujas inscrições serão listadas.

page_size

int32

O número máximo de assinaturas a serem retornadas. O serviço pode retornar menos que esse valor. Se não definido ou zero, todas as assinaturas para o tópico especificado serão retornadas.

page_token

string

Um token de página recebido de uma chamada ListTopicSubscriptions anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListTopicSubscriptions precisam corresponder à chamada que forneceu o token da página.

ListTopicSubscriptionsResponse

Resposta para ListTopicSubscriptions.

Campos
subscriptions[]

string

Os nomes das assinaturas anexadas ao tópico. A ordem das assinaturas não é especificada.

next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página de resultados. Se esse campo for omitido, não haverá mais resultados.

ListTopicsRequest

Solicitação para ListTopics.

Campos
parent

string

Obrigatório. O pai cujos tópicos devem ser listados. Estruturado como projects/{project_number}/locations/{location}.

page_size

int32

O número máximo de tópicos a serem retornados. O serviço pode retornar menos que esse valor. Se não for definido ou for zero, todos os tópicos do pai serão retornados.

page_token

string

Um token de página recebido de uma chamada ListTopics anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListTopics precisam corresponder à chamada que forneceu o token da página.

ListTopicsResponse

Resposta para ListTopics.

Campos
topics[]

Topic

A lista de tópicos no pai solicitado. A ordem dos tópicos não é especificada.

next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página de resultados. Se esse campo for omitido, não haverá mais resultados.

MessagePublishRequest

Solicitação para publicar mensagens no tópico.

Campos
messages[]

PubSubMessage

MessagePublishResponse

Resposta a um MessagePublishRequest.

Campos
start_cursor

Cursor

O cursor da primeira mensagem publicada no lote. Os cursores das mensagens restantes no lote são sequenciais.

MessageResponse

Resposta contendo uma lista de mensagens. Ao entregar um MessageResponse para o cliente, o servidor: * atualiza o cursor de entrega do stream para um maior que o cursor da última mensagem na lista. * Subtrai o número total de bytes e mensagens dos tokens disponíveis para o servidor.

Campos
messages[]

SequencedMessage

Mensagens da partição de tópico.

PartitionCursor

Um par de um Cursor e a partição para a qual ele se destina.

Campos
partition

int64

A partição para a qual se destina.

cursor

Cursor

O valor do cursor.

PubsubMessage

Uma mensagem publicada por editores e entregue aos assinantes.

Campos
key

bytes

A chave usada para rotear mensagens para partições ou para compactação (por exemplo, mantenha as últimas N mensagens por chave). Se a chave estiver vazia, a mensagem será encaminhada para uma partição arbitrária.

data

bytes

O payload da mensagem.

attributes

map<string, AttributeValues>

Atributos opcionais que podem ser usados para metadados/cabeçalhos de mensagens.

event_time

Timestamp

Um horário de evento opcional especificado pelo usuário.

PublishRequest

Solicitação enviada do cliente para o servidor em um stream.

Campos

Campo de união request_type.

request_type pode ser apenas de um dos tipos a seguir:

initial_request

InitialPublishRequest

Solicitação inicial no stream.

message_publish_request

MessagePublishRequest

Solicitação para publicar mensagens.

PublishResponse

Resposta a um PublishRequest.

Campos

Campo de união response_type.

response_type pode ser apenas de um dos tipos a seguir:

initial_response

InitialPublishResponse

Resposta inicial no stream.

message_response

MessagePublishResponse

Resposta à publicação de mensagens.

SeekRequest

Solicitação para atualizar o cursor de entrega do stream com base no destino fornecido. Redefine os tokens disponíveis do servidor para 0. SeekRequests não podem ser enviadas enquanto outro SeekRequest está pendente (ou seja, não recebeu um SeekResponse) no mesmo stream. SeekRequests anteriores resultam em quebra de stream.

Campos
Campo de união target. O destino a ser procurado. Obrigatório. target pode ser apenas de um dos tipos a seguir:
named_target

NamedTarget

Um destino nomeado.

cursor

Cursor

Um destino correspondente ao cursor, apontando para qualquer parte da partição do tópico.

NamedTarget

Um destino especial na partição que não aceita outros parâmetros.

Enums
NAMED_TARGET_UNSPECIFIED Valor padrão. Esse valor não é usado.
HEAD Um destino correspondente à mensagem publicada mais recentemente na partição.
COMMITTED_CURSOR Um destino correspondente ao cursor confirmado para a assinatura e a partição de tópico especificadas.

SeekResponse

Resposta a um SeekRequest.

Campos
cursor

Cursor

O novo cursor de exibição do stream atual.

SequencedCommitCursorRequest

Solicitação de streaming para atualizar o cursor confirmado. Os sequenciados subsequentes substituem os pendentes.

Campos
cursor

Cursor

O novo valor do cursor confirmado.

SequencedCommitCursorResponse

Resposta a um SequencedCommitCursorRequest.

Campos
acknowledged_commits

int64

O número de SequencedCommitCursorRequests pendentes reconhecidos por essa resposta. Observe que SequencedCommitCursorRequests são confirmados na ordem em que são recebidos.

SequencedMessage

Campos
cursor

Cursor

A posição de uma mensagem na partição onde ela está armazenada.

publish_time

Timestamp

A hora em que a mensagem foi recebida pelo servidor quando foi publicada pela primeira vez.

message

PubSubMessage

A mensagem do usuário.

size_bytes

int64

O tamanho em bytes dessa mensagem para fins de controle de fluxo e cota.

StreamingCommitCursorRequest

Uma solicitação enviada do cliente para o servidor em um stream.

Campos

Campo de união request.

request pode ser apenas de um dos tipos a seguir:

initial

InitialCommitCursorRequest

Solicitação inicial no stream.

commit

SequencedCommitCursorRequest

Solicitação para confirmar um novo valor de cursor.

StreamingCommitCursorResponse

Resposta a um StreamingCommitCursorRequest.

Campos

Campo de união request.

request pode ser apenas de um dos tipos a seguir:

initial

InitialCommitCursorResponse

Resposta inicial no stream.

commit

SequencedCommitCursorResponse

Resposta para confirmar um novo valor de cursor.

SubscribeRequest

Uma solicitação enviada do cliente para o servidor em um stream.

Campos

Campo de união request.

request pode ser apenas de um dos tipos a seguir:

initial

InitialSubscribeRequest

Solicitação inicial no stream.

seek

SeekRequest

Solicitação para atualizar o cursor de entrega do stream.

flow_control

FlowControlRequest

Solicitação para conceder tokens ao servidor,

SubscribeResponse

Resposta para SubscribeRequest.

Campos

Campo de união response.

response pode ser apenas de um dos tipos a seguir:

initial

InitialSubscribeResponse

Resposta inicial no stream.

seek

SeekResponse

Resposta a uma operação de busca.

messages

MessageResponse

Resposta contendo mensagens da partição de tópico.

Inscrição

Metadados sobre um recurso de assinatura.

Campos
name

string

O nome da assinatura. Estruturado como: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

topic

string

O nome do tópico ao qual esta assinatura está anexada. Estruturado como: projects/{project_number}/locations/{location}/topic/{topic_id}

delivery_config

DeliveryConfig

As configurações da entrega de mensagens desta assinatura.

DeliveryConfig

As configurações de entrega de mensagens de uma assinatura.

Campos
delivery_requirement

DeliveryRequirement

O DeliveryRequirement para esta assinatura.

DeliveryRequirement

Quando essa assinatura deve enviar mensagens aos assinantes em relação à persistência de mensagens no armazenamento. Para detalhes, consulte Como criar assinaturas do Lite.

Enums
DELIVERY_REQUIREMENT_UNSPECIFIED Valor padrão. Esse valor não é usado.
DELIVER_IMMEDIATELY O servidor não aguarda a gravação de uma mensagem publicada no armazenamento para entregá-la aos assinantes.
DELIVER_AFTER_STORED O servidor não entregará uma mensagem publicada aos assinantes até que a mensagem seja gravada no armazenamento. Isso resultará em maior latência de ponta a ponta, mas uma exibição consistente.

Tema

Metadados sobre um recurso de tópico.

Campos
name

string

O nome do tópico. Estruturado como: projects/{project_number}/locations/{location}/topic/{topic_id}

partition_config

PartitionConfig

As configurações das partições deste tópico.

retention_config

RetentionConfig

As configurações da retenção de mensagens deste tópico.

PartitionConfig

As configurações das partições de um tópico.

Campos
count

int64

O número de partições no tópico. Precisa ser pelo menos 1.

scale

int32

Cada partição no tópico recebe uma capacidade equivalente a scale vezes a capacidade da partição padrão (4 MiB/s). Isso também se reflete no custo deste tópico. um tópico com scale de 2 e uma contagem de 10 é cobrado por 20 partições. Esse valor deve estar no intervalo [1,4].

RetentionConfig

As configurações de retenção de mensagens de um tópico.

Campos
per_partition_bytes

int64

O armazenamento provisionado, em bytes, por partição. Se o número de bytes armazenados em qualquer uma das partições do tópico crescer além desse valor, as mensagens mais antigas serão descartadas para liberar espaço para as mais recentes, independentemente do valor de period.

period

Duration

Por quanto tempo uma mensagem publicada é retida. Se não for definido, as mensagens serão mantidas, desde que os bytes retidos para cada partição estejam abaixo de per_partition_bytes.

TopicPartitions

Resposta para GetTopicPartitions.

Campos
partition_count

int64

O número de partições no tópico.

UpdateSubscriptionRequest

Soicitação para UpdateSubscription.

Campos
subscription

Subscription

Obrigatório. A assinatura a ser atualizada. O campo name precisa ser preenchido. O campo "Tópico" não deve ser preenchido.

update_mask

FieldMask

Obrigatório. Uma máscara que especifica os campos de assinatura a serem alterados.

UpdateTopicRequest

Solicitação para UpdateTopic.

Campos
topic

Topic

Obrigatório. O tópico a ser atualizado. O campo name precisa ser preenchido.

update_mask

FieldMask

Obrigatório. Uma máscara que especifica os campos do tópico a serem alterados.