UpdateTaskLog

  • This documentation details the UpdateTask request and response within the Deliveries API.

  • It includes the JSON representation for the overall request/response structure and the nested UpdateTaskRequestLog.

  • Key fields for the request include a header, the update request itself, the response, and any potential errors.

  • The UpdateTaskRequestLog specifically focuses on the task ID, the task details, and a field mask for selective updates.

Details on the UpdateTask request and response.

JSON representation 
{
  "header": {
    object (DeliveryRequestHeaderLog)
  },
  "request": {
    object (UpdateTaskRequestLog)
  },
  "response": {
    object (TaskLog)
  },
  "errorResponse": {
    object (ErrorResponseLog)
  }
}
Fields
header

object (DeliveryRequestHeaderLog)

Request header.
request

object (UpdateTaskRequestLog)

The request sent to the Deliveries API.
response

object (TaskLog)

The response returned to the client. It will be unset if the RPC call resulted in an error.
errorResponse

object (ErrorResponseLog)

The error response returned to the client. It will be unset if the RPC call succeeded.

UpdateTaskRequestLog

Details on the UpdateTask request

JSON representation 
{
  "taskId": string,
  "task": {
    object (TaskLog)
  },
  "updateMask": string
}
Fields
taskId

string

The ID of the task to update.
task

object (TaskLog)

The task specified in the update request.
updateMask

string (FieldMask format)

The field mask indicating which request fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".