public sealed class PatchJob : IMessage<PatchJob>, IEquatable<PatchJob>, IDeepCloneable<PatchJob>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud OS Config v1 API class PatchJob.
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.
Namespace
Google.Cloud.OsConfig.V1Assembly
Google.Cloud.OsConfig.V1.dll
Constructors
PatchJob()
public PatchJob()
PatchJob(PatchJob)
public PatchJob(PatchJob other)
Parameter | |
---|---|
Name | Description |
other |
PatchJob |
Properties
CreateTime
public Timestamp CreateTime { get; set; }
Time this patch job was created.
Property Value | |
---|---|
Type | Description |
Timestamp |
Description
public string Description { get; set; }
Description of the patch job. Length of the description is limited to 1024 characters.
Property Value | |
---|---|
Type | Description |
string |
DisplayName
public string DisplayName { get; set; }
Display name for this patch job. This is not a unique identifier.
Property Value | |
---|---|
Type | Description |
string |
DryRun
public bool DryRun { get; set; }
If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
Property Value | |
---|---|
Type | Description |
bool |
Duration
public Duration Duration { get; set; }
Duration of the patch job. After the duration ends, the patch job times out.
Property Value | |
---|---|
Type | Description |
Duration |
ErrorMessage
public string ErrorMessage { get; set; }
If this patch job failed, this message provides information about the failure.
Property Value | |
---|---|
Type | Description |
string |
InstanceDetailsSummary
public PatchJob.Types.InstanceDetailsSummary InstanceDetailsSummary { get; set; }
Summary of instance details.
Property Value | |
---|---|
Type | Description |
PatchJobTypesInstanceDetailsSummary |
InstanceFilter
public PatchInstanceFilter InstanceFilter { get; set; }
Instances to patch.
Property Value | |
---|---|
Type | Description |
PatchInstanceFilter |
Name
public string Name { get; set; }
Unique identifier for this patch job in the form
projects/*/patchJobs/*
Property Value | |
---|---|
Type | Description |
string |
PatchConfig
public PatchConfig PatchConfig { get; set; }
Patch configuration being applied.
Property Value | |
---|---|
Type | Description |
PatchConfig |
PatchDeployment
public string PatchDeployment { get; set; }
Output only. Name of the patch deployment that created this patch job.
Property Value | |
---|---|
Type | Description |
string |
PatchDeploymentAsPatchDeploymentName
public PatchDeploymentName PatchDeploymentAsPatchDeploymentName { get; set; }
PatchDeploymentName-typed view over the PatchDeployment resource name property.
Property Value | |
---|---|
Type | Description |
PatchDeploymentName |
PatchJobName
public PatchJobName PatchJobName { get; set; }
PatchJobName-typed view over the Name resource name property.
Property Value | |
---|---|
Type | Description |
PatchJobName |
PercentComplete
public double PercentComplete { get; set; }
Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
Property Value | |
---|---|
Type | Description |
double |
Rollout
public PatchRollout Rollout { get; set; }
Rollout strategy being applied.
Property Value | |
---|---|
Type | Description |
PatchRollout |
State
public PatchJob.Types.State State { get; set; }
The current state of the PatchJob.
Property Value | |
---|---|
Type | Description |
PatchJobTypesState |
UpdateTime
public Timestamp UpdateTime { get; set; }
Last time this patch job was updated.
Property Value | |
---|---|
Type | Description |
Timestamp |