Class PatchJobs.PatchRollout (2.61.0) 

public static final class PatchJobs.PatchRollout extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PatchJobs.PatchRollout

Static Fields

DISRUPTION_BUDGET_FIELD_NUMBER

public static final int DISRUPTION_BUDGET_FIELD_NUMBER
Field Value
Type Description
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PatchJobs.PatchRollout getDefaultInstance()
Returns
Type Description
PatchJobs.PatchRollout

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PatchJobs.PatchRollout.Builder newBuilder()
Returns
Type Description
PatchJobs.PatchRollout.Builder

newBuilder(PatchJobs.PatchRollout prototype)

public static PatchJobs.PatchRollout.Builder newBuilder(PatchJobs.PatchRollout prototype)
Parameter
Name Description
prototype PatchJobs.PatchRollout
Returns
Type Description
PatchJobs.PatchRollout.Builder

parseDelimitedFrom(InputStream input)

public static PatchJobs.PatchRollout parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PatchJobs.PatchRollout parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PatchJobs.PatchRollout parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PatchJobs.PatchRollout parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PatchJobs.PatchRollout parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PatchJobs.PatchRollout parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchJobs.PatchRollout
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PatchJobs.PatchRollout> parser()
Returns
Type Description
Parser<PatchRollout>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PatchJobs.PatchRollout getDefaultInstanceForType()
Returns
Type Description
PatchJobs.PatchRollout

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.

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.

getParserForType()

public Parser<PatchJobs.PatchRollout> getParserForType()
Returns
Type Description
Parser<PatchRollout>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PatchJobs.PatchRollout.Builder newBuilderForType()
Returns
Type Description
PatchJobs.PatchRollout.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchJobs.PatchRollout.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PatchJobs.PatchRollout.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PatchJobs.PatchRollout.Builder toBuilder()
Returns
Type Description
PatchJobs.PatchRollout.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException