Class PatchJobs.ExecutePatchJobRequest (2.47.0)

public static final class PatchJobs.ExecutePatchJobRequest extends GeneratedMessageV3 implements PatchJobs.ExecutePatchJobRequestOrBuilder

A request message to initiate patching across Compute Engine instances.

Protobuf type google.cloud.osconfig.v1.ExecutePatchJobRequest

Inheritance

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

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

DRY_RUN_FIELD_NUMBER

public static final int DRY_RUN_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_FILTER_FIELD_NUMBER

public static final int INSTANCE_FILTER_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PATCH_CONFIG_FIELD_NUMBER

public static final int PATCH_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ROLLOUT_FIELD_NUMBER

public static final int ROLLOUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(PatchJobs.ExecutePatchJobRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getDescription()

public String getDescription()

Description of the patch job. Length of the description is limited to 1024 characters.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the patch job. Length of the description is limited to 1024 characters.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Display name for this patch job. This does not have to be unique.

string display_name = 8;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name for this patch job. This does not have to be unique.

string display_name = 8;

Returns
Type Description
ByteString

The bytes for displayName.

getDryRun()

public boolean getDryRun()

If this patch is a dry-run only, instances are contacted but will do nothing.

bool dry_run = 6;

Returns
Type Description
boolean

The dryRun.

getDuration()

public Duration getDuration()

Duration of the patch job. After the duration ends, the patch job times out.

.google.protobuf.Duration duration = 5;

Returns
Type Description
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration of the patch job. After the duration ends, the patch job times out.

.google.protobuf.Duration duration = 5;

Returns
Type Description
DurationOrBuilder

getInstanceFilter()

public PatchJobs.PatchInstanceFilter getInstanceFilter()

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PatchJobs.PatchInstanceFilter

The instanceFilter.

getInstanceFilterOrBuilder()

public PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PatchJobs.PatchInstanceFilterOrBuilder

getParent()

public String getParent()

Required. The project in which to run this patch in the form projects/*

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project in which to run this patch in the form projects/*

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getPatchConfig()

public PatchJobs.PatchConfig getPatchConfig()

Patch configuration being applied. If omitted, instances are patched using the default configurations.

.google.cloud.osconfig.v1.PatchConfig patch_config = 4;

Returns
Type Description
PatchJobs.PatchConfig

The patchConfig.

getPatchConfigOrBuilder()

public PatchJobs.PatchConfigOrBuilder getPatchConfigOrBuilder()

Patch configuration being applied. If omitted, instances are patched using the default configurations.

.google.cloud.osconfig.v1.PatchConfig patch_config = 4;

Returns
Type Description
PatchJobs.PatchConfigOrBuilder

getRollout()

public PatchJobs.PatchRollout getRollout()

Rollout strategy of the patch job.

.google.cloud.osconfig.v1.PatchRollout rollout = 9;

Returns
Type Description
PatchJobs.PatchRollout

The rollout.

getRolloutOrBuilder()

public PatchJobs.PatchRolloutOrBuilder getRolloutOrBuilder()

Rollout strategy of the patch job.

.google.cloud.osconfig.v1.PatchRollout rollout = 9;

Returns
Type Description
PatchJobs.PatchRolloutOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDuration()

public boolean hasDuration()

Duration of the patch job. After the duration ends, the patch job times out.

.google.protobuf.Duration duration = 5;

Returns
Type Description
boolean

Whether the duration field is set.

hasInstanceFilter()

public boolean hasInstanceFilter()

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the instanceFilter field is set.

hasPatchConfig()

public boolean hasPatchConfig()

Patch configuration being applied. If omitted, instances are patched using the default configurations.

.google.cloud.osconfig.v1.PatchConfig patch_config = 4;

Returns
Type Description
boolean

Whether the patchConfig field is set.

hasRollout()

public boolean hasRollout()

Rollout strategy of the patch job.

.google.cloud.osconfig.v1.PatchRollout rollout = 9;

Returns
Type Description
boolean

Whether the rollout 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.ExecutePatchJobRequest.Builder newBuilderForType()
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchJobs.ExecutePatchJobRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.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.ExecutePatchJobRequest.Builder toBuilder()
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

writeTo(CodedOutputStream output)

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