Sign in

v1

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

Create a new rollout kind.

post/v1/{+parent}/rolloutKinds

Path parameters

parentstring required

Required. The parent of the rollout kind.

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

rolloutKindIdstring

Required. The ID value for the new rollout kind.

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

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.

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

rolloutOrchestrationStrategystring

Optional. The strategy used for executing a Rollout. This is a required field. 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 associated UnitKind's Saas Locations.

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.

namestring

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

unitKindstring

Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.

updateUnitKindStrategy'UPDATE_UNIT_KIND_STRATEGY_UNSPECIFIED' | 'UPDATE_UNIT_KIND_STRATEGY_ON_START' | 'UPDATE_UNIT_KIND_STRATEGY_NEVER'

Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.

labelsobject

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

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.

Response

Successful response