com.google.cloud.osconfig.v1

Interface PatchJobs.PatchJobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PatchJobs.PatchJob, PatchJobs.PatchJob.Builder

Enclosing class:

PatchJobs

public static interface PatchJobs.PatchJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCreateTime() Time this patch job was created.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Time this patch job was created.
String	getDescription() Description of the patch job.
com.google.protobuf.ByteString	getDescriptionBytes() Description of the patch job.
String	getDisplayName() Display name for this patch job.
com.google.protobuf.ByteString	getDisplayNameBytes() Display name for this patch job.
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.
com.google.protobuf.Duration	getDuration() Duration of the patch job.
com.google.protobuf.DurationOrBuilder	getDurationOrBuilder() Duration of the patch job.
String	getErrorMessage() If this patch job failed, this message provides information about the failure.
com.google.protobuf.ByteString	getErrorMessageBytes() If this patch job failed, this message provides information about the failure.
PatchJobs.PatchJob.InstanceDetailsSummary	getInstanceDetailsSummary() Summary of instance details.
PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder	getInstanceDetailsSummaryOrBuilder() Summary of instance details.
PatchJobs.PatchInstanceFilter	getInstanceFilter() Instances to patch.
PatchJobs.PatchInstanceFilterOrBuilder	getInstanceFilterOrBuilder() Instances to patch.
String	getName() Unique identifier for this patch job in the form `projects/*/patchJobs/*`
com.google.protobuf.ByteString	getNameBytes() Unique identifier for this patch job in the form `projects/*/patchJobs/*`
PatchJobs.PatchConfig	getPatchConfig() Patch configuration being applied.
PatchJobs.PatchConfigOrBuilder	getPatchConfigOrBuilder() Patch configuration being applied.
String	getPatchDeployment() Output only.
com.google.protobuf.ByteString	getPatchDeploymentBytes() Output only.
double	getPercentComplete() Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
PatchJobs.PatchRollout	getRollout() Rollout strategy being applied.
PatchJobs.PatchRolloutOrBuilder	getRolloutOrBuilder() Rollout strategy being applied.
PatchJobs.PatchJob.State	getState() The current state of the PatchJob.
int	getStateValue() The current state of the PatchJob.
com.google.protobuf.Timestamp	getUpdateTime() Last time this patch job was updated.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Last time this patch job was updated.
boolean	hasCreateTime() Time this patch job was created.
boolean	hasDuration() Duration of the patch job.
boolean	hasInstanceDetailsSummary() Summary of instance details.
boolean	hasInstanceFilter() Instances to patch.
boolean	hasPatchConfig() Patch configuration being applied.
boolean	hasRollout() Rollout strategy being applied.
boolean	hasUpdateTime() Last time this patch job was updated.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

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

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

string name = 1;

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

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

string display_name = 14;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

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

string display_name = 14;

Returns:

The bytes for displayName.

getDescription

String getDescription()

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

string description = 2;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

string description = 2;

Returns:

The bytes for description.

hasCreateTime

boolean hasCreateTime()

 Time this patch job was created.
 

.google.protobuf.Timestamp create_time = 3;

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Time this patch job was created.
 

.google.protobuf.Timestamp create_time = 3;

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Time this patch job was created.
 

.google.protobuf.Timestamp create_time = 3;

hasUpdateTime

boolean hasUpdateTime()

 Last time this patch job was updated.
 

.google.protobuf.Timestamp update_time = 4;

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Last time this patch job was updated.
 

.google.protobuf.Timestamp update_time = 4;

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Last time this patch job was updated.
 

.google.protobuf.Timestamp update_time = 4;

getStateValue

int getStateValue()

 The current state of the PatchJob.
 

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

Returns:

The enum numeric value on the wire for state.

getState

PatchJobs.PatchJob.State getState()

 The current state of the PatchJob.
 

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

Returns:

The state.

hasInstanceFilter

boolean hasInstanceFilter()

 Instances to patch.
 

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

Returns:

Whether the instanceFilter field is set.

getInstanceFilter

PatchJobs.PatchInstanceFilter getInstanceFilter()

 Instances to patch.
 

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

Returns:

The instanceFilter.

getInstanceFilterOrBuilder

PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()

 Instances to patch.
 

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

hasPatchConfig

boolean hasPatchConfig()

 Patch configuration being applied.
 

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

Returns:

Whether the patchConfig field is set.

getPatchConfig

PatchJobs.PatchConfig getPatchConfig()

 Patch configuration being applied.
 

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

Returns:

The patchConfig.

getPatchConfigOrBuilder

PatchJobs.PatchConfigOrBuilder getPatchConfigOrBuilder()

 Patch configuration being applied.
 

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

hasDuration

boolean hasDuration()

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

.google.protobuf.Duration duration = 8;

Returns:

Whether the duration field is set.

getDuration

com.google.protobuf.Duration getDuration()

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

.google.protobuf.Duration duration = 8;

Returns:

The duration.

getDurationOrBuilder

com.google.protobuf.DurationOrBuilder getDurationOrBuilder()

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

.google.protobuf.Duration duration = 8;

hasInstanceDetailsSummary

boolean hasInstanceDetailsSummary()

 Summary of instance details.
 

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

Returns:

Whether the instanceDetailsSummary field is set.

getInstanceDetailsSummary

PatchJobs.PatchJob.InstanceDetailsSummary getInstanceDetailsSummary()

 Summary of instance details.
 

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

Returns:

The instanceDetailsSummary.

getInstanceDetailsSummaryOrBuilder

PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder getInstanceDetailsSummaryOrBuilder()

 Summary of instance details.
 

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

getDryRun

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:

The dryRun.

getErrorMessage

String getErrorMessage()

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

string error_message = 11;

Returns:

The errorMessage.

getErrorMessageBytes

com.google.protobuf.ByteString getErrorMessageBytes()

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

string error_message = 11;

Returns:

The bytes for errorMessage.

getPercentComplete

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:

The percentComplete.

getPatchDeployment

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:

The patchDeployment.

getPatchDeploymentBytes

com.google.protobuf.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:

The bytes for patchDeployment.

hasRollout

boolean hasRollout()

 Rollout strategy being applied.
 

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

Returns:

Whether the rollout field is set.

getRollout

PatchJobs.PatchRollout getRollout()

 Rollout strategy being applied.
 

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

Returns:

The rollout.

getRolloutOrBuilder

PatchJobs.PatchRolloutOrBuilder getRolloutOrBuilder()

 Rollout strategy being applied.
 

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