Method: transferJobs.patch

Actualiza un trabajo de transferencia. La actualización de las especificaciones de transferencia de un trabajo no afecta las operaciones de transferencia que ya se están ejecutando.

Nota: El campo status del trabajo se puede modificar con esta RPC (por ejemplo, para establecer el estado de un trabajo en DELETED, DISABLED o ENABLED).

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
jobName

string

Obligatorio. Es el nombre del trabajo que se actualizará.

La autorización requiere el siguiente permiso IAM en el recurso especificado jobName:

  • storagetransfer.jobs.update

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "projectId": string,
  "transferJob": {
    object (TransferJob)
  },
  "updateTransferJobFieldMask": string
}
Campos
projectId

string

Obligatorio. El ID del proyecto de Google Cloud al que pertenece la tarea
transferJob

object (TransferJob)

Obligatorio. El trabajo que se actualizará. Se espera que transferJob especifique uno o más de cinco campos: description, transferSpec, notificationConfig, loggingConfig y status. Un UpdateTransferJobRequest que especifique otros campos se rechaza con el error INVALID_ARGUMENT. La actualización del estado de un trabajo a DELETED requiere el permiso storagetransfer.jobs.delete.
updateTransferJobFieldMask

string (FieldMask format)

Es la máscara de campo de los campos en transferJob que se actualizarán en esta solicitud. Los campos de transferJob que se pueden actualizar son description, transferSpec, notificationConfig, loggingConfig y status. Para actualizar el transferSpec del trabajo, se debe proporcionar una especificación de transferencia completa. Una especificación incompleta que no tenga campos obligatorios se rechaza con el error INVALID_ARGUMENT.

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de TransferJob.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Authentication Overview.