Pacote google.longrunning

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Índice

Operações

Operações de longa duração são gerenciadas com um serviço de API.

Quando um método da API leva muito tempo para ser concluído, ele pode ser configurado para retornar a Operation ao cliente, que poderá usar essa interface para receber a resposta real de maneira assíncrona. Para isso, o cliente poderá pesquisar o recurso de operação ou transmiti-lo para outra API, por exemplo, a API Google Cloud Pub/Sub. Qualquer serviço de API que retorna operações de longa duração precisa implementar a interface de Operations para que os desenvolvedores possam ter uma experiência de cliente consistente.

CancelOperation

rpc CancelOperation(CancelOperationRequest) retorna (Empty)

Inicia o cancelamento assíncrono de uma operação de longa duração. São feitas várias tentativas para cancelar a operação no servidor, mas o sucesso não é garantido. Se esse método não for compatível com o servidor, ele retornará google.rpc.Code.UNIMPLEMENTED. Os clientes podem usar Operations.GetOperation ou outros métodos para verificar se o cancelamento ocorreu ou se a operação foi concluída mesmo com o cancelamento. Caso o cancelamento seja bem-sucedido, a operação não será excluída. Em vez disso, ela se tornará uma operação com um valor Operation.error com um google.rpc.Status.code de 1, correspondente ao Code.CANCELLED.

Escopos da autorização

Requer o seguinte escopo OAuth:

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

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

DeleteOperation

rpc DeleteOperation(DeleteOperationRequest) retorna (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. Ele não cancela a operação. Se esse método não for compatível com o servidor, ele retornará google.rpc.Code.UNIMPLEMENTED.

Escopos da autorização

Requer o seguinte escopo OAuth:

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

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

GetOperation

rpc GetOperation(GetOperationRequest) retorna (Operation)

Recebe o estado mais recente de uma operação de longa duração. Os clientes usam este método para pesquisar o resultado da operação em intervalos, conforme recomendado pelo serviço da API.

Escopos da autorização

Requer o seguinte escopo OAuth:

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

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

ListOperations

rpc ListOperations(ListOperationsRequest) retorna (ListOperationsResponse)

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

Observação: a vinculação name a seguir permite que os serviços da API modifiquem essa vinculação para usar outros esquemas de nome de recurso, como users/*/operations. Para modificar a vinculação, os serviços da API podem adicionar uma vinculação como "/v1/{name=users/*}/operations" à configuração dos serviços deles. Para ser compatível com versões anteriores, o nome padrão inclui o código do conjunto de operações. No entanto, é recomendável que os usuários que fizeram a modificação garantam que a vinculação do nome seja o recurso pai, sem o código do conjunto de operações.

Escopos da autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a 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.

DeleteOperationRequest

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

Campos
name

string

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

GetOperationRequest

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

Campos
name

string

O nome do recurso de operação.

ListOperationsRequest

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

Campos
name

string

Nome do recurso pai da operação.

filter

string

Uma expressão para filtrar os resultados da solicitação.

  • operation_id - para = ou !=
  • done - para = ou !=
  • works_on - para = ou !=

Veja alguns exemplos de uso do filtro:

  • done=true -> a execução da operação foi concluída.
  • works_on = projects/my-project/locations/us-central1/datasets/5 -> a operação funciona em um conjunto de dados com código 5.
  • works_on = projects/my-project/locations/us-central1/models/15 -> a operação funciona com um modelo com código 15.

page_size

int32

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

page_token

string

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

ListOperationsResponse

A mensagem de resposta para Operations.ListOperations.

Campos
operations[]

Operation

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

next_page_token

string

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

Operação

Este recurso representa uma operação de longa duração resultante de uma chamada à API de rede.

Campos
name

string

O nome atribuído pelo servidor, que é exclusivo somente no mesmo serviço que o retorna originalmente. Quando você usa o mapeamento HTTP padrão, o name tem o formato operations/some/unique/name.

metadata

Any

Metadados específicos do serviço associados à operação. Eles geralmente contêm informações sobre o progresso e metadados comuns como a hora da criação. Em alguns serviços, esses metadados talvez não sejam fornecidos. Em qualquer método que retorne uma operação de longa duração, o tipo de metadados será documentado, se houver.

done

bool

Se o valor é false, isso significa que a operação continua em andamento. Se for true, a operação já foi concluída, e error ou response estão disponíveis.

Campo de união result. O resultado da operação, que pode ser um error ou uma response válida. Se done == false, nem error nem response é definido. Se done == true, exatamente um error ou response é definido. O result será somente um destes:
error

Status

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

response

Any

A resposta normal da operação, em caso de êxito. Se o método original não retornar dados em caso de sucesso, como Delete, a resposta será google.protobuf.Empty. Quando esse método é um Get/Create/Update padrão, a resposta é o recurso. Em outros métodos, ela é do tipo XxxResponse, onde Xxx é o nome do método original. Por exemplo, se o nome do método é TakeSnapshot(), o tipo de resposta deduzido é TakeSnapshotResponse.