Interface PatchJobs.PatchJobOrBuilder (2.37.0)

Version 2.37.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.6
• 2.4.3
• 2.3.2

public static interface PatchJobs.PatchJobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract 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 abstract 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 abstract String getDisplayName()

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

string display_name = 14;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

string display_name = 14;

Returns
Type	Description
ByteString	The bytes for displayName.

getDryRun()

public abstract 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
Type	Description
boolean	The dryRun.

getDuration()

public abstract Duration getDuration()

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

.google.protobuf.Duration duration = 8;

Returns
Type	Description
Duration	The duration.

getDurationOrBuilder()

public abstract DurationOrBuilder getDurationOrBuilder()

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

.google.protobuf.Duration duration = 8;

Returns
Type	Description
DurationOrBuilder

getErrorMessage()

public abstract String getErrorMessage()

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

string error_message = 11;

Returns
Type	Description
String	The errorMessage.

getErrorMessageBytes()

public abstract ByteString getErrorMessageBytes()

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

string error_message = 11;

Returns
Type	Description
ByteString	The bytes for errorMessage.

getInstanceDetailsSummary()

public abstract PatchJobs.PatchJob.InstanceDetailsSummary getInstanceDetailsSummary()

Summary of instance details.

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

Returns
Type	Description
PatchJobs.PatchJob.InstanceDetailsSummary	The instanceDetailsSummary.

getInstanceDetailsSummaryOrBuilder()

public abstract PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder getInstanceDetailsSummaryOrBuilder()

Summary of instance details.

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

Returns
Type	Description
PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder

getInstanceFilter()

public abstract PatchJobs.PatchInstanceFilter getInstanceFilter()

Instances to patch.

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

Returns
Type	Description
PatchJobs.PatchInstanceFilter	The instanceFilter.

getInstanceFilterOrBuilder()

public abstract PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()

Instances to patch.

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

Returns
Type	Description
PatchJobs.PatchInstanceFilterOrBuilder

getName()

public abstract String getName()

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

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getPatchConfig()

public abstract PatchJobs.PatchConfig getPatchConfig()

Patch configuration being applied.

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

Returns
Type	Description
PatchJobs.PatchConfig	The patchConfig.

getPatchConfigOrBuilder()

public abstract PatchJobs.PatchConfigOrBuilder getPatchConfigOrBuilder()

Patch configuration being applied.

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

Returns
Type	Description
PatchJobs.PatchConfigOrBuilder

getPatchDeployment()

public abstract String getPatchDeployment()

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

string patch_deployment = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The patchDeployment.

getPatchDeploymentBytes()

public abstract ByteString getPatchDeploymentBytes()

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

string patch_deployment = 15 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for patchDeployment.

getPercentComplete()

public abstract 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
Type	Description
double	The percentComplete.

getRollout()

public abstract PatchJobs.PatchRollout getRollout()

Rollout strategy being applied.

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

Returns
Type	Description
PatchJobs.PatchRollout	The rollout.

getRolloutOrBuilder()

public abstract PatchJobs.PatchRolloutOrBuilder getRolloutOrBuilder()

Rollout strategy being applied.

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

Returns
Type	Description
PatchJobs.PatchRolloutOrBuilder

getState()

public abstract PatchJobs.PatchJob.State getState()

The current state of the PatchJob.

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

Returns
Type	Description
PatchJobs.PatchJob.State	The state.

getStateValue()

public abstract int getStateValue()

The current state of the PatchJob.

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

Returns
Type	Description
int	The enum numeric value on the wire for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
boolean	Whether the createTime field is set.

hasDuration()

public abstract boolean hasDuration()

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

.google.protobuf.Duration duration = 8;

Returns
Type	Description
boolean	Whether the duration field is set.

hasInstanceDetailsSummary()

public abstract boolean hasInstanceDetailsSummary()

Summary of instance details.

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

Returns
Type	Description
boolean	Whether the instanceDetailsSummary field is set.

hasInstanceFilter()

public abstract boolean hasInstanceFilter()

Instances to patch.

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

Returns
Type	Description
boolean	Whether the instanceFilter field is set.

hasPatchConfig()

public abstract boolean hasPatchConfig()

Patch configuration being applied.

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

Returns
Type	Description
boolean	Whether the patchConfig field is set.

hasRollout()

public abstract boolean hasRollout()

Rollout strategy being applied.

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

Returns
Type	Description
boolean	Whether the rollout field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
boolean	Whether the updateTime field is set.