REST Resource: transferOperations

Recurso: TransferOperation

Uma descrição da execução de uma transferência.

Representação JSON 
{
  "name": string,
  "projectId": string,
  "transferSpec": {
    object (TransferSpec)
  },
  "notificationConfig": {
    object (NotificationConfig)
  },
  "loggingConfig": {
    object (LoggingConfig)
  },
  "startTime": string,
  "endTime": string,
  "status": enum (Status),
  "counters": {
    object (TransferCounters)
  },
  "errorBreakdowns": [
    {
      object (ErrorSummary)
    }
  ],
  "transferJobName": string
}
Campos
name

string

Um ID globalmente exclusivo atribuído pelo sistema.
projectId

string

O ID do projeto do Google Cloud proprietário da operação.
transferSpec

object (TransferSpec)

Especificação de transferência.
notificationConfig

object (NotificationConfig)

Configuração de notificação.
loggingConfig

object (LoggingConfig)

Configuração do Cloud Logging.
startTime

string (Timestamp format)

Horário de início desta execução de transferência.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Horário de término desta execução de transferência.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
status

enum (Status)

Status da operação de transferência.
counters

object (TransferCounters)

Informações sobre o progresso da operação de transferência.
errorBreakdowns[]

object (ErrorSummary)

Resume os erros encontrados com exemplos de entradas de registro de erros.
transferJobName

string

O nome do job de transferência que aciona essa operação.

Status

O status de uma TransferOperation.

Enums
STATUS_UNSPECIFIED Zero é um valor ilegal.
IN_PROGRESS Em andamento.
PAUSED Pausado.
SUCCESS Concluído.
FAILED Encerrado devido a uma falha irrecuperável.
ABORTED Cancelado pelo usuário.
QUEUED Temporariamente atrasado pelo sistema. Nenhuma ação do usuário é necessária.
SUSPENDING A operação está suspendendo e esgotando o trabalho em andamento até a conclusão.

TransferCounters

Uma coleção de contadores que informam o progresso de uma operação de transferência.

Representação JSON 
{
  "objectsFoundFromSource": string,
  "bytesFoundFromSource": string,
  "objectsFoundOnlyFromSink": string,
  "bytesFoundOnlyFromSink": string,
  "objectsFromSourceSkippedBySync": string,
  "bytesFromSourceSkippedBySync": string,
  "objectsCopiedToSink": string,
  "bytesCopiedToSink": string,
  "objectsDeletedFromSource": string,
  "bytesDeletedFromSource": string,
  "objectsDeletedFromSink": string,
  "bytesDeletedFromSink": string,
  "objectsFromSourceFailed": string,
  "bytesFromSourceFailed": string,
  "objectsFailedToDeleteFromSink": string,
  "bytesFailedToDeleteFromSink": string,
  "directoriesFoundFromSource": string,
  "directoriesFailedToListFromSource": string,
  "directoriesSuccessfullyListedFromSource": string,
  "intermediateObjectsCleanedUp": string,
  "intermediateObjectsFailedCleanedUp": string
}
Campos
objectsFoundFromSource

string (int64 format)

Objetos encontrados na fonte de dados que estão programados para transferência, exceto aqueles que estão sendo filtrados com base nas condições do objeto ou ignorados devido à sincronização.
bytesFoundFromSource

string (int64 format)

Bytes encontrados na fonte de dados que estão programados para transferência, exceto aqueles que estão sendo filtrados com base nas condições do objeto ou ignorados devido à sincronização.
objectsFoundOnlyFromSink

string (int64 format)

Objetos encontrados apenas no destino de dados que estão programados para serem excluídos.
bytesFoundOnlyFromSink

string (int64 format)

Bytes encontrados apenas no destino de dados que estão programados para serem excluídos.
objectsFromSourceSkippedBySync

string (int64 format)

Objetos na origem de dados que não são transferidos porque já existem no coletor de dados.
bytesFromSourceSkippedBySync

string (int64 format)

Bytes na origem de dados que não são transferidos porque já existem no coletor de dados.
objectsCopiedToSink

string (int64 format)

Objetos que são copiados para o coletor de dados.
bytesCopiedToSink

string (int64 format)

Bytes que são copiados para o destino de dados.
objectsDeletedFromSource

string (int64 format)

Objetos excluídos da fonte de dados.
bytesDeletedFromSource

string (int64 format)

Bytes excluídos da fonte de dados.
objectsDeletedFromSink

string (int64 format)

Objetos excluídos do repositório de dados.
bytesDeletedFromSink

string (int64 format)

Bytes excluídos do destino de dados.
objectsFromSourceFailed

string (int64 format)

