Class PatchJobs.PatchJob

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. Instances 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.v1beta.PatchJob

Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

DRY_RUN_FIELD_NUMBER

public static final int DRY_RUN_FIELD_NUMBER
Field Value
TypeDescription
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_DETAILS_SUMMARY_FIELD_NUMBER

public static final int INSTANCE_DETAILS_SUMMARY_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_FILTER_FIELD_NUMBER

public static final int INSTANCE_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PATCH_CONFIG_FIELD_NUMBER

public static final int PATCH_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

PATCH_DEPLOYMENT_FIELD_NUMBER

public static final int PATCH_DEPLOYMENT_FIELD_NUMBER
Field Value
TypeDescription
int

PERCENT_COMPLETE_FIELD_NUMBER

public static final int PERCENT_COMPLETE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstance()

public static PatchJobs.PatchJob getDefaultInstance()
Returns
TypeDescription
PatchJobs.PatchJob

getDefaultInstanceForType()

public PatchJobs.PatchJob getDefaultInstanceForType()
Returns
TypeDescription
PatchJobs.PatchJob

getDescription()

public String getDescription()

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

string description = 2;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDisplayName()

public String getDisplayName()

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

string display_name = 14;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 14;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
DurationOrBuilder

getErrorMessage()

public String getErrorMessage()

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

string error_message = 11;

Returns
TypeDescription
String

The errorMessage.

getErrorMessageBytes()

public ByteString getErrorMessageBytes()

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

string error_message = 11;

Returns
TypeDescription
ByteString

The bytes for errorMessage.

getInstanceDetailsSummary()

public PatchJobs.PatchJob.InstanceDetailsSummary getInstanceDetailsSummary()

Summary of instance details.

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

Returns
TypeDescription
PatchJobs.PatchJob.InstanceDetailsSummary

The instanceDetailsSummary.

getInstanceDetailsSummaryOrBuilder()

public PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder getInstanceDetailsSummaryOrBuilder()

Summary of instance details.

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

Returns
TypeDescription
PatchJobs.PatchJob.InstanceDetailsSummaryOrBuilder

getInstanceFilter()

public PatchJobs.PatchInstanceFilter getInstanceFilter()

Instances to patch.

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

Returns
TypeDescription
PatchJobs.PatchInstanceFilter

The instanceFilter.

getInstanceFilterOrBuilder()

public PatchJobs.PatchInstanceFilterOrBuilder getInstanceFilterOrBuilder()

Instances to patch.

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

Returns
TypeDescription
PatchJobs.PatchInstanceFilterOrBuilder

getName()

public String getName()

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

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<PatchJobs.PatchJob> getParserForType()
Returns
TypeDescription
Parser<PatchJob>
Overrides

getPatchConfig()

public PatchJobs.PatchConfig getPatchConfig()

Patch configuration being applied.

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

Returns
TypeDescription
PatchJobs.PatchConfig

The patchConfig.

getPatchConfigOrBuilder()

public PatchJobs.PatchConfigOrBuilder getPatchConfigOrBuilder()

Patch configuration being applied.

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

Returns
TypeDescription
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];

Returns
TypeDescription
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];

Returns
TypeDescription
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
TypeDescription
double

The percentComplete.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public PatchJobs.PatchJob.State getState()

The current state of the PatchJob .

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

Returns
TypeDescription
PatchJobs.PatchJob.State

The state.

getStateValue()

public int getStateValue()

The current state of the PatchJob .

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Time this patch job was created.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the duration field is set.

hasInstanceDetailsSummary()

public boolean hasInstanceDetailsSummary()

Summary of instance details.

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

Returns
TypeDescription
boolean

Whether the instanceDetailsSummary field is set.

hasInstanceFilter()

public boolean hasInstanceFilter()

Instances to patch.

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

Returns
TypeDescription
boolean

Whether the instanceFilter field is set.

hasPatchConfig()

public boolean hasPatchConfig()

Patch configuration being applied.

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

Returns
TypeDescription
boolean

Whether the patchConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Last time this patch job was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static PatchJobs.PatchJob.Builder newBuilder()
Returns
TypeDescription
PatchJobs.PatchJob.Builder

newBuilder(PatchJobs.PatchJob prototype)

public static PatchJobs.PatchJob.Builder newBuilder(PatchJobs.PatchJob prototype)
Parameter
NameDescription
prototypePatchJobs.PatchJob
Returns
TypeDescription
PatchJobs.PatchJob.Builder

newBuilderForType()

public PatchJobs.PatchJob.Builder newBuilderForType()
Returns
TypeDescription
PatchJobs.PatchJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PatchJobs.PatchJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PatchJobs.PatchJob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static PatchJobs.PatchJob parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PatchJobs.PatchJob parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PatchJobs.PatchJob parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PatchJobs.PatchJob parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PatchJobs.PatchJob parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PatchJobs.PatchJob parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PatchJobs.PatchJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PatchJobs.PatchJob
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PatchJobs.PatchJob> parser()
Returns
TypeDescription
Parser<PatchJob>

toBuilder()

public PatchJobs.PatchJob.Builder toBuilder()
Returns
TypeDescription
PatchJobs.PatchJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException