Method: projects.locations.applications.workloads.patch

Updates a Workload in an Application.

HTTP request

PATCH https://apphub.googleapis.com/v1alpha/{workload.name=projects/*/locations/*/applications/*/workloads/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
workload.name

string

Identifier. The resource name of the Workload. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. The API changes the values of the fields as specified in the updateMask. The API ignores the values of all fields not covered by the updateMask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.

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

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request body contains an instance of Workload.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • apphub.workloads.update

For more information, see the IAM documentation.