Class PatchJobs.PatchJob.Builder (2.5.1)

public static final class PatchJobs.PatchJob.Builder extends GeneratedMessageV3.Builder<PatchJobs.PatchJob.Builder> implements PatchJobs.PatchJobOrBuilder

A high level representation of a patch job that is either in progress or has completed. Instance details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. For more information about patch jobs, see Creating patch jobs.

Protobuf type google.cloud.osconfig.v1beta.PatchJob

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PatchJobs.PatchJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PatchJobs.PatchJob.Builder
Overrides

build()

public PatchJobs.PatchJob build()
Returns
TypeDescription
PatchJobs.PatchJob

buildPartial()

public PatchJobs.PatchJob buildPartial()
Returns
TypeDescription
PatchJobs.PatchJob

clear()

public PatchJobs.PatchJob.Builder clear()
Returns
TypeDescription
PatchJobs.PatchJob.Builder
Overrides

clearCreateTime()

public PatchJobs.PatchJob.Builder clearCreateTime()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

clearDescription()

public PatchJobs.PatchJob.Builder clearDescription()

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

string description = 2;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

This builder for chaining.

clearDisplayName()

public PatchJobs.PatchJob.Builder clearDisplayName()

Display name for this patch job. This is not a unique identifier.

string display_name = 14;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

This builder for chaining.

clearDryRun()

public PatchJobs.PatchJob.Builder clearDryRun()

If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.

bool dry_run = 10;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

This builder for chaining.

clearDuration()

public PatchJobs.PatchJob.Builder clearDuration()

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

.google.protobuf.Duration duration = 8;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

clearErrorMessage()

public PatchJobs.PatchJob.Builder clearErrorMessage()

If this patch job failed, this message provides information about the failure.

string error_message = 11;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PatchJobs.PatchJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PatchJobs.PatchJob.Builder
Overrides

clearInstanceDetailsSummary()

public PatchJobs.PatchJob.Builder clearInstanceDetailsSummary()

Summary of instance details.

.google.cloud.osconfig.v1beta.PatchJob.InstanceDetailsSummary instance_details_summary = 9;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

clearInstanceFilter()

public PatchJobs.PatchJob.Builder clearInstanceFilter()

Instances to patch.

.google.cloud.osconfig.v1beta.PatchInstanceFilter instance_filter = 13;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

clearName()

public PatchJobs.PatchJob.Builder clearName()

