| { |
| "resources": { |
| "projects": { |
| "resources": { |
| "patchDeployments": { |
| "methods": { |
| "get": { |
| "parameters": { |
| "name": { |
| "pattern": "^projects/[^/]+/patchDeployments/[^/]+$", |
| "description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.", |
| "location": "path", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "id": "osconfig.projects.patchDeployments.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "PatchDeployment" |
| }, |
| "path": "v1/{+name}", |
| "flatPath": "v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "description": "Get an OS Config patch deployment.", |
| "httpMethod": "GET" |
| }, |
| "delete": { |
| "response": { |
| "$ref": "Empty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameterOrder": [ |
| "name" |
| ], |
| "id": "osconfig.projects.patchDeployments.delete", |
| "httpMethod": "DELETE", |
| "parameters": { |
| "name": { |
| "pattern": "^projects/[^/]+/patchDeployments/[^/]+$", |
| "required": true, |
| "description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.", |
| "type": "string", |
| "location": "path" |
| } |
| }, |
| "path": "v1/{+name}", |
| "description": "Delete an OS Config patch deployment.", |
| "flatPath": "v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}" |
| }, |
| "list": { |
| "flatPath": "v1/projects/{projectsId}/patchDeployments", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameterOrder": [ |
| "parent" |
| ], |
| "id": "osconfig.projects.patchDeployments.list", |
| "response": { |
| "$ref": "ListPatchDeploymentsResponse" |
| }, |
| "description": "Get a page of OS Config patch deployments.", |
| "parameters": { |
| "parent": { |
| "type": "string", |
| "pattern": "^projects/[^/]+$", |
| "description": "Required. The resource name of the parent in the form `projects/*`.", |
| "location": "path", |
| "required": true |
| }, |
| "pageSize": { |
| "description": "Optional. The maximum number of patch deployments to return. Default is 100.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "type": "string", |
| "description": "Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.", |
| "location": "query" |
| } |
| }, |
| "httpMethod": "GET", |
| "path": "v1/{+parent}/patchDeployments" |
| }, |
| "create": { |
| "request": { |
| "$ref": "PatchDeployment" |
| }, |
| "httpMethod": "POST", |
| "description": "Create an OS Config patch deployment.", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "flatPath": "v1/projects/{projectsId}/patchDeployments", |
| "path": "v1/{+parent}/patchDeployments", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "id": "osconfig.projects.patchDeployments.create", |
| "parameters": { |
| "patchDeploymentId": { |
| "description": "Required. A name for the patch deployment in the project. When creating a name the following rules apply: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.", |
| "type": "string", |
| "location": "query" |
| }, |
| "parent": { |
| "description": "Required. The project to apply this patch deployment to in the form `projects/*`.", |
| "location": "path", |
| "pattern": "^projects/[^/]+$", |
| "type": "string", |
| "required": true |
| } |
| }, |
| "response": { |
| "$ref": "PatchDeployment" |
| } |
| } |
| } |
| }, |
| "patchJobs": { |
| "methods": { |
| "get": { |
| "parameters": { |
| "name": { |
| "location": "path", |
| "description": "Required. Name of the patch in the form `projects/*/patchJobs/*`", |
| "type": "string", |
| "pattern": "^projects/[^/]+/patchJobs/[^/]+$", |
| "required": true |
| } |
| }, |
| "description": "Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.", |
| "id": "osconfig.projects.patchJobs.get", |
| "flatPath": "v1/projects/{projectsId}/patchJobs/{patchJobsId}", |
| "httpMethod": "GET", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "response": { |
| "$ref": "PatchJob" |
| }, |
| "path": "v1/{+name}", |
| "parameterOrder": [ |
| "name" |
| ] |
| }, |
| "cancel": { |
| "request": { |
| "$ref": "CancelPatchJobRequest" |
| }, |
| "path": "v1/{+name}:cancel", |
| "description": "Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.", |
| "httpMethod": "POST", |
| "response": { |
| "$ref": "PatchJob" |
| }, |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the patch in the form `projects/*/patchJobs/*`", |
| "type": "string", |
| "pattern": "^projects/[^/]+/patchJobs/[^/]+$", |
| "required": true, |
| "location": "path" |
| } |
| }, |
| "flatPath": "v1/projects/{projectsId}/patchJobs/{patchJobsId}:cancel", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "id": "osconfig.projects.patchJobs.cancel", |
| "parameterOrder": [ |
| "name" |
| ] |
| }, |
| "list": { |
| "parameterOrder": [ |
| "parent" |
| ], |
| "id": "osconfig.projects.patchJobs.list", |
| "flatPath": "v1/projects/{projectsId}/patchJobs", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "path": "v1/{+parent}/patchJobs", |
| "parameters": { |
| "pageToken": { |
| "description": "A pagination token returned from a previous call that indicates where this listing should continue from.", |
| "type": "string", |
| "location": "query" |
| }, |
| "parent": { |
| "type": "string", |
| "location": "path", |
| "required": true, |
| "description": "Required. In the form of `projects/*`", |
| "pattern": "^projects/[^/]+$" |
| }, |
| "pageSize": { |
| "type": "integer", |
| "location": "query", |
| "format": "int32", |
| "description": "The maximum number of instance status to return." |
| }, |
| "filter": { |
| "location": "query", |
| "description": "If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.", |
| "type": "string" |
| } |
| }, |
| "httpMethod": "GET", |
| "response": { |
| "$ref": "ListPatchJobsResponse" |
| }, |
| "description": "Get a list of patch jobs." |
| }, |
| "execute": { |
| "httpMethod": "POST", |
| "id": "osconfig.projects.patchJobs.execute", |
| "path": "v1/{+parent}/patchJobs:execute", |
| "flatPath": "v1/projects/{projectsId}/patchJobs:execute", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "required": true, |
| "type": "string", |
| "location": "path", |
| "pattern": "^projects/[^/]+$", |
| "description": "Required. The project in which to run this patch in the form `projects/*`" |
| } |
| }, |
| "response": { |
| "$ref": "PatchJob" |
| }, |
| "description": "Patch VM instances by creating and running a patch job.", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "request": { |
| "$ref": "ExecutePatchJobRequest" |
| } |
| } |
| }, |
| "resources": { |
| "instanceDetails": { |
| "methods": { |
| "list": { |
| "parameters": { |
| "pageSize": { |
| "description": "The maximum number of instance details records to return. Default is 100.", |
| "type": "integer", |
| "format": "int32", |
| "location": "query" |
| }, |
| "pageToken": { |
| "type": "string", |
| "description": "A pagination token returned from a previous call that indicates where this listing should continue from.", |
| "location": "query" |
| }, |
| "filter": { |
| "description": "A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`.", |
| "type": "string", |
| "location": "query" |
| }, |
| "parent": { |
| "required": true, |
| "description": "Required. The parent for the instances are in the form of `projects/*/patchJobs/*`.", |
| "type": "string", |
| "location": "path", |
| "pattern": "^projects/[^/]+/patchJobs/[^/]+$" |
| } |
| }, |
| "parameterOrder": [ |
| "parent" |
| ], |
| "response": { |
| "$ref": "ListPatchJobInstanceDetailsResponse" |
| }, |
| "httpMethod": "GET", |
| "description": "Get a list of instance details for a given patch job.", |
| "flatPath": "v1/projects/{projectsId}/patchJobs/{patchJobsId}/instanceDetails", |
| "path": "v1/{+parent}/instanceDetails", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "id": "osconfig.projects.patchJobs.instanceDetails.list" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "parameters": { |
| "fields": { |
| "location": "query", |
| "description": "Selector specifying which fields to include in a partial response.", |
| "type": "string" |
| }, |
| "key": { |
| "type": "string", |
| "location": "query", |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." |
| }, |
| "$.xgafv": { |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "type": "string", |
| "description": "V1 error format.", |
| "location": "query", |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ] |
| }, |
| "alt": { |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "type": "string", |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "description": "Data format for response.", |
| "location": "query", |
| "default": "json" |
| }, |
| "callback": { |
| "location": "query", |
| "type": "string", |
| "description": "JSONP" |
| }, |
| "quotaUser": { |
| "type": "string", |
| "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
| "location": "query" |
| }, |
| "access_token": { |
| "location": "query", |
| "type": "string", |
| "description": "OAuth access token." |
| }, |
| "uploadType": { |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| }, |
| "upload_protocol": { |
| "location": "query", |
| "type": "string", |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." |
| }, |
| "prettyPrint": { |
| "description": "Returns response with indentations and line breaks.", |
| "location": "query", |
| "type": "boolean", |
| "default": "true" |
| }, |
| "oauth_token": { |
| "location": "query", |
| "description": "OAuth 2.0 token for the current user.", |
| "type": "string" |
| } |
| }, |
| "revision": "20201112", |
| "documentationLink": "https://cloud.google.com/compute/docs/manage-os", |
| "rootUrl": "https://osconfig.googleapis.com/", |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| } |
| } |
| } |
| }, |
| "canonicalName": "OS Config", |
| "mtlsRootUrl": "https://osconfig.mtls.googleapis.com/", |
| "title": "OS Config API", |
| "schemas": { |
| "PatchInstanceFilter": { |
| "id": "PatchInstanceFilter", |
| "type": "object", |
| "properties": { |
| "instanceNamePrefixes": { |
| "items": { |
| "type": "string" |
| }, |
| "description": "Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix=\"prod-\".", |
| "type": "array" |
| }, |
| "zones": { |
| "description": "Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "groupLabels": { |
| "description": "Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances.", |
| "type": "array", |
| "items": { |
| "$ref": "PatchInstanceFilterGroupLabel" |
| } |
| }, |
| "all": { |
| "description": "Target all VM instances in the project. If true, no other criteria is permitted.", |
| "type": "boolean" |
| }, |
| "instances": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "description": "Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`, `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`" |
| } |
| }, |
| "description": "A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones." |
| }, |
| "InventorySoftwarePackage": { |
| "type": "object", |
| "id": "InventorySoftwarePackage", |
| "description": "Software package information of the operating system.", |
| "properties": { |
| "zypperPatch": { |
| "$ref": "InventoryZypperPatch", |
| "description": "Details of a Zypper patch. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual." |
| }, |
| "wuaPackage": { |
| "$ref": "InventoryWindowsUpdatePackage", |
| "description": "Details of a Windows Update package. See https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for information about Windows Update." |
| }, |
| "aptPackage": { |
| "$ref": "InventoryVersionedPackage", |
| "description": "Details of an APT package. For details about the apt package manager, see https://wiki.debian.org/Apt." |
| }, |
| "yumPackage": { |
| "description": "Yum package info. For details about the yum package manager, see https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum.", |
| "$ref": "InventoryVersionedPackage" |
| }, |
| "zypperPackage": { |
| "$ref": "InventoryVersionedPackage", |
| "description": "Details of a Zypper package. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual." |
| }, |
| "qfePackage": { |
| "description": "Details of a Windows Quick Fix engineering package. See https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering for info in Windows Quick Fix Engineering.", |
| "$ref": "InventoryWindowsQuickFixEngineeringPackage" |
| }, |
| "cosPackage": { |
| "description": "Details of a COS package.", |
| "$ref": "InventoryVersionedPackage" |
| }, |
| "googetPackage": { |
| "$ref": "InventoryVersionedPackage", |
| "description": "Details of a Googet package. For details about the googet package manager, see https://github.com/google/googet." |
| } |
| } |
| }, |
| "InventoryWindowsUpdatePackageWindowsUpdateCategory": { |
| "type": "object", |
| "description": "Categories specified by the Windows Update.", |
| "id": "InventoryWindowsUpdatePackageWindowsUpdateCategory", |
| "properties": { |
| "id": { |
| "description": "The identifier of the windows update category.", |
| "type": "string" |
| }, |
| "name": { |
| "type": "string", |
| "description": "The name of the windows update category." |
| } |
| } |
| }, |
| "GooSettings": { |
| "id": "GooSettings", |
| "properties": {}, |
| "description": "Googet patching is performed by running `googet update`.", |
| "type": "object" |
| }, |
| "ZypperSettings": { |
| "description": "Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual.", |
| "properties": { |
| "withOptional": { |
| "type": "boolean", |
| "description": "Adds the `--with-optional` flag to `zypper patch`." |
| }, |
| "withUpdate": { |
| "description": "Adds the `--with-update` flag, to `zypper patch`.", |
| "type": "boolean" |
| }, |
| "severities": { |
| "items": { |
| "type": "string" |
| }, |
| "type": "array", |
| "description": "Install only patches with these severities. Common severities include critical, important, moderate, and low." |
| }, |
| "categories": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "description": "Install only patches with these categories. Common categories include security, recommended, and feature." |
| }, |
| "exclusivePatches": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "description": "An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields." |
| }, |
| "excludes": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "description": "List of patches to exclude from update." |
| } |
| }, |
| "type": "object", |
| "id": "ZypperSettings" |
| }, |
| "AptSettings": { |
| "properties": { |
| "excludes": { |
| "type": "array", |
| "description": "List of packages to exclude from update. These packages will be excluded", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "type": { |
| "type": "string", |
| "enumDescriptions": [ |
| "By default, upgrade will be performed.", |
| "Runs `apt-get dist-upgrade`.", |
| "Runs `apt-get upgrade`." |
| ], |
| "description": "By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.", |
| "enum": [ |
| "TYPE_UNSPECIFIED", |
| "DIST", |
| "UPGRADE" |
| ] |
| }, |
| "exclusivePackages": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "description": "An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields." |
| } |
| }, |
| "description": "Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed.", |
| "type": "object", |
| "id": "AptSettings" |
| }, |
| "ListPatchDeploymentsResponse": { |
| "description": "A response message for listing patch deployments.", |
| "type": "object", |
| "properties": { |
| "patchDeployments": { |
| "items": { |
| "$ref": "PatchDeployment" |
| }, |
| "description": "The list of patch deployments.", |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "A pagination token that can be used to get the next page of patch deployments.", |
| "type": "string" |
| } |
| }, |
| "id": "ListPatchDeploymentsResponse" |
| }, |
| "WeekDayOfMonth": { |
| "type": "object", |
| "description": "Represents one week day in a month. An example is \"the 4th Sunday\".", |
| "id": "WeekDayOfMonth", |
| "properties": { |
| "dayOfWeek": { |
| "description": "Required. A day of the week.", |
| "enumDescriptions": [ |
| "The day of the week is unspecified.", |
| "Monday", |
| "Tuesday", |
| "Wednesday", |
| "Thursday", |
| "Friday", |
| "Saturday", |
| "Sunday" |
| ], |
| "enum": [ |
| "DAY_OF_WEEK_UNSPECIFIED", |
| "MONDAY", |
| "TUESDAY", |
| "WEDNESDAY", |
| "THURSDAY", |
| "FRIDAY", |
| "SATURDAY", |
| "SUNDAY" |
| ], |
| "type": "string" |
| }, |
| "weekOrdinal": { |
| "format": "int32", |
| "description": "Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month.", |
| "type": "integer" |
| } |
| } |
| }, |
| "PatchRollout": { |
| "type": "object", |
| "description": "Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.", |
| "id": "PatchRollout", |
| "properties": { |
| "mode": { |
| "type": "string", |
| "description": "Mode of the patch rollout.", |
| "enum": [ |
| "MODE_UNSPECIFIED", |
| "ZONE_BY_ZONE", |
| "CONCURRENT_ZONES" |
| ], |
| "enumDescriptions": [ |
| "Mode must be specified.", |
| "Patches are applied one zone at a time. The patch job begins in the region with the lowest number of targeted VMs. Within the region, patching begins in the zone with the lowest number of targeted VMs. If multiple regions (or zones within a region) have the same number of targeted VMs, a tie-breaker is achieved by sorting the regions or zones in alphabetical order.", |
| "Patches are applied to VMs in all zones at the same time." |
| ] |
| }, |
| "disruptionBudget": { |
| "description": "The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of `10`, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops.", |
| "$ref": "FixedOrPercent" |
| } |
| } |
| }, |
| "TimeZone": { |
| "type": "object", |
| "id": "TimeZone", |
| "properties": { |
| "version": { |
| "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", |
| "type": "string" |
| }, |
| "id": { |
| "type": "string", |
| "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\"." |
| } |
| }, |
| "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones)." |
| }, |
| "PatchConfig": { |
| "id": "PatchConfig", |
| "type": "object", |
| "properties": { |
| "goo": { |
| "description": "Goo update settings. Use this setting to override the default `goo` patch rules.", |
| "$ref": "GooSettings" |
| }, |
| "rebootConfig": { |
| "enumDescriptions": [ |
| "The default behavior is DEFAULT.", |
| "The agent decides if a reboot is necessary by checking signals such as registry keys on Windows or `/var/run/reboot-required` on APT based systems. On RPM based systems, a set of core system package install times are compared with system boot time.", |
| "Always reboot the machine after the update completes.", |
| "Never reboot the machine after the update completes." |
| ], |
| "type": "string", |
| "enum": [ |
| "REBOOT_CONFIG_UNSPECIFIED", |
| "DEFAULT", |
| "ALWAYS", |
| "NEVER" |
| ], |
| "description": "Post-patch reboot settings." |
| }, |
| "apt": { |
| "$ref": "AptSettings", |
| "description": "Apt update settings. Use this setting to override the default `apt` patch rules." |
| }, |
| "zypper": { |
| "description": "Zypper update settings. Use this setting to override the default `zypper` patch rules.", |
| "$ref": "ZypperSettings" |
| }, |
| "yum": { |
| "$ref": "YumSettings", |
| "description": "Yum update settings. Use this setting to override the default `yum` patch rules." |
| }, |
| "windowsUpdate": { |
| "description": "Windows update settings. Use this override the default windows patch rules.", |
| "$ref": "WindowsUpdateSettings" |
| }, |
| "preStep": { |
| "$ref": "ExecStep", |
| "description": "The `ExecStep` to run before the patch update." |
| }, |
| "postStep": { |
| "$ref": "ExecStep", |
| "description": "The `ExecStep` to run after the patch update." |
| } |
| }, |
| "description": "Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance." |
| }, |
| "PatchJob": { |
| "description": "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).", |
| "properties": { |
| "state": { |
| "type": "string", |
| "enumDescriptions": [ |
| "State must be specified.", |
| "The patch job was successfully initiated.", |
| "The patch job is looking up instances to run the patch on.", |
| "Instances are being patched.", |
| "Patch job completed successfully.", |
| "Patch job completed but there were errors.", |
| "The patch job was canceled.", |
| "The patch job timed out." |
| ], |
| "description": "The current state of the PatchJob.", |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "STARTED", |
| "INSTANCE_LOOKUP", |
| "PATCHING", |
| "SUCCEEDED", |
| "COMPLETED_WITH_ERRORS", |
| "CANCELED", |
| "TIMED_OUT" |
| ] |
| }, |
| "instanceFilter": { |
| "$ref": "PatchInstanceFilter", |
| "description": "Instances to patch." |
| }, |
| "description": { |
| "type": "string", |
| "description": "Description of the patch job. Length of the description is limited to 1024 characters." |
| }, |
| "patchConfig": { |
| "$ref": "PatchConfig", |
| "description": "Patch configuration being applied." |
| }, |
| "updateTime": { |
| "description": "Last time this patch job was updated.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "createTime": { |
| "description": "Time this patch job was created.", |
| "type": "string", |
| "format": "google-datetime" |
| }, |
| "instanceDetailsSummary": { |
| "$ref": "PatchJobInstanceDetailsSummary", |
| "description": "Summary of instance details." |
| }, |
| "displayName": { |
| "description": "Display name for this patch job. This is not a unique identifier.", |
| "type": "string" |
| }, |
| "duration": { |
| "format": "google-duration", |
| "description": "Duration of the patch job. After the duration ends, the patch job times out.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Unique identifier for this patch job in the form `projects/*/patchJobs/*`", |
| "type": "string" |
| }, |
| "rollout": { |
| "$ref": "PatchRollout", |
| "description": "Rollout strategy being applied." |
| }, |
| "patchDeployment": { |
| "readOnly": true, |
| "description": "Output only. Name of the patch deployment that created this patch job.", |
| "type": "string" |
| }, |
| "dryRun": { |
| "description": "If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance.", |
| "type": "boolean" |
| }, |
| "errorMessage": { |
| "description": "If this patch job failed, this message provides information about the failure.", |
| "type": "string" |
| }, |
| "percentComplete": { |
| "format": "double", |
| "description": "Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.", |
| "type": "number" |
| } |
| }, |
| "type": "object", |
| "id": "PatchJob" |
| }, |
| "InventoryWindowsQuickFixEngineeringPackage": { |
| "properties": { |
| "hotFixId": { |
| "description": "Unique identifier associated with a particular QFE update.", |
| "type": "string" |
| }, |
| "installTime": { |
| "type": "string", |
| "format": "google-datetime", |
| "description": "Date that the QFE update was installed. Mapped from installed_on field." |
| }, |
| "description": { |
| "type": "string", |
| "description": "A textual description of the QFE update." |
| }, |
| "caption": { |
| "type": "string", |
| "description": "A short textual description of the QFE update." |
| } |
| }, |
| "type": "object", |
| "description": "Information related to a Quick Fix Engineering package. Fields are taken from Windows QuickFixEngineering Interface and match the source names: https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering", |
| "id": "InventoryWindowsQuickFixEngineeringPackage" |
| }, |
| "ExecutePatchJobRequest": { |
| "type": "object", |
| "id": "ExecutePatchJobRequest", |
| "properties": { |
| "displayName": { |
| "type": "string", |
| "description": "Display name for this patch job. This does not have to be unique." |
| }, |
| "instanceFilter": { |
| "$ref": "PatchInstanceFilter", |
| "description": "Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels." |
| }, |
| "rollout": { |
| "$ref": "PatchRollout", |
| "description": "Rollout strategy of the patch job." |
| }, |
| "description": { |
| "type": "string", |
| "description": "Description of the patch job. Length of the description is limited to 1024 characters." |
| }, |
| "duration": { |
| "description": "Duration of the patch job. After the duration ends, the patch job times out.", |
| "format": "google-duration", |
| "type": "string" |
| }, |
| "dryRun": { |
| "type": "boolean", |
| "description": "If this patch is a dry-run only, instances are contacted but will do nothing." |
| }, |
| "patchConfig": { |
| "$ref": "PatchConfig", |
| "description": "Patch configuration being applied. If omitted, instances are patched using the default configurations." |
| } |
| }, |
| "description": "A request message to initiate patching across Compute Engine instances." |
| }, |
| "PatchDeployment": { |
| "properties": { |
| "createTime": { |
| "description": "Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", |
| "format": "google-datetime", |
| "type": "string", |
| "readOnly": true |
| }, |
| "recurringSchedule": { |
| "$ref": "RecurringSchedule", |
| "description": "Required. Schedule recurring executions." |
| }, |
| "duration": { |
| "type": "string", |
| "format": "google-duration", |
| "description": "Optional. Duration of the patch. After the duration ends, the patch times out." |
| }, |
| "updateTime": { |
| "format": "google-datetime", |
| "description": "Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", |
| "type": "string", |
| "readOnly": true |
| }, |
| "oneTimeSchedule": { |
| "$ref": "OneTimeSchedule", |
| "description": "Required. Schedule a one-time execution." |
| }, |
| "lastExecuteTime": { |
| "readOnly": true, |
| "type": "string", |
| "description": "Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", |
| "format": "google-datetime" |
| }, |
| "name": { |
| "description": "Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment.", |
| "type": "string" |
| }, |
| "rollout": { |
| "description": "Optional. Rollout strategy of the patch job.", |
| "$ref": "PatchRollout" |
| }, |
| "instanceFilter": { |
| "description": "Required. VM instances to patch.", |
| "$ref": "PatchInstanceFilter" |
| }, |
| "patchConfig": { |
| "description": "Optional. Patch configuration that is applied.", |
| "$ref": "PatchConfig" |
| }, |
| "description": { |
| "type": "string", |
| "description": "Optional. Description of the patch deployment. Length of the description is limited to 1024 characters." |
| } |
| }, |
| "description": "Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. For more information about creating and managing patch deployments, see [Scheduling patch jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).", |
| "id": "PatchDeployment", |
| "type": "object" |
| }, |
| "FixedOrPercent": { |
| "description": "Message encapsulating a value that can be either absolute (\"fixed\") or relative (\"percent\") to a value.", |
| "type": "object", |
| "id": "FixedOrPercent", |
| "properties": { |
| "fixed": { |
| "description": "Specifies a fixed value.", |
| "type": "integer", |
| "format": "int32" |
| }, |
| "percent": { |
| "description": "Specifies the relative value defined as a percentage, which will be multiplied by a reference value.", |
| "type": "integer", |
| "format": "int32" |
| } |
| } |
| }, |
| "CancelPatchJobRequest": { |
| "description": "Message for canceling a patch job.", |
| "type": "object", |
| "properties": {}, |
| "id": "CancelPatchJobRequest" |
| }, |
| "MonthlySchedule": { |
| "description": "Represents a monthly schedule. An example of a valid monthly schedule is \"on the third Tuesday of the month\" or \"on the 15th of the month\".", |
| "type": "object", |
| "id": "MonthlySchedule", |
| "properties": { |
| "weekDayOfMonth": { |
| "description": "Required. Week day in a month.", |
| "$ref": "WeekDayOfMonth" |
| }, |
| "monthDay": { |
| "type": "integer", |
| "format": "int32", |
| "description": "Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run \"every month on the 31st\" will not run in February, April, June, etc." |
| } |
| } |
| }, |
| "PatchInstanceFilterGroupLabel": { |
| "id": "PatchInstanceFilterGroupLabel", |
| "description": "Targets a group of VM instances by using their [assigned labels](https://cloud.google.com/compute/docs/labeling-resources). Labels are key-value pairs. A `GroupLabel` is a combination of labels that is used to target VMs for a patch job. For example, a patch job can target VMs that have the following `GroupLabel`: `{\"env\":\"test\", \"app\":\"web\"}`. This means that the patch job is applied to VMs that have both the labels `env=test` and `app=web`.", |
| "type": "object", |
| "properties": { |
| "labels": { |
| "type": "object", |
| "description": "Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.", |
| "additionalProperties": { |
| "type": "string" |
| } |
| } |
| } |
| }, |
| "Empty": { |
| "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", |
| "type": "object", |
| "id": "Empty", |
| "properties": {} |
| }, |
| "WindowsUpdateSettings": { |
| "properties": { |
| "classifications": { |
| "items": { |
| "enum": [ |
| "CLASSIFICATION_UNSPECIFIED", |
| "CRITICAL", |
| "SECURITY", |
| "DEFINITION", |
| "DRIVER", |
| "FEATURE_PACK", |
| "SERVICE_PACK", |
| "TOOL", |
| "UPDATE_ROLLUP", |
| "UPDATE" |
| ], |
| "enumDescriptions": [ |
| "Invalid. If classifications are included, they must be specified.", |
| "\"A widely released fix for a specific problem that addresses a critical, non-security-related bug.\" [1]", |
| "\"A widely released fix for a product-specific, security-related vulnerability. Security vulnerabilities are rated by their severity. The severity rating is indicated in the Microsoft security bulletin as critical, important, moderate, or low.\" [1]", |
| "\"A widely released and frequent software update that contains additions to a product's definition database. Definition databases are often used to detect objects that have specific attributes, such as malicious code, phishing websites, or junk mail.\" [1]", |
| "\"Software that controls the input and output of a device.\" [1]", |
| "\"New product functionality that is first distributed outside the context of a product release and that is typically included in the next full product release.\" [1]", |
| "\"A tested, cumulative set of all hotfixes, security updates, critical updates, and updates. Additionally, service packs may contain additional fixes for problems that are found internally since the release of the product. Service packs my also contain a limited number of customer-requested design changes or features.\" [1]", |
| "\"A utility or feature that helps complete a task or set of tasks.\" [1]", |
| "\"A tested, cumulative set of hotfixes, security updates, critical updates, and updates that are packaged together for easy deployment. A rollup generally targets a specific area, such as security, or a component of a product, such as Internet Information Services (IIS).\" [1]", |
| "\"A widely released fix for a specific problem. An update addresses a noncritical, non-security-related bug.\" [1]" |
| ], |
| "type": "string" |
| }, |
| "type": "array", |
| "description": "Only apply updates of these windows update classifications. If empty, all updates are applied." |
| }, |
| "excludes": { |
| "type": "array", |
| "description": "List of KBs to exclude from update.", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "exclusivePatches": { |
| "type": "array", |
| "description": "An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations.", |
| "items": { |
| "type": "string" |
| } |
| } |
| }, |
| "description": "Windows patching is performed using the Windows Update Agent.", |
| "type": "object", |
| "id": "WindowsUpdateSettings" |
| }, |
| "ListPatchJobInstanceDetailsResponse": { |
| "description": "A response message for listing the instances details for a patch job.", |
| "id": "ListPatchJobInstanceDetailsResponse", |
| "properties": { |
| "nextPageToken": { |
| "description": "A pagination token that can be used to get the next page of results.", |
| "type": "string" |
| }, |
| "patchJobInstanceDetails": { |
| "description": "A list of instance status.", |
| "type": "array", |
| "items": { |
| "$ref": "PatchJobInstanceDetails" |
| } |
| } |
| }, |
| "type": "object" |
| }, |
| "InventoryZypperPatch": { |
| "id": "InventoryZypperPatch", |
| "type": "object", |
| "properties": { |
| "category": { |
| "type": "string", |
| "description": "The category of the patch." |
| }, |
| "summary": { |
| "type": "string", |
| "description": "Any summary information provided about this patch." |
| }, |
| "patchName": { |
| "type": "string", |
| "description": "The name of the patch." |
| }, |
| "severity": { |
| "description": "The severity specified for this patch", |
| "type": "string" |
| } |
| }, |
| "description": "Details related to a Zypper Patch." |
| }, |
| "InventoryWindowsUpdatePackage": { |
| "type": "object", |
| "id": "InventoryWindowsUpdatePackage", |
| "properties": { |
| "title": { |
| "type": "string", |
| "description": "The localized title of the update package." |
| }, |
| "categories": { |
| "type": "array", |
| "items": { |
| "$ref": "InventoryWindowsUpdatePackageWindowsUpdateCategory" |
| }, |
| "description": "The categories that are associated with this update package." |
| }, |
| "updateId": { |
| "type": "string", |
| "description": "Gets the identifier of an update package. Stays the same across revisions." |
| }, |
| "supportUrl": { |
| "type": "string", |
| "description": "A hyperlink to the language-specific support information for the update." |
| }, |
| "kbArticleIds": { |
| "items": { |
| "type": "string" |
| }, |
| "type": "array", |
| "description": "A collection of Microsoft Knowledge Base article IDs that are associated with the update package." |
| }, |
| "lastDeploymentChangeTime": { |
| "description": "The last published date of the update, in (UTC) date and time.", |
| "type": "string", |
| "format": "google-datetime" |
| }, |
| "revisionNumber": { |
| "type": "integer", |
| "format": "int32", |
| "description": "The revision number of this update package." |
| }, |
| "description": { |
| "type": "string", |
| "description": "The localized description of the update package." |
| }, |
| "moreInfoUrls": { |
| "type": "array", |
| "description": "A collection of URLs that provide more information about the update package.", |
| "items": { |
| "type": "string" |
| } |
| } |
| }, |
| "description": "Details related to a Windows Update package. Field data and names are taken from Windows Update API IUpdate Interface: https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive fields like title, and description are localized based on the locale of the VM being updated." |
| }, |
| "PatchJobInstanceDetails": { |
| "properties": { |
| "state": { |
| "description": "Current state of instance patch.", |
| "type": "string", |
| "enum": [ |
| "PATCH_STATE_UNSPECIFIED", |
| "PENDING", |
| "INACTIVE", |
| "NOTIFIED", |
| "STARTED", |
| "DOWNLOADING_PATCHES", |
| "APPLYING_PATCHES", |
| "REBOOTING", |
| "SUCCEEDED", |
| "SUCCEEDED_REBOOT_REQUIRED", |
| "FAILED", |
| "ACKED", |
| "TIMED_OUT", |
| "RUNNING_PRE_PATCH_STEP", |
| "RUNNING_POST_PATCH_STEP", |
| "NO_AGENT_DETECTED" |
| ], |
| "enumDescriptions": [ |
| "Unspecified.", |
| "The instance is not yet notified.", |
| "Instance is inactive and cannot be patched.", |
| "The instance is notified that it should be patched.", |
| "The instance has started the patching process.", |
| "The instance is downloading patches.", |
| "The instance is applying patches.", |
| "The instance is rebooting.", |
| "The instance has completed applying patches.", |
| "The instance has completed applying patches but a reboot is required.", |
| "The instance has failed to apply the patch.", |
| "The instance acked the notification and will start shortly.", |
| "The instance exceeded the time out while applying the patch.", |
| "The instance is running the pre-patch step.", |
| "The instance is running the post-patch step.", |
| "The service could not detect the presence of the agent. Check to ensure that the agent is installed, running, and able to communicate with the service." |
| ] |
| }, |
| "instanceSystemId": { |
| "description": "The unique identifier for the instance. This identifier is defined by the server.", |
| "type": "string" |
| }, |
| "attemptCount": { |
| "description": "The number of times the agent that the agent attempts to apply the patch.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "failureReason": { |
| "description": "If the patch fails, this field provides the reason.", |
| "type": "string" |
| }, |
| "name": { |
| "type": "string", |
| "description": "The instance name in the form `projects/*/zones/*/instances/*`" |
| } |
| }, |
| "id": "PatchJobInstanceDetails", |
| "description": "Patch details for a VM instance. For more information about reviewing VM instance details, see [Listing all VM instance details for a specific patch job](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).", |
| "type": "object" |
| }, |
| "InventoryItem": { |
| "type": "object", |
| "description": "A single piece of inventory on a VM.", |
| "id": "InventoryItem", |
| "properties": { |
| "createTime": { |
| "type": "string", |
| "description": "When this inventory item was first detected.", |
| "format": "google-datetime" |
| }, |
| "installedPackage": { |
| "$ref": "InventorySoftwarePackage", |
| "description": "Software package present on the VM instance." |
| }, |
| "availablePackage": { |
| "description": "Software package available to be installed on the VM instance.", |
| "$ref": "InventorySoftwarePackage" |
| }, |
| "type": { |
| "type": "string", |
| "enumDescriptions": [ |
| "Invalid. An type must be specified.", |
| "This represents a package that is installed on the VM.", |
| "This represents an update that is available for a package." |
| ], |
| "enum": [ |
| "TYPE_UNSPECIFIED", |
| "INSTALLED_PACKAGE", |
| "AVAILABLE_PACKAGE" |
| ], |
| "description": "The specific type of inventory, correlating to its specific details." |
| }, |
| "originType": { |
| "enum": [ |
| "ORIGIN_TYPE_UNSPECIFIED", |
| "INVENTORY_REPORT" |
| ], |
| "type": "string", |
| "description": "The origin of this inventory item.", |
| "enumDescriptions": [ |
| "Invalid. An origin type must be specified.", |
| "This inventory item was discovered as the result of the agent reporting inventory via the reporting API." |
| ] |
| }, |
| "id": { |
| "type": "string", |
| "description": "Identifier for this item, unique across items for this VM." |
| }, |
| "updateTime": { |
| "description": "When this inventory item was last modified.", |
| "type": "string", |
| "format": "google-datetime" |
| } |
| } |
| }, |
| "ListPatchJobsResponse": { |
| "properties": { |
| "patchJobs": { |
| "type": "array", |
| "description": "The list of patch jobs.", |
| "items": { |
| "$ref": "PatchJob" |
| } |
| }, |
| "nextPageToken": { |
| "description": "A pagination token that can be used to get the next page of results.", |
| "type": "string" |
| } |
| }, |
| "type": "object", |
| "id": "ListPatchJobsResponse", |
| "description": "A response message for listing patch jobs." |
| }, |
| "TimeOfDay": { |
| "id": "TimeOfDay", |
| "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", |
| "type": "object", |
| "properties": { |
| "hours": { |
| "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", |
| "type": "integer", |
| "format": "int32" |
| }, |
| "minutes": { |
| "description": "Minutes of hour of day. Must be from 0 to 59.", |
| "type": "integer", |
| "format": "int32" |
| }, |
| "seconds": { |
| "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", |
| "type": "integer", |
| "format": "int32" |
| }, |
| "nanos": { |
| "format": "int32", |
| "type": "integer", |
| "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999." |
| } |
| } |
| }, |
| "ExecStep": { |
| "id": "ExecStep", |
| "properties": { |
| "linuxExecStepConfig": { |
| "$ref": "ExecStepConfig", |
| "description": "The ExecStepConfig for all Linux VMs targeted by the PatchJob." |
| }, |
| "windowsExecStepConfig": { |
| "description": "The ExecStepConfig for all Windows VMs targeted by the PatchJob.", |
| "$ref": "ExecStepConfig" |
| } |
| }, |
| "type": "object", |
| "description": "A step that runs an executable for a PatchJob." |
| }, |
| "InventoryVersionedPackage": { |
| "description": "Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.", |
| "id": "InventoryVersionedPackage", |
| "properties": { |
| "version": { |
| "description": "The version of the package.", |
| "type": "string" |
| }, |
| "architecture": { |
| "type": "string", |
| "description": "The system architecture this package is intended for." |
| }, |
| "packageName": { |
| "type": "string", |
| "description": "The name of the package." |
| } |
| }, |
| "type": "object" |
| }, |
| "GcsObject": { |
| "type": "object", |
| "id": "GcsObject", |
| "description": "Cloud Storage object representation.", |
| "properties": { |
| "generationNumber": { |
| "type": "string", |
| "format": "int64", |
| "description": "Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change." |
| }, |
| "object": { |
| "type": "string", |
| "description": "Required. Name of the Cloud Storage object." |
| }, |
| "bucket": { |
| "type": "string", |
| "description": "Required. Bucket of the Cloud Storage object." |
| } |
| } |
| }, |
| "InventoryOsInfo": { |
| "id": "InventoryOsInfo", |
| "properties": { |
| "kernelRelease": { |
| "type": "string", |
| "description": "The kernel release of the operating system." |
| }, |
| "version": { |
| "type": "string", |
| "description": "The version of the operating system." |
| }, |
| "kernelVersion": { |
| "type": "string", |
| "description": "The kernel version of the operating system." |
| }, |
| "longName": { |
| "type": "string", |
| "description": "The operating system long name. For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019 Datacenter'." |
| }, |
| "architecture": { |
| "type": "string", |
| "description": "The system architecture of the operating system." |
| }, |
| "hostname": { |
| "description": "The VM hostname.", |
| "type": "string" |
| }, |
| "shortName": { |
| "description": "The operating system short name. For example, 'windows' or 'debian'.", |
| "type": "string" |
| }, |
| "osconfigAgentVersion": { |
| "type": "string", |
| "description": "The current version of the OS Config agent running on the VM." |
| } |
| }, |
| "description": "Operating system information for the VM.", |
| "type": "object" |
| }, |
| "ExecStepConfig": { |
| "type": "object", |
| "properties": { |
| "localPath": { |
| "type": "string", |
| "description": "An absolute path to the executable on the VM." |
| }, |
| "interpreter": { |
| "enumDescriptions": [ |
| "Invalid for a Windows ExecStepConfig. For a Linux ExecStepConfig, the interpreter will be parsed from the shebang line of the script if unspecified.", |
| "Indicates that the script is run with `/bin/sh` on Linux and `cmd` on Windows.", |
| "Indicates that the file is run with PowerShell flags `-NonInteractive`, `-NoProfile`, and `-ExecutionPolicy Bypass`." |
| ], |
| "type": "string", |
| "description": "The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\\(Unix\\)).", |
| "enum": [ |
| "INTERPRETER_UNSPECIFIED", |
| "SHELL", |
| "POWERSHELL" |
| ] |
| }, |
| "allowedSuccessCodes": { |
| "items": { |
| "type": "integer", |
| "format": "int32" |
| }, |
| "type": "array", |
| "description": "Defaults to [0]. A list of possible return values that the execution can return to indicate a success." |
| }, |
| "gcsObject": { |
| "description": "A Cloud Storage object containing the executable.", |
| "$ref": "GcsObject" |
| } |
| }, |
| "id": "ExecStepConfig", |
| "description": "Common configurations for an ExecStep." |
| }, |
| "Inventory": { |
| "description": "The inventory details of a VM.", |
| "type": "object", |
| "id": "Inventory", |
| "properties": { |
| "items": { |
| "description": "Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.", |
| "additionalProperties": { |
| "$ref": "InventoryItem" |
| }, |
| "type": "object" |
| }, |
| "osInfo": { |
| "description": "Base level operating system information for the VM.", |
| "$ref": "InventoryOsInfo" |
| } |
| } |
| }, |
| "PatchJobInstanceDetailsSummary": { |
| "id": "PatchJobInstanceDetailsSummary", |
| "type": "object", |
| "properties": { |
| "timedOutInstanceCount": { |
| "type": "string", |
| "format": "int64", |
| "description": "Number of instances that exceeded the time out while applying the patch." |
| }, |
| "postPatchStepInstanceCount": { |
| "type": "string", |
| "description": "Number of instances that are running the post-patch step.", |
| "format": "int64" |
| }, |
| "noAgentDetectedInstanceCount": { |
| "description": "Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "applyingPatchesInstanceCount": { |
| "type": "string", |
| "description": "Number of instances that are applying patches.", |
| "format": "int64" |
| }, |
| "startedInstanceCount": { |
| "description": "Number of instances that have started.", |
| "type": "string", |
| "format": "int64" |
| }, |
| "notifiedInstanceCount": { |
| "description": "Number of instances notified about patch job.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "failedInstanceCount": { |
| "type": "string", |
| "format": "int64", |
| "description": "Number of instances that failed." |
| }, |
| "succeededRebootRequiredInstanceCount": { |
| "format": "int64", |
| "type": "string", |
| "description": "Number of instances that require reboot." |
| }, |
| "inactiveInstanceCount": { |
| "type": "string", |
| "format": "int64", |
| "description": "Number of instances that are inactive." |
| }, |
| "downloadingPatchesInstanceCount": { |
| "type": "string", |
| "format": "int64", |
| "description": "Number of instances that are downloading patches." |
| }, |
| "ackedInstanceCount": { |
| "type": "string", |
| "format": "int64", |
| "description": "Number of instances that have acked and will start shortly." |
| }, |
| "rebootingInstanceCount": { |
| "description": "Number of instances rebooting.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "pendingInstanceCount": { |
| "format": "int64", |
| "description": "Number of instances pending patch job.", |
| "type": "string" |
| }, |
| "prePatchStepInstanceCount": { |
| "description": "Number of instances that are running the pre-patch step.", |
| "type": "string", |
| "format": "int64" |
| }, |
| "succeededInstanceCount": { |
| "format": "int64", |
| "type": "string", |
| "description": "Number of instances that have completed successfully." |
| } |
| }, |
| "description": "A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance." |
| }, |
| "WeeklySchedule": { |
| "type": "object", |
| "id": "WeeklySchedule", |
| "properties": { |
| "dayOfWeek": { |
| "type": "string", |
| "description": "Required. Day of the week.", |
| "enum": [ |
| "DAY_OF_WEEK_UNSPECIFIED", |
| "MONDAY", |
| "TUESDAY", |
| "WEDNESDAY", |
| "THURSDAY", |
| "FRIDAY", |
| "SATURDAY", |
| "SUNDAY" |
| ], |
| "enumDescriptions": [ |
| "The day of the week is unspecified.", |
| "Monday", |
| "Tuesday", |
| "Wednesday", |
| "Thursday", |
| "Friday", |
| "Saturday", |
| "Sunday" |
| ] |
| } |
| }, |
| "description": "Represents a weekly schedule." |
| }, |
| "OneTimeSchedule": { |
| "id": "OneTimeSchedule", |
| "description": "Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", |
| "type": "object", |
| "properties": { |
| "executeTime": { |
| "type": "string", |
| "format": "google-datetime", |
| "description": "Required. The desired patch job execution time." |
| } |
| } |
| }, |
| "RecurringSchedule": { |
| "id": "RecurringSchedule", |
| "properties": { |
| "lastExecuteTime": { |
| "readOnly": true, |
| "description": "Output only. The time the last patch job ran successfully.", |
| "type": "string", |
| "format": "google-datetime" |
| }, |
| "timeZone": { |
| "$ref": "TimeZone", |
| "description": "Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone." |
| }, |
| "frequency": { |
| "enumDescriptions": [ |
| "Invalid. A frequency must be specified.", |
| "Indicates that the frequency should be expressed in terms of weeks.", |
| "Indicates that the frequency should be expressed in terms of months." |
| ], |
| "type": "string", |
| "enum": [ |
| "FREQUENCY_UNSPECIFIED", |
| "WEEKLY", |
| "MONTHLY" |
| ], |
| "description": "Required. The frequency unit of this recurring schedule." |
| }, |
| "weekly": { |
| "$ref": "WeeklySchedule", |
| "description": "Required. Schedule with weekly executions." |
| }, |
| "nextExecuteTime": { |
| "readOnly": true, |
| "description": "Output only. The time the next patch job is scheduled to run.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "startTime": { |
| "description": "Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "timeOfDay": { |
| "$ref": "TimeOfDay", |
| "description": "Required. Time of the day to run a recurring deployment." |
| }, |
| "monthly": { |
| "description": "Required. Schedule with monthly executions.", |
| "$ref": "MonthlySchedule" |
| }, |
| "endTime": { |
| "format": "google-datetime", |
| "description": "Optional. The end time at which a recurring patch deployment schedule is no longer active.", |
| "type": "string" |
| } |
| }, |
| "description": "Sets the time for recurring patch deployments.", |
| "type": "object" |
| }, |
| "YumSettings": { |
| "id": "YumSettings", |
| "description": "Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms.", |
| "type": "object", |
| "properties": { |
| "exclusivePackages": { |
| "type": "array", |
| "description": "An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields.", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "minimal": { |
| "description": "Will cause patch to run `yum update-minimal` instead.", |
| "type": "boolean" |
| }, |
| "excludes": { |
| "items": { |
| "type": "string" |
| }, |
| "type": "array", |
| "description": "List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag." |
| }, |
| "security": { |
| "description": "Adds the `--security` flag to `yum update`. Not supported on all platforms.", |
| "type": "boolean" |
| } |
| } |
| } |
| }, |
| "version_module": true, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "baseUrl": "https://osconfig.googleapis.com/", |
| "ownerDomain": "google.com", |
| "protocol": "rest", |
| "batchPath": "batch", |
| "version": "v1", |
| "discoveryVersion": "v1", |
| "id": "osconfig:v1", |
| "name": "osconfig", |
| "kind": "discovery#restDescription", |
| "basePath": "", |
| "ownerName": "Google", |
| "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", |
| "fullyEncodeReservedExpansion": true, |
| "servicePath": "" |
| } |
