public static final class PatchJobs.PatchJob extends com.google.protobuf.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](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).Protobuf type
google.cloud.osconfig.v1.PatchJob| Modifier and Type | Class and Description |
|---|---|
static class |
PatchJobs.PatchJob.Builder
A high level representation of a patch job that is either in progress
or has completed.
|
static class |
PatchJobs.PatchJob.InstanceDetailsSummary
A summary of the current patch state across all instances that this patch
job affects.
|
static interface |
PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder |
static class |
PatchJobs.PatchJob.State
Enumeration of the various states a patch job passes through as it
executes.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
DRY_RUN_FIELD_NUMBER |
static int |
DURATION_FIELD_NUMBER |
static int |
ERROR_MESSAGE_FIELD_NUMBER |
static int |
INSTANCE_DETAILS_SUMMARY_FIELD_NUMBER |
static int |
INSTANCE_FILTER_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PATCH_CONFIG_FIELD_NUMBER |
static int |
PATCH_DEPLOYMENT_FIELD_NUMBER |
static int |
PERCENT_COMPLETE_FIELD_NUMBER |
static int |
ROLLOUT_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
com.google.protobuf.Timestamp |
getCreateTime()
Time this patch job was created.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Time this patch job was created.
|
static PatchJobs.PatchJob |
getDefaultInstance() |
PatchJobs.PatchJob |
getDefaultInstanceForType() |
String |
getDescription()
Description of the patch job.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Description of the patch job.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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/*`
|
com.google.protobuf.Parser<PatchJobs.PatchJob> |
getParserForType() |
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.
|
int |
getSerializedSize() |
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.
|
int |
hashCode() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static PatchJobs.PatchJob.Builder |
newBuilder() |
static PatchJobs.PatchJob.Builder |
newBuilder(PatchJobs.PatchJob prototype) |
PatchJobs.PatchJob.Builder |
newBuilderForType() |
protected PatchJobs.PatchJob.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static PatchJobs.PatchJob |
parseDelimitedFrom(InputStream input) |
static PatchJobs.PatchJob |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PatchJobs.PatchJob |
parseFrom(byte[] data) |
static PatchJobs.PatchJob |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PatchJobs.PatchJob |
parseFrom(ByteBuffer data) |
static PatchJobs.PatchJob |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PatchJobs.PatchJob |
parseFrom(com.google.protobuf.ByteString data) |
static PatchJobs.PatchJob |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PatchJobs.PatchJob |
parseFrom(com.google.protobuf.CodedInputStream input) |
static PatchJobs.PatchJob |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static PatchJobs.PatchJob |
parseFrom(InputStream input) |
static PatchJobs.PatchJob |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<PatchJobs.PatchJob> |
parser() |
PatchJobs.PatchJob.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int INSTANCE_FILTER_FIELD_NUMBER
public static final int PATCH_CONFIG_FIELD_NUMBER
public static final int DURATION_FIELD_NUMBER
public static final int INSTANCE_DETAILS_SUMMARY_FIELD_NUMBER
public static final int DRY_RUN_FIELD_NUMBER
public static final int ERROR_MESSAGE_FIELD_NUMBER
public static final int PERCENT_COMPLETE_FIELD_NUMBER
public static final int PATCH_DEPLOYMENT_FIELD_NUMBER
public static final int ROLLOUT_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Unique identifier for this patch job in the form `projects/*/patchJobs/*`
string name = 1;getName in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Unique identifier for this patch job in the form `projects/*/patchJobs/*`
string name = 1;getNameBytes in interface PatchJobs.PatchJobOrBuilderpublic String getDisplayName()
Display name for this patch job. This is not a unique identifier.
string display_name = 14;getDisplayName in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Display name for this patch job. This is not a unique identifier.
string display_name = 14;getDisplayNameBytes in interface PatchJobs.PatchJobOrBuilderpublic String getDescription()
Description of the patch job. Length of the description is limited to 1024 characters.
string description = 2;getDescription in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Description of the patch job. Length of the description is limited to 1024 characters.
string description = 2;getDescriptionBytes in interface PatchJobs.PatchJobOrBuilderpublic boolean hasCreateTime()
Time this patch job was created.
.google.protobuf.Timestamp create_time = 3;hasCreateTime in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Time this patch job was created.
.google.protobuf.Timestamp create_time = 3;getCreateTime in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Time this patch job was created.
.google.protobuf.Timestamp create_time = 3;getCreateTimeOrBuilder in interface PatchJobs.PatchJobOrBuilderpublic boolean hasUpdateTime()
Last time this patch job was updated.
.google.protobuf.Timestamp update_time = 4;hasUpdateTime in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Last time this patch job was updated.
.google.protobuf.Timestamp update_time = 4;getUpdateTime in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Last time this patch job was updated.
.google.protobuf.Timestamp update_time = 4;getUpdateTimeOrBuilder in interface PatchJobs.PatchJobOrBuilderpublic int getStateValue()
The current state of the PatchJob.
.google.cloud.osconfig.v1.PatchJob.State state = 5;getStateValue in interface PatchJobs.PatchJobOrBuilderpublic PatchJobs.PatchJob.State getState()
The current state of the PatchJob.
.google.cloud.osconfig.v1.PatchJob.State state = 5;getState in interface PatchJobs.PatchJobOrBuilderpublic boolean hasInstanceFilter()
Instances to patch.
.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 13;hasInstanceFilter in interface PatchJobs.PatchJobOrBuilderpublic PatchJobs.PatchInstanceFilter getInstanceFilter()
Instances to patch.
.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 13;getInstanceFilter in interface PatchJobs.PatchJobOrBuilderpublic PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()
Instances to patch.
.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 13;getInstanceFilterOrBuilder in interface PatchJobs.PatchJobOrBuilderpublic boolean hasPatchConfig()
Patch configuration being applied.
.google.cloud.osconfig.v1.PatchConfig patch_config = 7;hasPatchConfig in interface PatchJobs.PatchJobOrBuilderpublic PatchJobs.PatchConfig getPatchConfig()
Patch configuration being applied.
.google.cloud.osconfig.v1.PatchConfig patch_config = 7;getPatchConfig in interface PatchJobs.PatchJobOrBuilderpublic PatchJobs.PatchConfigOrBuilder getPatchConfigOrBuilder()
Patch configuration being applied.
.google.cloud.osconfig.v1.PatchConfig patch_config = 7;getPatchConfigOrBuilder in interface PatchJobs.PatchJobOrBuilderpublic boolean hasDuration()
Duration of the patch job. After the duration ends, the patch job times out.
.google.protobuf.Duration duration = 8;hasDuration in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.Duration getDuration()
Duration of the patch job. After the duration ends, the patch job times out.
.google.protobuf.Duration duration = 8;getDuration in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
Duration of the patch job. After the duration ends, the patch job times out.
.google.protobuf.Duration duration = 8;getDurationOrBuilder in interface PatchJobs.PatchJobOrBuilderpublic boolean hasInstanceDetailsSummary()
Summary of instance details.
.google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary instance_details_summary = 9;
hasInstanceDetailsSummary in interface PatchJobs.PatchJobOrBuilderpublic PatchJobs.PatchJob.InstanceDetailsSummary getInstanceDetailsSummary()
Summary of instance details.
.google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary instance_details_summary = 9;
getInstanceDetailsSummary in interface PatchJobs.PatchJobOrBuilderpublic PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder getInstanceDetailsSummaryOrBuilder()
Summary of instance details.
.google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary instance_details_summary = 9;
getInstanceDetailsSummaryOrBuilder in interface PatchJobs.PatchJobOrBuilderpublic 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;getDryRun in interface PatchJobs.PatchJobOrBuilderpublic String getErrorMessage()
If this patch job failed, this message provides information about the failure.
string error_message = 11;getErrorMessage in interface PatchJobs.PatchJobOrBuilderpublic com.google.protobuf.ByteString getErrorMessageBytes()
If this patch job failed, this message provides information about the failure.
string error_message = 11;getErrorMessageBytes in interface PatchJobs.PatchJobOrBuilderpublic 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;getPercentComplete in interface PatchJobs.PatchJobOrBuilderpublic 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) = { ... }
getPatchDeployment in interface PatchJobs.PatchJobOrBuilderpublic 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) = { ... }
getPatchDeploymentBytes in interface PatchJobs.PatchJobOrBuilderpublic boolean hasRollout()
Rollout strategy being applied.
.google.cloud.osconfig.v1.PatchRollout rollout = 16;hasRollout in interface PatchJobs.PatchJobOrBuilderpublic PatchJobs.PatchRollout getRollout()
Rollout strategy being applied.
.google.cloud.osconfig.v1.PatchRollout rollout = 16;getRollout in interface PatchJobs.PatchJobOrBuilderpublic PatchJobs.PatchRolloutOrBuilder getRolloutOrBuilder()
Rollout strategy being applied.
.google.cloud.osconfig.v1.PatchRollout rollout = 16;getRolloutOrBuilder in interface PatchJobs.PatchJobOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static PatchJobs.PatchJob parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PatchJobs.PatchJob parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PatchJobs.PatchJob parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PatchJobs.PatchJob parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PatchJobs.PatchJob parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PatchJobs.PatchJob parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PatchJobs.PatchJob parseFrom(InputStream input) throws IOException
IOExceptionpublic static PatchJobs.PatchJob parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static PatchJobs.PatchJob parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static PatchJobs.PatchJob parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static PatchJobs.PatchJob parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static PatchJobs.PatchJob parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic PatchJobs.PatchJob.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static PatchJobs.PatchJob.Builder newBuilder()
public static PatchJobs.PatchJob.Builder newBuilder(PatchJobs.PatchJob prototype)
public PatchJobs.PatchJob.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected PatchJobs.PatchJob.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static PatchJobs.PatchJob getDefaultInstance()
public static com.google.protobuf.Parser<PatchJobs.PatchJob> parser()
public com.google.protobuf.Parser<PatchJobs.PatchJob> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public PatchJobs.PatchJob getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.