View Source GoogleApi.OSConfig.V1.Model.PatchJob (google_api_os_config v0.20.0)

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.


  • createTime (type: DateTime.t, default: nil) - Time this patch job was created.
  • description (type: String.t, default: nil) - Description of the patch job. Length of the description is limited to 1024 characters.
  • displayName (type: String.t, default: nil) - Display name for this patch job. This is not a unique identifier.
  • dryRun (type: boolean(), default: nil) - If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.
  • duration (type: String.t, default: nil) - Duration of the patch job. After the duration ends, the patch job times out.
  • errorMessage (type: String.t, default: nil) - If this patch job failed, this message provides information about the failure.
  • instanceDetailsSummary (type: GoogleApi.OSConfig.V1.Model.PatchJobInstanceDetailsSummary.t, default: nil) - Summary of instance details.
  • instanceFilter (type: GoogleApi.OSConfig.V1.Model.PatchInstanceFilter.t, default: nil) - Instances to patch.
  • name (type: String.t, default: nil) - Unique identifier for this patch job in the form projects/*/patchJobs/*
  • patchConfig (type: GoogleApi.OSConfig.V1.Model.PatchConfig.t, default: nil) - Patch configuration being applied.
  • patchDeployment (type: String.t, default: nil) - Output only. Name of the patch deployment that created this patch job.
  • percentComplete (type: float(), default: nil) - Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.
  • rollout (type: GoogleApi.OSConfig.V1.Model.PatchRollout.t, default: nil) - Rollout strategy being applied.
  • state (type: String.t, default: nil) - The current state of the PatchJob.
  • updateTime (type: DateTime.t, default: nil) - Last time this patch job was updated.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.OSConfig.V1.Model.PatchJob{
  createTime: DateTime.t() | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  dryRun: boolean() | nil,
  duration: String.t() | nil,
  errorMessage: String.t() | nil,
    GoogleApi.OSConfig.V1.Model.PatchJobInstanceDetailsSummary.t() | nil,
  instanceFilter: GoogleApi.OSConfig.V1.Model.PatchInstanceFilter.t() | nil,
  name: String.t() | nil,
  patchConfig: GoogleApi.OSConfig.V1.Model.PatchConfig.t() | nil,
  patchDeployment: String.t() | nil,
  percentComplete: float() | nil,
  rollout: GoogleApi.OSConfig.V1.Model.PatchRollout.t() | nil,
  state: String.t() | nil,
  updateTime: DateTime.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.