Method: transferJobs.patch

Atualiza um job de transferência. Atualizar a especificação de transferência de um job não afeta as operações de transferência que já estão em execução.

Observação:o campo status do job pode ser modificado usando esse RPC, por exemplo, para definir o status de um job como DELETED, DISABLED ou ENABLED.

Solicitação HTTP

PATCH https://storagetransfer.googleapis.com/v1/{jobName=transferJobs/**}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
jobName

string

Obrigatório. O nome do job a ser atualizado.

A autorização requer a seguinte permissão do IAM no recurso especificado jobName:

  • storagetransfer.jobs.update

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "projectId": string,
  "transferJob": {
    object (TransferJob)
  },
  "updateTransferJobFieldMask": string
}
Campos
projectId

string

Obrigatório. O ID do projeto do Google Cloud proprietário do job.
transferJob

object (TransferJob)

Obrigatório. O job a ser atualizado. O transferJob precisa especificar um ou mais dos cinco campos: description, transferSpec, notificationConfig, loggingConfig e status. Um UpdateTransferJobRequest que especifica outros campos é rejeitado com o erro INVALID_ARGUMENT. Para atualizar o status de um job para DELETED, é necessária a permissão storagetransfer.jobs.delete.
updateTransferJobFieldMask

string (FieldMask format)

A máscara de campo dos campos em transferJob que serão atualizados nesta solicitação. Os campos em transferJob que podem ser atualizados são: description, transferSpec, notificationConfig, loggingConfig e status. Para atualizar o transferSpec do job, é necessário fornecer uma especificação de transferência completa. Uma especificação incompleta com campos obrigatórios em branco é rejeitada com o erro INVALID_ARGUMENT.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de TransferJob.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.