Class PatchJobs.PatchJob (2.55.0)

Version latest

• 2.55.0 (latest)
• 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 final class PatchJobs.PatchJob extends GeneratedMessageV3 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.v1.PatchJob

Inheritance

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

Implements

PatchJobs.PatchJobOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

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

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER

Field Value
Type	Description
int

INSTANCE_DETAILS_SUMMARY_FIELD_NUMBER

public static final int INSTANCE_DETAILS_SUMMARY_FIELD_NUMBER

Field Value
Type	Description
int

INSTANCE_FILTER_FIELD_NUMBER

public static final int INSTANCE_FILTER_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

PATCH_CONFIG_FIELD_NUMBER

public static final int PATCH_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

PATCH_DEPLOYMENT_FIELD_NUMBER

public static final int PATCH_DEPLOYMENT_FIELD_NUMBER

Field Value
Type	Description
int

PERCENT_COMPLETE_FIELD_NUMBER

public static final int PERCENT_COMPLETE_FIELD_NUMBER

Field Value
Type	Description
int

ROLLOUT_FIELD_NUMBER

public static final int ROLLOUT_FIELD_NUMBER

Field Value
Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static PatchJobs.PatchJob getDefaultInstance()

Returns
Type	Description
PatchJobs.PatchJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static PatchJobs.PatchJob.Builder newBuilder()

Returns
Type	Description
PatchJobs.PatchJob.Builder

newBuilder(PatchJobs.PatchJob prototype)

public static PatchJobs.PatchJob.Builder newBuilder(PatchJobs.PatchJob prototype)

Parameter
Name	Description
prototype	PatchJobs.PatchJob

Returns
Type	Description
PatchJobs.PatchJob.Builder

parseDelimitedFrom(InputStream input)

public static PatchJobs.PatchJob parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static PatchJobs.PatchJob parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PatchJobs.PatchJob parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PatchJobs.PatchJob parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static PatchJobs.PatchJob parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static PatchJobs.PatchJob parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PatchJobs.PatchJob

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<PatchJobs.PatchJob> parser()

Returns
Type	Description
Parser<PatchJob>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCreateTime()

public Timestamp getCreateTime()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public PatchJobs.PatchJob getDefaultInstanceForType()

Returns
Type	Description
PatchJobs.PatchJob

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 is not a unique identifier.

string display_name = 14;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public 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 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 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 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 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 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 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 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 PatchJobs.PatchInstanceFilter getInstanceFilter()

Instances to patch.

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

Returns
Type	Description
PatchJobs.PatchInstanceFilter	The instanceFilter.

getInstanceFilterOrBuilder()

public PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()

Instances to patch.

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

Returns
Type	Description
PatchJobs.PatchInstanceFilterOrBuilder

getName()

public String getName()

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

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<PatchJobs.PatchJob> getParserForType()

Returns
Type	Description
Parser<PatchJob>

Overrides

GeneratedMessageV3.getParserForType()

getPatchConfig()

public PatchJobs.PatchConfig getPatchConfig()

Patch configuration being applied.

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

Returns
Type	Description
PatchJobs.PatchConfig	The patchConfig.

getPatchConfigOrBuilder()

public PatchJobs.PatchConfigOrBuilder getPatchConfigOrBuilder()

Patch configuration being applied.

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

Returns
Type	Description
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, (.google.api.resource_reference) = { ... }

Returns
Type	Description
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, (.google.api.resource_reference) = { ... }

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

getRollout()

public PatchJobs.PatchRollout getRollout()

Rollout strategy being applied.

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

Returns
Type	Description
PatchJobs.PatchRollout	The rollout.

getRolloutOrBuilder()

public PatchJobs.PatchRolloutOrBuilder getRolloutOrBuilder()

Rollout strategy being applied.

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

Returns
Type	Description
PatchJobs.PatchRolloutOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getState()

public 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 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 Timestamp getUpdateTime()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

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

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public PatchJobs.PatchJob.Builder newBuilderForType()

Returns
Type	Description
PatchJobs.PatchJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchJobs.PatchJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
PatchJobs.PatchJob.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public PatchJobs.PatchJob.Builder toBuilder()

Returns
Type	Description
PatchJobs.PatchJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException