public static final class PatchJobs.PatchRollout.Builder extends GeneratedMessageV3.Builder<PatchJobs.PatchRollout.Builder> implements PatchJobs.PatchRolloutOrBuilderPatch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.
Protobuf type google.cloud.osconfig.v1.PatchRollout
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PatchJobs.PatchRollout.BuilderImplements
PatchJobs.PatchRolloutOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PatchJobs.PatchRollout.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
build()
public PatchJobs.PatchRollout build()| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout |
|
buildPartial()
public PatchJobs.PatchRollout buildPartial()| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout |
|
clear()
public PatchJobs.PatchRollout.Builder clear()| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public PatchJobs.PatchRollout.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
clearMode()
public PatchJobs.PatchRollout.Builder clearMode()Mode of the patch rollout.
.google.cloud.osconfig.v1.PatchRollout.Mode mode = 1;
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public PatchJobs.PatchRollout.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
clone()
public PatchJobs.PatchRollout.Builder clone()| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
getDefaultInstanceForType()
public PatchJobs.PatchRollout getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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;
| Returns | |
|---|---|
| Type | Description |
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.v1.FixedOrPercent disruption_budget = 2;
| Returns | |
|---|---|
| Type | Description |
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.v1.FixedOrPercent disruption_budget = 2;
| Returns | |
|---|---|
| Type | Description |
Common.FixedOrPercentOrBuilder |
|
getMode()
public PatchJobs.PatchRollout.Mode getMode()Mode of the patch rollout.
.google.cloud.osconfig.v1.PatchRollout.Mode mode = 1;
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Mode |
The mode. |
getModeValue()
public int getModeValue()Mode of the patch rollout.
.google.cloud.osconfig.v1.PatchRollout.Mode mode = 1;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the disruptionBudget field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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;
| Parameter | |
|---|---|
| Name | Description |
value |
Common.FixedOrPercent |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
mergeFrom(PatchJobs.PatchRollout other)
public PatchJobs.PatchRollout.Builder mergeFrom(PatchJobs.PatchRollout other)| Parameter | |
|---|---|
| Name | Description |
other |
PatchJobs.PatchRollout |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PatchJobs.PatchRollout.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PatchJobs.PatchRollout.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PatchJobs.PatchRollout.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
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;
| Parameter | |
|---|---|
| Name | Description |
value |
Common.FixedOrPercent |
| Returns | |
|---|---|
| Type | Description |
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.v1.FixedOrPercent disruption_budget = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Common.FixedOrPercent.Builder |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public PatchJobs.PatchRollout.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
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;
| Parameter | |
|---|---|
| Name | Description |
value |
PatchJobs.PatchRollout.ModeThe mode to set. |
| Returns | |
|---|---|
| Type | Description |
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.v1.PatchRollout.Mode mode = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for mode to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final PatchJobs.PatchRollout.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PatchJobs.PatchRollout.Builder |
|