Package google.longrunning

Índice

Operações

Gerencia operações de longa duração com um serviço de API.

Quando um método API normalmente leva muito tempo para ser concluído, ele pode ser projetado para retornar Operation ao cliente, e o cliente pode usar essa interface para receber a resposta real de forma assíncrona, pesquisando o recurso de operação ou passando o recurso de operação para outra API ( como a API Pub/Sub) para receber a resposta. Qualquer serviço de API que retorne operações de longa duração deve implementar a interface Operations para que os desenvolvedores possam ter uma experiência de cliente consistente.

Cancelar operação

rpc CancelOperation( CancelOperationRequest ) returns ( Empty )

Inicia o cancelamento assíncrono em uma operação de longa duração. O servidor faz o possível para cancelar a operação, mas o sucesso não é garantido. Se o servidor não suportar este método, ele retornará google.rpc.Code.UNIMPLEMENTED . Os clientes podem usar Operations.GetOperation ou outros métodos para verificar se o cancelamento foi bem-sucedido ou se a operação foi concluída apesar do cancelamento. Após o cancelamento bem-sucedido, a operação não é excluída; em vez disso, torna-se uma operação com um valor Operation.error com um google.rpc.Status.code de 1, correspondente a Code.CANCELLED .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ExcluirOperação

rpc DeleteOperation( DeleteOperationRequest ) returns ( Empty )

Exclui uma operação de longa duração. Este método indica que o cliente não está mais interessado no resultado da operação. Não cancela a operação. Se o servidor não suportar este método, ele retornará google.rpc.Code.UNIMPLEMENTED .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ObterOperação

rpc GetOperation( GetOperationRequest ) returns ( Operation )

Obtém o estado mais recente de uma operação de longa duração. Os clientes podem usar esse método para pesquisar o resultado da operação em intervalos recomendados pelo serviço de API.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

ListarOperações

rpc ListOperations( ListOperationsRequest ) returns ( ListOperationsResponse )

Lista as operações que correspondem ao filtro especificado na solicitação. Se o servidor não suportar este método, ele retornará UNIMPLEMENTED .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

WaitOperation

rpc WaitOperation( WaitOperationRequest ) returns ( Operation )

Aguarda até que a operação de longa duração especificada seja concluída ou atinja no máximo um tempo limite especificado, retornando o estado mais recente. Se a operação já tiver sido realizada, o estado mais recente será retornado imediatamente. Se o tempo limite especificado for maior que o tempo limite HTTP/RPC padrão, o tempo limite HTTP/RPC será usado. Se o servidor não suportar este método, ele retornará google.rpc.Code.UNIMPLEMENTED . Observe que este método é baseado no melhor esforço. Ele pode retornar o estado mais recente antes do tempo limite especificado (inclusive imediatamente), o que significa que mesmo uma resposta imediata não é garantia de que a operação seja concluída.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .

CancelOperationRequest

A mensagem de solicitação para Operations.CancelOperation .

Campos
name

string

O nome do recurso de operação a ser cancelado.

ExcluirOperationRequest

A mensagem de solicitação para Operations.DeleteOperation .

Campos
name

string

O nome do recurso de operação a ser excluído.

ObterOperaçãoRequest

A mensagem de solicitação para Operations.GetOperation .

Campos
name

string

O nome do recurso de operação.

ListaOperationsRequest

A mensagem de solicitação para Operations.ListOperations .

Campos
name

string

O nome do recurso pai da operação.

filter

string

O filtro de lista padrão.

page_size

int32

O tamanho padrão da página da lista.

page_token

string

O token de página de lista padrão.

ListaOperaçõesResposta

A mensagem de resposta para Operations.ListOperations .

Campos
operations[]

Operation

Uma lista de operações que corresponde ao filtro especificado na solicitação.

next_page_token

string

O token padrão da próxima página da lista.

Operação

Este recurso representa uma operação de longa duração que é o resultado de uma chamada de API de rede.

Campos
name

string

O nome atribuído pelo servidor, que é exclusivo apenas no mesmo serviço que o retorna originalmente. Se você usar o mapeamento HTTP padrão, o name deverá ser um nome de recurso que termine com operations/{unique_id} .

metadata

Any

Metadados específicos do serviço associados à operação. Normalmente contém informações de progresso e metadados comuns, como tempo de criação. Alguns serviços podem não fornecer esses metadados. Qualquer método que retorne uma operação de longa duração deve documentar o tipo de metadados, se houver.

done

bool

Se o valor for false , significa que a operação ainda está em andamento. Se true , a operação será concluída e error ou response estarão disponíveis.

result do campo de união. O resultado da operação, que pode ser um error ou uma response válida. Se done == false , nem error nem response serão definidos. Se done == true , exatamente um error ou response pode ser definido. Alguns serviços podem não fornecer o resultado. result pode ser apenas um dos seguintes:
error

Status

O resultado do erro da operação em caso de falha ou cancelamento.

response

Any

A resposta normal e bem-sucedida da operação. Se o método original não retornar dados de sucesso, como Delete , a resposta será google.protobuf.Empty . Se o método original for padrão Get / Create / Update , a resposta deverá ser o recurso. Para outros métodos, a resposta deve ter o tipo XxxResponse , onde Xxx é o nome original do método. Por exemplo, se o nome do método original for TakeSnapshot() , o tipo de resposta inferido será TakeSnapshotResponse .

WaitOperationRequest

A mensagem de solicitação para Operations.WaitOperation .

Campos
name

string

O nome do recurso de operação a ser aguardado.

timeout

Duration

A duração máxima de espera antes do tempo limite. Se deixado em branco, a espera será no máximo o tempo permitido pelo protocolo HTTP/RPC subjacente. Se o prazo do contexto RPC também for especificado, o mais curto será usado.