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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PatchJobs.PatchJob.Builder newBuilder()
newBuilder(PatchJobs.PatchJob prototype)
public static PatchJobs.PatchJob.Builder newBuilder(PatchJobs.PatchJob prototype)
public static PatchJobs.PatchJob parseDelimitedFrom(InputStream input)
public static PatchJobs.PatchJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PatchJobs.PatchJob parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PatchJobs.PatchJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PatchJobs.PatchJob parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PatchJobs.PatchJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PatchJobs.PatchJob parseFrom(CodedInputStream input)
public static PatchJobs.PatchJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PatchJobs.PatchJob parseFrom(InputStream input)
public static PatchJobs.PatchJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PatchJobs.PatchJob parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PatchJobs.PatchJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PatchJobs.PatchJob> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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;
getDefaultInstanceForType()
public PatchJobs.PatchJob getDefaultInstanceForType()
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;
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;
getInstanceDetailsSummaryOrBuilder()
public PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder getInstanceDetailsSummaryOrBuilder()
Summary of instance details.
.google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary instance_details_summary = 9;
getInstanceFilter()
public PatchJobs.PatchInstanceFilter getInstanceFilter()
Instances to patch.
.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 13;
getInstanceFilterOrBuilder()
public PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()
Instances to patch.
.google.cloud.osconfig.v1.PatchInstanceFilter instance_filter = 13;
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()
Overrides
getPatchConfig()
public PatchJobs.PatchConfig getPatchConfig()
Patch configuration being applied.
.google.cloud.osconfig.v1.PatchConfig patch_config = 7;
getPatchConfigOrBuilder()
public PatchJobs.PatchConfigOrBuilder getPatchConfigOrBuilder()
Patch configuration being applied.
.google.cloud.osconfig.v1.PatchConfig patch_config = 7;
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;
getRolloutOrBuilder()
public PatchJobs.PatchRolloutOrBuilder getRolloutOrBuilder()
Rollout strategy being applied.
.google.cloud.osconfig.v1.PatchRollout rollout = 16;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getState()
public PatchJobs.PatchJob.State getState()
The current state of the PatchJob.
.google.cloud.osconfig.v1.PatchJob.State state = 5;
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;
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PatchJobs.PatchJob.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PatchJobs.PatchJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public PatchJobs.PatchJob.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