Objetos na fonte de dados que não foram transferidos ou excluídos após a transferência.
bytesFromSourceFailed

string (int64 format)

Bytes na fonte de dados que não foram transferidos ou excluídos após a transferência.
objectsFailedToDeleteFromSink

string (int64 format)

Objetos que não foram excluídos do repositório de dados.
bytesFailedToDeleteFromSink

string (int64 format)

Bytes que não foram excluídos do destino de dados.
directoriesFoundFromSource

string (int64 format)

Somente para transferências que envolvem o PosixFilesystem.

Número de diretórios encontrados durante a listagem. Por exemplo, se o diretório raiz da transferência for base/ e houver outros dois diretórios, a/ e b/, a contagem após listar base/, base/a/ e base/b/ será 3.
directoriesFailedToListFromSource

string (int64 format)

Somente para transferências que envolvem o PosixFilesystem.

Número de falhas de listagem para cada diretório encontrado na origem. Possíveis falhas ao listar um diretório incluem falha de permissão ou de bloqueio. Se a listagem de um diretório falhar, nenhum arquivo no diretório será transferido.
directoriesSuccessfullyListedFromSource

string (int64 format)

Somente para transferências que envolvem o PosixFilesystem.

Número de listagens bem-sucedidas para cada diretório encontrado na origem.
intermediateObjectsCleanedUp

string (int64 format)

Número de objetos intermediários limpos com sucesso.
intermediateObjectsFailedCleanedUp

string (int64 format)

Número de objetos intermediários que não foram limpos.

ErrorSummary

Um resumo dos erros por código, além de uma contagem e exemplos de entradas de registro de erros.

Representação JSON 
{
  "errorCode": enum (Code),
  "errorCount": string,
  "errorLogEntries": [
    {
      object (ErrorLogEntry)
    }
  ]
}
Campos
errorCode

enum (Code)

Obrigatório.
errorCount

string (int64 format)

Obrigatório. Contagem desse tipo de erro.
errorLogEntries[]

object (ErrorLogEntry)

Exemplos de erros.

No máximo cinco entradas de registro de erro são registradas para um determinado código de erro em uma única operação de transferência.

Código

Códigos de erros canônicos para APIs do Google.

Enums
OK

Não é um erro. Retornado quando bem-sucedido.

Mapeamento HTTP: 200 OK
CANCELLED

A operação foi cancelada, geralmente pelo chamador

Mapeamento HTTP: 499 Solicitação fechada pelo cliente
UNKNOWN

Erro desconhecido. Por exemplo, esse erro pode ser retornado quando um valor Status recebido de outro espaço de endereço pertence a um espaço de erro desconhecido nesse espaço de endereço. Além disso, os erros gerados por APIs que não retornam informações de erro suficientes podem ser convertidos neste erro.

Mapeamento HTTP: 500 Erro interno do servidor
INVALID_ARGUMENT

O cliente especificou um argumento inválido. Observe que isso é diferente de FAILED_PRECONDITION. INVALID_ARGUMENT indica argumentos problemáticos, independentemente do estado do sistema. Por exemplo, um nome de arquivo incorreto.

Mapeamento HTTP: 400 Solicitação inválida
DEADLINE_EXCEEDED

O prazo expirou antes do término da operação. Para operações que alteram o estado do sistema, este erro pode ser retornado mesmo que a operação tenha sido concluída com sucesso. Por exemplo, uma resposta bem-sucedida de um servidor pode ter atrasado tempo suficiente para que o prazo expirasse.

Mapeamento HTTP: 504 Tempo limite do gateway
NOT_FOUND

Alguma entidade solicitada não foi encontrada. Por exemplo, arquivo ou diretório.

Observação para desenvolvedores de servidor: se uma solicitação for negada para uma classe inteira de usuários, como a implementação gradual de recursos ou a lista de permissões não documentada de permissões, NOT_FOUND poderá ser usado. Se uma solicitação for negada para alguns usuários de uma classe, como o controle de acesso baseado em usuário, PERMISSION_DENIED precisará ser usado.

Mapeamento HTTP: 404 Não encontrado
ALREADY_EXISTS

A entidade que um cliente tentou criar já existe. Por exemplo, arquivo ou diretório.

Mapeamento HTTP: 409 Conflito
PERMISSION_DENIED

O autor da chamada não tem permissão para executar a operação especificada. PERMISSION_DENIED não pode ser usado para rejeições causadas pelo esgotamento de algum recurso. Em vez dele, use RESOURCE_EXHAUSTED para esses erros. PERMISSION_DENIED não poderá ser usado se o autor da chamada não for identificado. Em vez dele, use UNAUTHENTICATED para esses erros. Esse código do erro não indica que a solicitação seja válida nem que a entidade solicitada exista ou satisfaça outras condições prévias.

