Identifier. The resource name of the Workload. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/workloads/{workload-id}"
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-04-23 UTC."],[[["\u003cp\u003eThis API endpoint updates a specified Workload within an Application using a PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eThe Workload to be updated is identified by its resource name in the URL's path parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eupdateMask\u003c/code\u003e query parameter is required to specify which fields of the Workload should be updated.\u003c/p\u003e\n"],["\u003cp\u003eA request ID can be included as a query parameter (\u003ccode\u003erequestId\u003c/code\u003e) to prevent accidental duplicate updates upon retries.\u003c/p\u003e\n"],["\u003cp\u003eUpdating a Workload requires \u003ccode\u003eapphub.workloads.update\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.applications.workloads.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nUpdates a Workload in an Application.\n\n### HTTP request\n\n`PATCH https://apphub.googleapis.com/v1alpha/{workload.name=projects/*/locations/*/applications/*/workloads/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Workload](/app-hub/docs/reference/rest/v1alpha/projects.locations.applications.workloads#Workload).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/app-hub/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `apphub.workloads.update`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
