Compute V1 Client - Class GlobalVmExtensionPolicyRolloutOperationRolloutInput (2.10.0)

Reference documentation and code samples for the Compute V1 Client class GlobalVmExtensionPolicyRolloutOperationRolloutInput.

Generated from protobuf message google.cloud.compute.v1.GlobalVmExtensionPolicyRolloutOperationRolloutInput

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ conflict_behavior 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.
↳ name string

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

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. Check the PredefinedRolloutPlan enum for the list of possible values.
↳ retry_uuid 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 retry_uuid 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.

getConflictBehavior

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.
Returns
Type Description
string

hasConflictBehavior

clearConflictBehavior

setConflictBehavior

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getName

Optional. The name of the rollout plan.

Ex. projects//locations/global/rolloutPlans/.

Returns
Type Description
string

hasName

clearName

setName

Optional. The name of the rollout plan.

Ex. projects//locations/global/rolloutPlans/.

Parameter
Name Description
var string
Returns
Type Description
$this

getPredefinedRolloutPlan

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.

Check the PredefinedRolloutPlan enum for the list of possible values.

Returns
Type Description
string

hasPredefinedRolloutPlan

clearPredefinedRolloutPlan

setPredefinedRolloutPlan

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.

Check the PredefinedRolloutPlan enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getRetryUuid

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 retry_uuid 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.
Returns
Type Description
string

hasRetryUuid

clearRetryUuid

setRetryUuid

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 retry_uuid 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.
Parameter
Name Description
var string
Returns
Type Description
$this