Sign in

v1

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

Create a new unit operation.

post/v1/{+parent}/unitOperations

Path parameters

parentstring required

Required. The parent of the unit operation.

Query parameters

requestIdstring

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

unitOperationIdstring

Required. The ID value for the new unit operation.

validateOnlyboolean

If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.

Request body

namestring

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/unitOperations/{unitOperation}"

errorCategory'UNIT_OPERATION_ERROR_CATEGORY_UNSPECIFIED' | 'NOT_APPLICABLE' | 'FATAL' | 'RETRIABLE' | 'IGNORABLE' | 'STANDARD'

Optional. Output only. UnitOperationErrorCategory describe the error category.

deleteTimestring google-datetime

Output only. The timestamp when the resource was marked for deletion (deletion is an asynchronous operation).

annotationsobject

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations

deprovisionDeprovision

Deprovision is the unit operation that deprovision the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned.

engineStatestring

Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage.

rolloutstring

Optional. Specifies which rollout created this Unit Operation. This cannot be modified and is used for filtering purposes only. If a dependent unit and unit operation are created as part of another unit operation, they will use the same rolloutId.

state'UNIT_OPERATION_STATE_UNKNOWN' | 'UNIT_OPERATION_STATE_PENDING' | 'UNIT_OPERATION_STATE_SCHEDULED' | 'UNIT_OPERATION_STATE_RUNNING' | 'UNIT_OPERATION_STATE_SUCCEEDED' | 'UNIT_OPERATION_STATE_FAILED' | 'UNIT_OPERATION_STATE_CANCELLED'

Optional. Output only. UnitOperationState describes the current state of the unit operation.

cancelboolean

Optional. When true, attempt to cancel the operation. Cancellation may fail if the operation is already executing. (Optional)

etagstring

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

createTimestring google-datetime

Output only. The timestamp when the resource was created.

updateTimestring google-datetime

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

uidstring

Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

unitstring

Required. Immutable. The Unit a given UnitOperation will act upon.

labelsobject

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

parentUnitOperationstring

Optional. Reference to parent resource: UnitOperation. If an operation needs to create other operations as part of its workflow, each of the child operations should have this field set to the parent. This can be used for tracing. (Optional)

Response

Successful response