Package com.google.cloud.osconfig.v1beta

Class PatchJobs.PatchJob

  • All Implemented Interfaces:
    PatchJobs.PatchJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    PatchJobs
    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.v1beta.PatchJob
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Unique identifier for this patch job in the form
 `projects/*/patchJobs/*`
        string name = 1;
        Specified by:
        getName in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Unique identifier for this patch job in the form
 `projects/*/patchJobs/*`
        string name = 1;
        Specified by:
        getNameBytes in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Display name for this patch job. This is not a unique identifier.
        string display_name = 14;
        Specified by:
        getDisplayName in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Display name for this patch job. This is not a unique identifier.
        string display_name = 14;
        Specified by:
        getDisplayNameBytes in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         Description of the patch job. Length of the description is limited
 to 1024 characters.
        string description = 2;
        Specified by:
        getDescription in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Description of the patch job. Length of the description is limited
 to 1024 characters.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The bytes for description.

      • hasCreateTime

        public boolean hasCreateTime()
         Time this patch job was created.
        .google.protobuf.Timestamp create_time = 3;
        Specified by:
        hasCreateTime in interface PatchJobs.PatchJobOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Time this patch job was created.
        .google.protobuf.Timestamp create_time = 3;
        Specified by:
        getCreateTime in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Time this patch job was created.
        .google.protobuf.Timestamp create_time = 3;
        Specified by:
        getCreateTimeOrBuilder in interface PatchJobs.PatchJobOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Last time this patch job was updated.
        .google.protobuf.Timestamp update_time = 4;
        Specified by:
        hasUpdateTime in interface PatchJobs.PatchJobOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Last time this patch job was updated.
        .google.protobuf.Timestamp update_time = 4;
        Specified by:
        getUpdateTime in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Last time this patch job was updated.
        .google.protobuf.Timestamp update_time = 4;
        Specified by:
        getUpdateTimeOrBuilder in interface PatchJobs.PatchJobOrBuilder

      • getStateValue

        public int getStateValue()
         The current state of the PatchJob.
        .google.cloud.osconfig.v1beta.PatchJob.State state = 5;
        Specified by:
        getStateValue in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • hasInstanceFilter

        public boolean hasInstanceFilter()
         Instances to patch.
        .google.cloud.osconfig.v1beta.PatchInstanceFilter instance_filter = 13;
        Specified by:
        hasInstanceFilter in interface PatchJobs.PatchJobOrBuilder
        Returns:
        Whether the instanceFilter field is set.

      • hasPatchConfig

        public boolean hasPatchConfig()
         Patch configuration being applied.
        .google.cloud.osconfig.v1beta.PatchConfig patch_config = 7;
        Specified by:
        hasPatchConfig in interface PatchJobs.PatchJobOrBuilder
        Returns:
        Whether the patchConfig 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;
        Specified by:
        hasDuration in interface PatchJobs.PatchJobOrBuilder
        Returns:
        Whether the duration field is set.

      • getDuration

        public com.google.protobuf.Duration getDuration()
         Duration of the patch job. After the duration ends, the
 patch job times out.
        .google.protobuf.Duration duration = 8;
        Specified by:
        getDuration in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The duration.

      • getDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
         Duration of the patch job. After the duration ends, the
 patch job times out.
        .google.protobuf.Duration duration = 8;
        Specified by:
        getDurationOrBuilder in interface PatchJobs.PatchJobOrBuilder

      • hasInstanceDetailsSummary

        public boolean hasInstanceDetailsSummary()
         Summary of instance details.
        .google.cloud.osconfig.v1beta.PatchJob.InstanceDetailsSummary instance_details_summary = 9;
        Specified by:
        hasInstanceDetailsSummary in interface PatchJobs.PatchJobOrBuilder
        Returns:
        Whether the instanceDetailsSummary field is set.

      • 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;
        Specified by:
        getDryRun in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The dryRun.

      • getErrorMessage

        public String getErrorMessage()
         If this patch job failed, this message provides information about the
 failure.
        string error_message = 11;
        Specified by:
        getErrorMessage in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The errorMessage.

      • getErrorMessageBytes

        public com.google.protobuf.ByteString getErrorMessageBytes()
         If this patch job failed, this message provides information about the
 failure.
        string error_message = 11;
        Specified by:
        getErrorMessageBytes in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The bytes for errorMessage.

      • 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;
        Specified by:
        getPercentComplete in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The percentComplete.

      • 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];
        Specified by:
        getPatchDeployment in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The patchDeployment.

      • getPatchDeploymentBytes

        public 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];
        Specified by:
        getPatchDeploymentBytes in interface PatchJobs.PatchJobOrBuilder
        Returns:
        The bytes for patchDeployment.

      • hasRollout

        public boolean hasRollout()
         Rollout strategy being applied.
        .google.cloud.osconfig.v1beta.PatchRollout rollout = 16;
        Specified by:
        hasRollout in interface PatchJobs.PatchJobOrBuilder
        Returns:
        Whether the rollout field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PatchJobs.PatchJob parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PatchJobs.PatchJob parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PatchJobs.PatchJob parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PatchJobs.PatchJob parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PatchJobs.PatchJob parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PatchJobs.PatchJob parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PatchJobs.PatchJob parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public PatchJobs.PatchJob.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public PatchJobs.PatchJob.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected PatchJobs.PatchJob.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<PatchJobs.PatchJob> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public PatchJobs.PatchJob getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder