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.v1.PatchRollout
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PatchJobs.PatchRollout.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public PatchJobs.PatchRollout build()
Returns
buildPartial()
public PatchJobs.PatchRollout buildPartial()
Returns
clear()
public PatchJobs.PatchRollout.Builder clear()
Returns
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.v1.FixedOrPercent disruption_budget = 2;
clearField(Descriptors.FieldDescriptor field)
public PatchJobs.PatchRollout.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearMode()
public PatchJobs.PatchRollout.Builder clearMode()
Mode of the patch rollout.
.google.cloud.osconfig.v1.PatchRollout.Mode mode = 1;
clearOneof(Descriptors.OneofDescriptor oneof)
public PatchJobs.PatchRollout.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public PatchJobs.PatchRollout.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public PatchJobs.PatchRollout getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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.v1.FixedOrPercent disruption_budget = 2;
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.v1.FixedOrPercent disruption_budget = 2;
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.v1.FixedOrPercent disruption_budget = 2;
getMode()
public PatchJobs.PatchRollout.Mode getMode()
Mode of the patch rollout.
.google.cloud.osconfig.v1.PatchRollout.Mode mode = 1;
getModeValue()
public int getModeValue()
Mode of the patch rollout.
.google.cloud.osconfig.v1.PatchRollout.Mode mode = 1;
| Type | Description |
| 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.v1.FixedOrPercent disruption_budget = 2;
| Type | Description |
| boolean | Whether the disruptionBudget field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
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.v1.FixedOrPercent disruption_budget = 2;
mergeFrom(PatchJobs.PatchRollout other)
public PatchJobs.PatchRollout.Builder mergeFrom(PatchJobs.PatchRollout other)
Parameter
Returns
public PatchJobs.PatchRollout.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public PatchJobs.PatchRollout.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PatchJobs.PatchRollout.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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.v1.FixedOrPercent disruption_budget = 2;
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.v1.FixedOrPercent disruption_budget = 2;
setField(Descriptors.FieldDescriptor field, Object value)
public PatchJobs.PatchRollout.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setMode(PatchJobs.PatchRollout.Mode value)
public PatchJobs.PatchRollout.Builder setMode(PatchJobs.PatchRollout.Mode value)
Mode of the patch rollout.
.google.cloud.osconfig.v1.PatchRollout.Mode mode = 1;
setModeValue(int value)
public PatchJobs.PatchRollout.Builder setModeValue(int value)
Mode of the patch rollout.
.google.cloud.osconfig.v1.PatchRollout.Mode mode = 1;
| Name | Description |
| value | int
The enum numeric value on the wire for mode to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PatchJobs.PatchRollout.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PatchJobs.PatchRollout.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