Unique identifier for this patch job in the form projects/*/patchJobs/*

string name = 1;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PatchJobs.PatchJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PatchJobs.PatchJob.Builder
Overrides

clearPatchConfig()

public PatchJobs.PatchJob.Builder clearPatchConfig()

Patch configuration being applied.

.google.cloud.osconfig.v1beta.PatchConfig patch_config = 7;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

clearPatchDeployment()

public PatchJobs.PatchJob.Builder clearPatchDeployment()

Output only. Name of the patch deployment that created this patch job.

string patch_deployment = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
PatchJobs.PatchJob.Builder

This builder for chaining.

clearPercentComplete()

public PatchJobs.PatchJob.Builder clearPercentComplete()

Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.

double percent_complete = 12;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

This builder for chaining.

clearRollout()

public PatchJobs.PatchJob.Builder clearRollout()

Rollout strategy being applied.

.google.cloud.osconfig.v1beta.PatchRollout rollout = 16;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

clearState()

public PatchJobs.PatchJob.Builder clearState()

The current state of the PatchJob.

.google.cloud.osconfig.v1beta.PatchJob.State state = 5;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

This builder for chaining.

clearUpdateTime()

public PatchJobs.PatchJob.Builder clearUpdateTime()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
PatchJobs.PatchJob.Builder

clone()

public PatchJobs.PatchJob.Builder clone()
Returns
TypeDescription
PatchJobs.PatchJob.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public PatchJobs.PatchJob getDefaultInstanceForType()
Returns
TypeDescription
PatchJobs.PatchJob

getDescription()

public String getDescription()

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

string description = 2;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Display name for this patch job. This is not a unique identifier.

string display_name = 14;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name for this patch job. This is not a unique identifier.

string display_name = 14;

Returns
TypeDescription
ByteString

The bytes for displayName.

getDryRun()

public boolean getDryRun()

If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.

bool dry_run = 10;

Returns
TypeDescription
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 = 8;

Returns
TypeDescription
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 = 8;

Returns
TypeDescription
Builder

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

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

.google.protobuf.Duration duration = 8;

Returns
TypeDescription
DurationOrBuilder

getErrorMessage()

public String getErrorMessage()

If this patch job failed, this message provides information about the failure.

string error_message = 11;

Returns
TypeDescription
String

The errorMessage.

getErrorMessageBytes()

public ByteString getErrorMessageBytes()

If this patch job failed, this message provides information about the failure.

string error_message = 11;

Returns
TypeDescription
ByteString

The bytes for errorMessage.

getInstanceDetailsSummary()

public PatchJobs.PatchJob.InstanceDetailsSummary getInstanceDetailsSummary()

Summary of instance details.

.google.cloud.osconfig.v1beta.PatchJob.InstanceDetailsSummary instance_details_summary = 9;

Returns
TypeDescription
PatchJobs.PatchJob.InstanceDetailsSummary

The instanceDetailsSummary.

getInstanceDetailsSummaryBuilder()

public PatchJobs.PatchJob.InstanceDetailsSummary.Builder getInstanceDetailsSummaryBuilder()

Summary of instance details.

.google.cloud.osconfig.v1beta.PatchJob.InstanceDetailsSummary instance_details_summary = 9;

Returns
TypeDescription
PatchJobs.PatchJob.InstanceDetailsSummary.Builder

getInstanceDetailsSummaryOrBuilder()

public PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder getInstanceDetailsSummaryOrBuilder()

Summary of instance details.

.google.cloud.osconfig.v1beta.PatchJob.InstanceDetailsSummary instance_details_summary = 9;

Returns
TypeDescription
PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder

getInstanceFilter()

public PatchJobs.PatchInstanceFilter getInstanceFilter()

Instances to patch.

.google.cloud.osconfig.v1beta.PatchInstanceFilter instance_filter = 13;

Returns
TypeDescription
PatchJobs.PatchInstanceFilter

The instanceFilter.

getInstanceFilterBuilder()

public PatchJobs.PatchInstanceFilter.Builder getInstanceFilterBuilder()

Instances to patch.

.google.cloud.osconfig.v1beta.PatchInstanceFilter instance_filter = 13;

Returns
TypeDescription
PatchJobs.PatchInstanceFilter.Builder

getInstanceFilterOrBuilder()

public PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()

Instances to patch.

.google.cloud.osconfig.v1beta.PatchInstanceFilter instance_filter = 13;

Returns
TypeDescription
PatchJobs.PatchInstanceFilterOrBuilder

getName()

public String getName()

Unique identifier for this patch job in the form projects/*/patchJobs/*

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Unique identifier for this patch job in the form projects/*/patchJobs/*

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getPatchConfig()

public PatchJobs.PatchConfig getPatchConfig()

Patch configuration being applied.

.google.cloud.osconfig.v1beta.PatchConfig patch_config = 7;

Returns
TypeDescription
PatchJobs.PatchConfig

The patchConfig.

getPatchConfigBuilder()

public PatchJobs.PatchConfig.Builder getPatchConfigBuilder()

Patch configuration being applied.

.google.cloud.osconfig.v1beta.PatchConfig patch_config = 7;

Returns
TypeDescription
PatchJobs.PatchConfig.Builder

getPatchConfigOrBuilder()

public PatchJobs.PatchConfigOrBuilder getPatchConfigOrBuilder()

Patch configuration being applied.

.google.cloud.osconfig.v1beta.PatchConfig patch_config = 7;

Returns
TypeDescription
PatchJobs.PatchConfigOrBuilder

getPatchDeployment()

public String getPatchDeployment()

Output only. Name of the patch deployment that created this patch job.

string patch_deployment = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The patchDeployment.

getPatchDeploymentBytes()

public ByteString getPatchDeploymentBytes()

Output only. Name of the patch deployment that created this patch job.

string patch_deployment = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for patchDeployment.

getPercentComplete()

public double getPercentComplete()

Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.

double percent_complete = 12;

Returns
TypeDescription
double

The percentComplete.

getRollout()

public PatchJobs.PatchRollout getRollout()

Rollout strategy being applied.

.google.cloud.osconfig.v1beta.PatchRollout rollout = 16;

Returns
TypeDescription
PatchJobs.PatchRollout

The rollout.

getRolloutBuilder()

public PatchJobs.PatchRollout.Builder getRolloutBuilder()

Rollout strategy being applied.

.google.cloud.osconfig.v1beta.PatchRollout rollout = 16;

Returns
TypeDescription
PatchJobs.PatchRollout.Builder

getRolloutOrBuilder()

public PatchJobs.PatchRolloutOrBuilder getRolloutOrBuilder()

Rollout strategy being applied.

.google.cloud.osconfig.v1beta.PatchRollout rollout = 16;

Returns
TypeDescription
PatchJobs.PatchRolloutOrBuilder

getState()

public PatchJobs.PatchJob.State getState()

The current state of the PatchJob.

.google.cloud.osconfig.v1beta.PatchJob.State state = 5;

Returns
TypeDescription
PatchJobs.PatchJob.State

The state.

getStateValue()

public int getStateValue()

The current state of the PatchJob.

.google.cloud.osconfig.v1beta.PatchJob.State state = 5;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Last time this patch jo