RolloutInput

JSON representation
{
  "retryUuid": string,
  "conflictBehavior": string,

  // Union field rollout_plan can be only one of the following:
  "name": string,
  "predefinedRolloutPlan": enum (PredefinedRolloutPlan)
  // End of list of possible types for union field rollout_plan.
}
Fields
retryUuid

string

Optional. The UUID that identifies a policy rollout retry attempt for update and delete operations. Set this field only when retrying a rollout for an existing extension policy.

  • update method: Lets you retry policy rollout without changes. An error occurs if you set retryUuid but the policy is modified.
  • delete method: Lets you retry policy deletion rollout if the previous deletion rollout is not finished and the policy is in the DELETING state. If you set this field when the policy is not in the DELETING state, an error occurs.
conflictBehavior

string

Optional. Specifies the behavior of the rollout if a conflict is detected in a project during a rollout. This only applies to insert and update methods.

A conflict occurs in the following cases:

  • insert method: If the zonal policy already exists when the insert happens.
  • update method: If the zonal policy was modified by a zonal API call outside of this rollout.

Possible values are the following:

  • "" (empty string): If a conflict occurs, the local value is not overwritten. This is the default behavior.
  • "overwrite": If a conflict occurs, the local value is overwritten with the rollout value.
Union field rollout_plan. [Optional] The rollout plan to use for the rollout. If unspecified, it will use server product's default rollout plan. rollout_plan can be only one of the following:
name

string

Optional. The name of the rollout plan. Ex. projects//locations/global/rolloutPlans/.

predefinedRolloutPlan

enum (PredefinedRolloutPlan)

Optional. Specifies the predefined rollout plan for the policy. Valid values are SLOW_ROLLOUT and FAST_ROLLOUT. The recommended value is SLOW_ROLLOUT for progressive rollout. For more information, see Rollout plans for global policies.

PredefinedRolloutPlan

Define your own rollout plan here. The predefined rollout plans will need to be created by the service producers. When the end users use the predefined rollout plan, the service producers will need to convert it to the corresponding rollout plan and send it to Rollout Service.

Enums
ROLLOUT_PLAN_UNSPECIFIED
FAST_ROLLOUT
SLOW_ROLLOUT