Mapeamento HTTP: 403 Proibido
UNAUTHENTICATED

A solicitação não tem credenciais válidas de autenticação para a operação.

Mapeamento HTTP: 401 Não autorizado
RESOURCE_EXHAUSTED

Houve o esgotamento de algum recurso, como uma cota por usuário. Também é possível que todo sistema de arquivos esteja sem espaço.

Mapeamento HTTP: 429 Há muitas solicitações
FAILED_PRECONDITION

A operação foi rejeitada porque o estado do sistema não é o necessário para a execução dela. Por exemplo, o diretório a ser excluído não está vazio, uma operação "rmdir" foi aplicada a um elemento que não é um diretório etc.

Os implementadores de serviços podem usar as diretrizes a seguir para decidir entre FAILED_PRECONDITION, ABORTED e UNAVAILABLE: (a) usar UNAVAILABLE se o cliente puder repetir apenas a chamada com falha. (b) Use ABORTED se o cliente precisar tentar novamente em um nível mais alto. Por exemplo, quando um teste e um conjunto especificado pelo cliente falha, indicando que o cliente precisa reiniciar uma sequência de leitura-modificação-gravação. (c) Use FAILED_PRECONDITION se o cliente não tentar novamente até que o estado do sistema seja explicitamente corrigido. Por exemplo, se houver falha em um "rmdir" porque o diretório não está vazio, FAILED_PRECONDITION será retornado, porque o cliente não precisa tentar novamente, a menos que os arquivos sejam excluídos do diretório.

Mapeamento HTTP: 400 Solicitação inválida
ABORTED

A operação foi cancelada. Isso ocorre normalmente devido a um problema de simultaneidade, como falha na verificação do sequenciador ou cancelamento da transação.

Consulte as diretrizes acima para decidir entre FAILED_PRECONDITION, ABORTED e UNAVAILABLE.

Mapeamento HTTP: 409 Conflito
OUT_OF_RANGE

Houve uma tentativa da operação depois do intervalo válido. Por exemplo, busca ou leitura após o fim do arquivo.

Diferentemente de INVALID_ARGUMENT, este erro indica um problema que poderá ser corrigido se o estado do sistema mudar. Por exemplo, um sistema de arquivos de 32 bits gerará INVALID_ARGUMENT se for solicitado a ler em um deslocamento fora do intervalo [0,2^32-1], mas gerará OUT_OF_RANGE se for solicitado a ler um deslocamento que ultrapasse o tamanho do arquivo atual.

Há alguma sobreposição entre FAILED_PRECONDITION e OUT_OF_RANGE. Recomendamos usar OUT_OF_RANGE (o erro mais específico) quando aplicável para que os autores da chamada que estão iterando por meio de um espaço possam procurar facilmente um erro OUT_OF_RANGE a fim de detectar quando tiverem concluído.

Mapeamento HTTP: 400 Solicitação inválida
UNIMPLEMENTED

A operação não foi implementada ou não é compatível nem está ativada neste serviço.

Mapeamento HTTP: 501 Não implementado
INTERNAL

Erros internos. Significa que algumas invariantes esperadas pelo sistema subjacente foram corrompidas. Este código do erro é reservado para erros graves.

Mapeamento HTTP: 500 Erro interno do servidor
UNAVAILABLE

Atualmente, o serviço não está disponível. Muito provavelmente, trata-se de uma condição temporária, que pode ser corrigida ao tentar novamente com uma retirada. Nem sempre é seguro repetir operações não idempotentes.

Consulte as diretrizes acima para decidir entre FAILED_PRECONDITION, ABORTED e UNAVAILABLE.

Mapeamento HTTP: 503 Serviço indisponível
DATA_LOSS

Perda ou corrupção irrecuperável de dados.

Mapeamento HTTP: 500 Erro interno do servidor

ErrorLogEntry

Uma entrada que descreve um erro que ocorreu.

Representação JSON 
{
  "url": string,
  "errorDetails": [
    string
  ]
}
Campos
url

string

Obrigatório. Um URL que se refere ao destino (uma fonte de dados, um destino de dados ou um objeto) com que o erro está associado.
errorDetails[]

string

Uma lista de mensagens com os detalhes do erro.

Métodos

cancel

 Cancela uma transferência.

get

 Recebe o estado mais recente de uma operação de longa duração.

list

 Lista operações de transferência.

pause

 Pausa uma operação de transferência.

resume

 Retomar uma operação de transferência pausada.