v1

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

Create a new rollout.

post/v1/{+parent}/rollouts

Path parameters

parentstring required

Required. The parent of the rollout.

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

rolloutIdstring

Required. The ID value for the new rollout.

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}/rollout/{rollout_id}"

rootRolloutstring

Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"

unitFilterstring

Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutKind will be used.

deleteTimestring google-datetime

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

flagReleasestring

Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: release comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted.

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

releasestring

Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.

rolloutOrchestrationStrategystring

Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutKind. If not specified on creation, the strategy from RolloutKind will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.

rolloutKindstring

Required. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.

endTimestring google-datetime

Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.

state'ROLLOUT_STATE_UNSPECIFIED' | 'ROLLOUT_STATE_RUNNING' | 'ROLLOUT_STATE_PAUSED' | 'ROLLOUT_STATE_SUCCEEDED' | 'ROLLOUT_STATE_FAILED' | 'ROLLOUT_STATE_CANCELLED' | 'ROLLOUT_STATE_WAITING' | 'ROLLOUT_STATE_CANCELLING' | 'ROLLOUT_STATE_RESUMING' | 'ROLLOUT_STATE_PAUSING'

Output only. Current state of the rollout.

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.

effectiveUnitFilterstring

Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here.

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.

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.

parentRolloutstring

Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"

labelsobject

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

stateTransitionTimestring google-datetime

Optional. Output only. The time when the rollout transitioned into its current state.

startTimestring google-datetime

Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.

stateMessagestring

Output only. Human readable message indicating details about the last state transition.

Response

Successful response