Class PatchJobs.PatchRollout (2.5.2)

Stay organized with collections Save and categorize content based on your preferences.
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

Static Fields

DISRUPTION_BUDGET_FIELD_NUMBER

public static final int DISRUPTION_BUDGET_FIELD_NUMBER
Field Value
TypeDescription
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PatchJobs.PatchRollout getDefaultInstance()
Returns
TypeDescription
PatchJobs.PatchRollout

getDescriptor()

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

newBuilder()

public static PatchJobs.PatchRollout.Builder newBuilder()
Returns
TypeDescription
PatchJobs.PatchRollout.Builder

newBuilder(PatchJobs.PatchRollout prototype)

public static PatchJobs.PatchRollout.Builder newBuilder(PatchJobs.PatchRollout prototype)
Parameter
NameDescription
prototypePatchJobs.PatchRollout
Returns
TypeDescription
PatchJobs.PatchRollout.Builder

parseDelimitedFrom(InputStream input)

public static PatchJobs.PatchRollout parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PatchJobs.PatchRollout parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PatchJobs.PatchRollout parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PatchJobs.PatchRollout parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PatchJobs.PatchRollout parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PatchJobs.PatchRollout parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchRollout parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchRollout
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PatchJobs.PatchRollout getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Common.FixedOrPercentOrBuilder

getMode()

public PatchJobs.PatchRollout.Mode getMode()

Mode of the patch rollout.

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

Returns
TypeDescription
PatchJobs.PatchRollout.Mode

The mode.

getModeValue()

public int getModeValue()

Mode of the patch rollout.

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

Returns
TypeDescription
int

The enum numeric value on the wire for mode.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
boolean

Whether the disruptionBudget field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PatchJobs.PatchRollout.Builder newBuilderForType()
Returns
TypeDescription
PatchJobs.PatchRollout.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchJobs.PatchRollout.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PatchJobs.PatchRollout.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PatchJobs.PatchRollout.Builder toBuilder()
Returns
TypeDescription
PatchJobs.PatchRollout.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription