v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13245084.2 KB
projects

Updates a Workload in an Application.

patch/v1/{+name}

Path parameters

namestring required

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

Query parameters

requestIdstring

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).

updateMaskstring

Optional. Field mask is used to specify the fields to be overwritten in the Workload resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. 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.

Request body

namestring

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

createTimestring google-datetime

Output only. Create time.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'DETACHED'

Output only. Workload state.

discoveredWorkloadstring

Required. Immutable. The resource name of the original discovered workload.

uidstring

Output only. A universally unique identifier (UUID) for the Workload in the UUID4 format.

displayNamestring

Optional. User-defined name for the Workload. Can have a maximum length of 63 characters.

updateTimestring google-datetime

Output only. Update time.

descriptionstring

Optional. User-defined description of a Workload. Can have a maximum length of 2048 characters.

Response

Successful response