Class PatchJobs.ExecutePatchJobRequest.Builder (2.46.0)

public static final class PatchJobs.ExecutePatchJobRequest.Builder extends GeneratedMessageV3.Builder<PatchJobs.ExecutePatchJobRequest.Builder> implements PatchJobs.ExecutePatchJobRequestOrBuilder

A request message to initiate patching across Compute Engine instances.

Protobuf type google.cloud.osconfig.v1.ExecutePatchJobRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PatchJobs.ExecutePatchJobRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides

build()

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

buildPartial()

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

clear()

public PatchJobs.ExecutePatchJobRequest.Builder clear()
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides

clearDescription()

public PatchJobs.ExecutePatchJobRequest.Builder clearDescription()

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

string description = 2;

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

clearDisplayName()

public PatchJobs.ExecutePatchJobRequest.Builder clearDisplayName()

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

string display_name = 8;

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

clearDryRun()

public PatchJobs.ExecutePatchJobRequest.Builder clearDryRun()

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

bool dry_run = 6;

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

clearDuration()

public PatchJobs.ExecutePatchJobRequest.Builder clearDuration()

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

.google.protobuf.Duration duration = 5;

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public PatchJobs.ExecutePatchJobRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides

clearInstanceFilter()

public PatchJobs.ExecutePatchJobRequest.Builder clearInstanceFilter()

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.ExecutePatchJobRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PatchJobs.ExecutePatchJobRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides

clearParent()

public PatchJobs.ExecutePatchJobRequest.Builder clearParent()

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
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

clearPatchConfig()

public PatchJobs.ExecutePatchJobRequest.Builder clearPatchConfig()

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.ExecutePatchJobRequest.Builder

clearRollout()

public PatchJobs.ExecutePatchJobRequest.Builder clearRollout()

Rollout strategy of the patch job.

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

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

clone()

public PatchJobs.ExecutePatchJobRequest.Builder clone()
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getDurationBuilder()

public Duration.Builder getDurationBuilder()

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

.google.protobuf.Duration duration = 5;

Returns
Type Description
Builder

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.

getInstanceFilterBuilder()

public PatchJobs.PatchInstanceFilter.Builder getInstanceFilterBuilder()

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.Builder

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.

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.

getPatchConfigBuilder()

public PatchJobs.PatchConfig.Builder getPatchConfigBuilder()

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.Builder

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.

getRolloutBuilder()

public PatchJobs.PatchRollout.Builder getRolloutBuilder()

Rollout strategy of the patch job.

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

Returns
Type Description
PatchJobs.PatchRollout.Builder

getRolloutOrBuilder()

public PatchJobs.PatchRolloutOrBuilder getRolloutOrBuilder()

Rollout strategy of the patch job.

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

Returns
Type Description
PatchJobs.PatchRolloutOrBuilder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDuration(Duration value)

public PatchJobs.ExecutePatchJobRequest.Builder mergeDuration(Duration value)

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

.google.protobuf.Duration duration = 5;

Parameter
Name Description
value Duration
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

mergeFrom(PatchJobs.ExecutePatchJobRequest other)

public PatchJobs.ExecutePatchJobRequest.Builder mergeFrom(PatchJobs.ExecutePatchJobRequest other)
Parameter
Name Description
other PatchJobs.ExecutePatchJobRequest
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PatchJobs.ExecutePatchJobRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PatchJobs.ExecutePatchJobRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides

mergeInstanceFilter(PatchJobs.PatchInstanceFilter value)

public PatchJobs.ExecutePatchJobRequest.Builder mergeInstanceFilter(PatchJobs.PatchInstanceFilter value)

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];

Parameter
Name Description
value PatchJobs.PatchInstanceFilter
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

mergePatchConfig(PatchJobs.PatchConfig value)

public PatchJobs.ExecutePatchJobRequest.Builder mergePatchConfig(PatchJobs.PatchConfig value)

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

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

Parameter
Name Description
value PatchJobs.PatchConfig
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

mergeRollout(PatchJobs.PatchRollout value)

public PatchJobs.ExecutePatchJobRequest.Builder mergeRollout(PatchJobs.PatchRollout value)

Rollout strategy of the patch job.

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

Parameter
Name Description
value PatchJobs.PatchRollout
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PatchJobs.ExecutePatchJobRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides

setDescription(String value)

public PatchJobs.ExecutePatchJobRequest.Builder setDescription(String value)

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

string description = 2;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public PatchJobs.ExecutePatchJobRequest.Builder setDescriptionBytes(ByteString value)

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

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

setDisplayName(String value)

public PatchJobs.ExecutePatchJobRequest.Builder setDisplayName(String value)

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

string display_name = 8;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public PatchJobs.ExecutePatchJobRequest.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 8;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

setDryRun(boolean value)

public PatchJobs.ExecutePatchJobRequest.Builder setDryRun(boolean value)

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

bool dry_run = 6;

Parameter
Name Description
value boolean

The dryRun to set.

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

setDuration(Duration value)

public PatchJobs.ExecutePatchJobRequest.Builder setDuration(Duration value)

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

.google.protobuf.Duration duration = 5;

Parameter
Name Description
value Duration
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

setDuration(Duration.Builder builderForValue)

public PatchJobs.ExecutePatchJobRequest.Builder setDuration(Duration.Builder builderForValue)

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

.google.protobuf.Duration duration = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PatchJobs.ExecutePatchJobRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides

setInstanceFilter(PatchJobs.PatchInstanceFilter value)

public PatchJobs.ExecutePatchJobRequest.Builder setInstanceFilter(PatchJobs.PatchInstanceFilter value)

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];

Parameter
Name Description
value PatchJobs.PatchInstanceFilter
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

setInstanceFilter(PatchJobs.PatchInstanceFilter.Builder builderForValue)

public PatchJobs.ExecutePatchJobRequest.Builder setInstanceFilter(PatchJobs.PatchInstanceFilter.Builder builderForValue)

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];

Parameter
Name Description
builderForValue PatchJobs.PatchInstanceFilter.Builder
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

setParent(String value)

public PatchJobs.ExecutePatchJobRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public PatchJobs.ExecutePatchJobRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

This builder for chaining.

setPatchConfig(PatchJobs.PatchConfig value)

public PatchJobs.ExecutePatchJobRequest.Builder setPatchConfig(PatchJobs.PatchConfig value)

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

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

Parameter
Name Description
value PatchJobs.PatchConfig
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

setPatchConfig(PatchJobs.PatchConfig.Builder builderForValue)

public PatchJobs.ExecutePatchJobRequest.Builder setPatchConfig(PatchJobs.PatchConfig.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue PatchJobs.PatchConfig.Builder
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PatchJobs.ExecutePatchJobRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides

setRollout(PatchJobs.PatchRollout value)

public PatchJobs.ExecutePatchJobRequest.Builder setRollout(PatchJobs.PatchRollout value)

Rollout strategy of the patch job.

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

Parameter
Name Description
value PatchJobs.PatchRollout
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

setRollout(PatchJobs.PatchRollout.Builder builderForValue)

public PatchJobs.ExecutePatchJobRequest.Builder setRollout(PatchJobs.PatchRollout.Builder builderForValue)

Rollout strategy of the patch job.

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

Parameter
Name Description
builderForValue PatchJobs.PatchRollout.Builder
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PatchJobs.ExecutePatchJobRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PatchJobs.ExecutePatchJobRequest.Builder
Overrides