Class PatchJobs.PatchRollout.Builder (2.29.0)

public static final class PatchJobs.PatchRollout.Builder extends GeneratedMessageV3.Builder<PatchJobs.PatchRollout.Builder> implements PatchJobs.PatchRolloutOrBuilder

Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.

Protobuf type google.cloud.osconfig.v1beta.PatchRollout

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PatchJobs.PatchRollout.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

build()

public PatchJobs.PatchRollout build()
Returns
TypeDescription
PatchJobs.PatchRollout

buildPartial()

public PatchJobs.PatchRollout buildPartial()
Returns
TypeDescription
PatchJobs.PatchRollout

clear()

public PatchJobs.PatchRollout.Builder clear()
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

clearDisruptionBudget()

public PatchJobs.PatchRollout.Builder clearDisruptionBudget()

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up.

During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps.

A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget.

For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone.

For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.

.google.cloud.osconfig.v1beta.FixedOrPercent disruption_budget = 2;

Returns
TypeDescription
PatchJobs.PatchRollout.Builder

clearField(Descriptors.FieldDescriptor field)

public PatchJobs.PatchRollout.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

clearMode()

public PatchJobs.PatchRollout.Builder clearMode()

Mode of the patch rollout.

.google.cloud.osconfig.v1beta.PatchRollout.Mode mode = 1;

Returns
TypeDescription
PatchJobs.PatchRollout.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PatchJobs.PatchRollout.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

clone()

public PatchJobs.PatchRollout.Builder clone()
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

getDefaultInstanceForType()

public PatchJobs.PatchRollout getDefaultInstanceForType()
Returns
TypeDescription
PatchJobs.PatchRollout

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisruptionBudget()

public Common.FixedOrPercent getDisruptionBudget()

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up.

During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps.

A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget.

For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone.

For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.

.google.cloud.osconfig.v1beta.FixedOrPercent disruption_budget = 2;

Returns
TypeDescription
Common.FixedOrPercent

The disruptionBudget.

getDisruptionBudgetBuilder()

public Common.FixedOrPercent.Builder getDisruptionBudgetBuilder()

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up.

During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps.

A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget.

For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone.

For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.

.google.cloud.osconfig.v1beta.FixedOrPercent disruption_budget = 2;

Returns
TypeDescription
Common.FixedOrPercent.Builder

getDisruptionBudgetOrBuilder()

public Common.FixedOrPercentOrBuilder getDisruptionBudgetOrBuilder()

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up.

During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps.

A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget.

For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone.

For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.

.google.cloud.osconfig.v1beta.FixedOrPercent disruption_budget = 2;

Returns
TypeDescription
Common.FixedOrPercentOrBuilder

getMode()

public PatchJobs.PatchRollout.Mode getMode()

Mode of the patch rollout.

.google.cloud.osconfig.v1beta.PatchRollout.Mode mode = 1;

Returns
TypeDescription
PatchJobs.PatchRollout.Mode

The mode.

getModeValue()

public int getModeValue()

Mode of the patch rollout.

.google.cloud.osconfig.v1beta.PatchRollout.Mode mode = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for mode.

hasDisruptionBudget()

public boolean hasDisruptionBudget()

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up.

During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps.

A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget.

For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone.

For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.

.google.cloud.osconfig.v1beta.FixedOrPercent disruption_budget = 2;

Returns
TypeDescription
boolean

Whether the disruptionBudget field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDisruptionBudget(Common.FixedOrPercent value)

public PatchJobs.PatchRollout.Builder mergeDisruptionBudget(Common.FixedOrPercent value)

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up.

During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps.

A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget.

For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone.

For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.

.google.cloud.osconfig.v1beta.FixedOrPercent disruption_budget = 2;

Parameter
NameDescription
valueCommon.FixedOrPercent
Returns
TypeDescription
PatchJobs.PatchRollout.Builder

mergeFrom(PatchJobs.PatchRollout other)

public PatchJobs.PatchRollout.Builder mergeFrom(PatchJobs.PatchRollout other)
Parameter
NameDescription
otherPatchJobs.PatchRollout
Returns
TypeDescription
PatchJobs.PatchRollout.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PatchJobs.PatchRollout.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PatchJobs.PatchRollout.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PatchJobs.PatchRollout.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

setDisruptionBudget(Common.FixedOrPercent value)

public PatchJobs.PatchRollout.Builder setDisruptionBudget(Common.FixedOrPercent value)

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up.

During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps.

A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget.

For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone.

For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.

.google.cloud.osconfig.v1beta.FixedOrPercent disruption_budget = 2;

Parameter
NameDescription
valueCommon.FixedOrPercent
Returns
TypeDescription
PatchJobs.PatchRollout.Builder

setDisruptionBudget(Common.FixedOrPercent.Builder builderForValue)

public PatchJobs.PatchRollout.Builder setDisruptionBudget(Common.FixedOrPercent.Builder builderForValue)

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up.

During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps.

A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget.

For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone.

For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.

.google.cloud.osconfig.v1beta.FixedOrPercent disruption_budget = 2;

Parameter
NameDescription
builderForValueCommon.FixedOrPercent.Builder
Returns
TypeDescription
PatchJobs.PatchRollout.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PatchJobs.PatchRollout.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

setMode(PatchJobs.PatchRollout.Mode value)

public PatchJobs.PatchRollout.Builder setMode(PatchJobs.PatchRollout.Mode value)

Mode of the patch rollout.

.google.cloud.osconfig.v1beta.PatchRollout.Mode mode = 1;

Parameter
NameDescription
valuePatchJobs.PatchRollout.Mode

The mode to set.

Returns
TypeDescription
PatchJobs.PatchRollout.Builder

This builder for chaining.

setModeValue(int value)

public PatchJobs.PatchRollout.Builder setModeValue(int value)

Mode of the patch rollout.

.google.cloud.osconfig.v1beta.PatchRollout.Mode mode = 1;

Parameter
NameDescription
valueint

The enum numeric value on the wire for mode to set.

Returns
TypeDescription
PatchJobs.PatchRollout.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PatchJobs.PatchRollout.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PatchJobs.PatchRollout.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides