openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 74.4 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://osconfig.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"OS Config API","version":"v1beta","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg"},"x-origin":[{"format":"google","url":"https://osconfig.googleapis.com/$discovery/rest?version=v1beta","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"osconfig"},"externalDocs":{"url":"https://cloud.google.com/compute/docs/osconfig/rest"},"tags":[{"name":"projects"}],"paths":{"/v1beta/{instance}:lookupEffectiveGuestPolicy":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.","operationId":"osconfig.projects.zones.instances.lookupEffectiveGuestPolicy","parameters":[{"description":"Required. The VM instance whose policies are being looked up.","in":"path","name":"instance","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupEffectiveGuestPolicyRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EffectiveGuestPolicy"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta/{name}":{"delete":{"description":"Delete an OS Config patch deployment.","operationId":"osconfig.projects.patchDeployments.delete","parameters":[{"description":"Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"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.","operationId":"osconfig.projects.patchJobs.get","parameters":[{"description":"Required. Name of the patch in the form `projects/*/patchJobs/*`","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchJob"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"patch":{"description":"Update an OS Config patch deployment.","operationId":"osconfig.projects.patchDeployments.patch","parameters":[{"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.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Optional. Field mask that controls which fields of the patch deployment should be updated.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchDeployment"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchDeployment"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta/{name}:cancel":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.","operationId":"osconfig.projects.patchJobs.cancel","parameters":[{"description":"Required. Name of the patch in the form `projects/*/patchJobs/*`","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPatchJobRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchJob"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta/{name}:pause":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Change state of patch deployment to \"PAUSED\". Patch deployment in paused state doesn't generate patch jobs.","operationId":"osconfig.projects.patchDeployments.pause","parameters":[{"description":"Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PausePatchDeploymentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchDeployment"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta/{name}:resume":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Change state of patch deployment back to \"ACTIVE\". Patch deployment in active state continues to generate patch jobs.","operationId":"osconfig.projects.patchDeployments.resume","parameters":[{"description":"Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumePatchDeploymentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchDeployment"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta/{parent}/guestPolicies":{"get":{"description":"Get a page of OS Config guest policies.","operationId":"osconfig.projects.guestPolicies.list","parameters":[{"description":"Required. The resource name of the parent using one of the following forms: `projects/{project_number}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The maximum number of guest policies to return.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A pagination token returned from a previous call to `ListGuestPolicies` that indicates where this listing should continue from.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGuestPoliciesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Create an OS Config guest policy.","operationId":"osconfig.projects.guestPolicies.create","parameters":[{"description":"Required. The resource name of the parent using one of the following forms: `projects/{project_number}`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Required. The logical name of the guest policy in the project with the following restrictions: * 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.","in":"query","name":"guestPolicyId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuestPolicy"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuestPolicy"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta/{parent}/instanceDetails":{"get":{"description":"Get a list of instance details for a given patch job.","operationId":"osconfig.projects.patchJobs.instanceDetails.list","parameters":[{"description":"Required. The parent for the instances are in the form of `projects/*/patchJobs/*`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The maximum number of instance details records to return. Default is 100.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A pagination token returned from a previous call that indicates where this listing should continue from.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPatchJobInstanceDetailsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1beta/{parent}/patchDeployments":{"get":{"description":"Get a page of OS Config patch deployments.","operationId":"osconfig.projects.patchDeployments.list","parameters":[{"description":"Required. The resource name of the parent in the form `projects/*`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. The maximum number of patch deployments to return. Default is 100.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPatchDeploymentsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Create an OS Config patch deployment.","operationId":"osconfig.projects.patchDeployments.create","parameters":[{"description":"Required. The project to apply this patch deployment to in the form `projects/*`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"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.","in":"query","name":"patchDeploymentId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchDeployment"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchDeployment"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1beta/{parent}/patchJobs":{"get":{"description":"Get a list of patch jobs.","operationId":"osconfig.projects.patchJobs.list","parameters":[{"description":"Required. In the form of `projects/*`","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"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.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The maximum number of instance status to return.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A pagination token returned from a previous call that indicates where this listing should continue from.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPatchJobsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1beta/{parent}/patchJobs:execute":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Patch VM instances by creating and running a patch job.","operationId":"osconfig.projects.patchJobs.execute","parameters":[{"description":"Required. The project in which to run this patch in the form `projects/*`","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePatchJobRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchJob"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"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.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"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.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"AptRepository":{"description":"Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`.","properties":{"archiveType":{"description":"Type of archive files in this repository. The default behavior is DEB.","enum":["ARCHIVE_TYPE_UNSPECIFIED","DEB","DEB_SRC"],"type":"string"},"components":{"description":"Required. List of components for this repository. Must contain at least one item.","items":{"type":"string"},"type":"array"},"distribution":{"description":"Required. Distribution of this repository.","type":"string"},"gpgKey":{"description":"URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy.","type":"string"},"uri":{"description":"Required. URI for this repository.","type":"string"}},"type":"object"},"AptSettings":{"description":"Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed.","properties":{"excludes":{"description":"List of packages to exclude from update. These packages will be excluded","items":{"type":"string"},"type":"array"},"exclusivePackages":{"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.","items":{"type":"string"},"type":"array"},"type":{"description":"By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead.","enum":["TYPE_UNSPECIFIED","DIST","UPGRADE"],"type":"string"}},"type":"object"},"Assignment":{"description":"An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones.","properties":{"groupLabels":{"description":"Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example \"env=prod or env=staging\".","items":{"$ref":"#/components/schemas/AssignmentGroupLabel"},"type":"array"},"instanceNamePrefixes":{"description":"Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix=\"prod-\". Only supported for project-level policies.","items":{"type":"string"},"type":"array"},"instances":{"description":"Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project.","items":{"type":"string"},"type":"array"},"osTypes":{"description":"Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included.","items":{"$ref":"#/components/schemas/AssignmentOsType"},"type":"array"},"zones":{"description":"Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone.","items":{"type":"string"},"type":"array"}},"type":"object"},"AssignmentGroupLabel":{"description":"Represents a group of VM intances that can be identified as having all these labels, for example \"env=prod and app=web\".","properties":{"labels":{"additionalProperties":{"type":"string"},"description":"Google Compute Engine instance labels that must be present for an instance to be included in this assignment group.","type":"object"}},"type":"object"},"AssignmentOsType":{"description":"Defines the criteria for selecting VM Instances by OS type.","properties":{"osArchitecture":{"description":"Targets VM instances with OS Inventory enabled and having the following OS architecture.","type":"string"},"osShortName":{"description":"Targets VM instances with OS Inventory enabled and having the following OS short name, for example \"debian\" or \"windows\".","type":"string"},"osVersion":{"description":"Targets VM instances with OS Inventory enabled and having the following following OS version.","type":"string"}},"type":"object"},"CancelPatchJobRequest":{"description":"Message for canceling a patch job.","properties":{},"type":"object"},"EffectiveGuestPolicy":{"description":"The effective guest policy that applies to a VM instance.","properties":{"packageRepositories":{"description":"List of package repository configurations assigned to the VM instance.","items":{"$ref":"#/components/schemas/EffectiveGuestPolicySourcedPackageRepository"},"type":"array"},"packages":{"description":"List of package configurations assigned to the VM instance.","items":{"$ref":"#/components/schemas/EffectiveGuestPolicySourcedPackage"},"type":"array"},"softwareRecipes":{"description":"List of recipes assigned to the VM instance.","items":{"$ref":"#/components/schemas/EffectiveGuestPolicySourcedSoftwareRecipe"},"type":"array"}},"type":"object"},"EffectiveGuestPolicySourcedPackage":{"description":"A guest policy package including its source.","properties":{"package":{"$ref":"#/components/schemas/Package","description":"A software package to configure on the VM instance."},"source":{"description":"Name of the guest policy providing this config.","type":"string"}},"type":"object"},"EffectiveGuestPolicySourcedPackageRepository":{"description":"A guest policy package repository including its source.","properties":{"packageRepository":{"$ref":"#/components/schemas/PackageRepository","description":"A software package repository to configure on the VM instance."},"source":{"description":"Name of the guest policy providing this config.","type":"string"}},"type":"object"},"EffectiveGuestPolicySourcedSoftwareRecipe":{"description":"A guest policy recipe including its source.","properties":{"softwareRecipe":{"$ref":"#/components/schemas/SoftwareRecipe","description":"A software recipe to configure on the VM instance."},"source":{"description":"Name of the guest policy providing this config.","type":"string"}},"type":"object"},"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); }","properties":{},"type":"object"},"ExecStep":{"description":"A step that runs an executable for a PatchJob.","properties":{"linuxExecStepConfig":{"$ref":"#/components/schemas/ExecStepConfig","description":"The ExecStepConfig for all Linux VMs targeted by the PatchJob."},"windowsExecStepConfig":{"$ref":"#/components/schemas/ExecStepConfig","description":"The ExecStepConfig for all Windows VMs targeted by the PatchJob."}},"type":"object"},"ExecStepConfig":{"description":"Common configurations for an ExecStep.","properties":{"allowedSuccessCodes":{"description":"Defaults to [0]. A list of possible return values that the execution can return to indicate a success.","items":{"format":"int32","type":"integer"},"type":"array"},"gcsObject":{"$ref":"#/components/schemas/GcsObject","description":"A Google Cloud Storage object containing the executable."},"interpreter":{"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","NONE","SHELL","POWERSHELL"],"type":"string"},"localPath":{"description":"An absolute path to the executable on the VM.","type":"string"}},"type":"object"},"ExecutePatchJobRequest":{"description":"A request message to initiate patching across Compute Engine instances.","properties":{"description":{"description":"Description of the patch job. Length of the description is limited to 1024 characters.","type":"string"},"displayName":{"description":"Display name for this patch job. This does not have to be unique.","type":"string"},"dryRun":{"description":"If this patch is a dry-run only, instances are contacted but will do nothing.","type":"boolean"},"duration":{"description":"Duration of the patch job. After the duration ends, the patch job times out.","format":"google-duration","type":"string"},"instanceFilter":{"$ref":"#/components/schemas/PatchInstanceFilter","description":"Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels."},"patchConfig":{"$ref":"#/components/schemas/PatchConfig","description":"Patch configuration being applied. If omitted, instances are patched using the default configurations."},"rollout":{"$ref":"#/components/schemas/PatchRollout","description":"Rollout strategy of the patch job."}},"type":"object"},"FixedOrPercent":{"description":"Message encapsulating a value that can be either absolute (\"fixed\") or relative (\"percent\") to a value.","properties":{"fixed":{"description":"Specifies a fixed value.","format":"int32","type":"integer"},"percent":{"description":"Specifies the relative value defined as a percentage, which will be multiplied by a reference value.","format":"int32","type":"integer"}},"type":"object"},"GcsObject":{"description":"Google Cloud Storage object representation.","properties":{"bucket":{"description":"Required. Bucket of the Google Cloud Storage object.","type":"string"},"generationNumber":{"description":"Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change.","format":"int64","type":"string"},"object":{"description":"Required. Name of the Google Cloud Storage object.","type":"string"}},"type":"object"},"GooRepository":{"description":"Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo.","properties":{"name":{"description":"Required. The name of the repository.","type":"string"},"url":{"description":"Required. The url of the repository.","type":"string"}},"type":"object"},"GooSettings":{"description":"Googet patching is performed by running `googet update`.","properties":{},"type":"object"},"GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata":{"description":"OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.","properties":{"apiMethod":{"description":"The OS policy assignment API method.","enum":["API_METHOD_UNSPECIFIED","CREATE","UPDATE","DELETE"],"type":"string"},"osPolicyAssignment":{"description":"Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`","type":"string"},"rolloutStartTime":{"description":"Rollout start time","format":"google-datetime","type":"string"},"rolloutState":{"description":"State of the rollout","enum":["ROLLOUT_STATE_UNSPECIFIED","IN_PROGRESS","CANCELLING","CANCELLED","SUCCEEDED"],"type":"string"},"rolloutUpdateTime":{"description":"Rollout update time","format":"google-datetime","type":"string"}},"type":"object"},"GuestPolicy":{"description":"An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install.","properties":{"assignment":{"$ref":"#/components/schemas/Assignment","description":"Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts)."},"createTime":{"description":"Output only. Time this guest policy was created.","format":"google-datetime","readOnly":true,"type":"string"},"description":{"description":"Description of the guest policy. Length of the description is limited to 1024 characters.","type":"string"},"etag":{"description":"The etag for this guest policy. If this is provided on update, it must match the server's etag.","type":"string"},"name":{"description":"Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`.","type":"string"},"packageRepositories":{"description":"A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available.","items":{"$ref":"#/components/schemas/PackageRepository"},"type":"array"},"packages":{"description":"The software packages to be managed by this policy.","items":{"$ref":"#/components/schemas/Package"},"type":"array"},"recipes":{"description":"A list of Recipes to install on the VM instance.","items":{"$ref":"#/components/schemas/SoftwareRecipe"},"type":"array"},"updateTime":{"description":"Output only. Last time this guest policy was updated.","format":"google-datetime","readOnly":true,"type":"string"}},"type":"object"},"ListGuestPoliciesResponse":{"description":"A response message for listing guest policies.","properties":{"guestPolicies":{"description":"The list of GuestPolicies.","items":{"$ref":"#/components/schemas/GuestPolicy"},"type":"array"},"nextPageToken":{"description":"A pagination token that can be used to get the next page of guest policies.","type":"string"}},"type":"object"},"ListPatchDeploymentsResponse":{"description":"A response message for listing patch deployments.","properties":{"nextPageToken":{"description":"A pagination token that can be used to get the next page of patch deployments.","type":"string"},"patchDeployments":{"description":"The list of patch deployments.","items":{"$ref":"#/components/schemas/PatchDeployment"},"type":"array"}},"type":"object"},"ListPatchJobInstanceDetailsResponse":{"description":"A response message for listing the instances details for a patch job.","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.","items":{"$ref":"#/components/schemas/PatchJobInstanceDetails"},"type":"array"}},"type":"object"},"ListPatchJobsResponse":{"description":"A response message for listing patch jobs.","properties":{"nextPageToken":{"description":"A pagination token that can be used to get the next page of results.","type":"string"},"patchJobs":{"description":"The list of patch jobs.","items":{"$ref":"#/components/schemas/PatchJob"},"type":"array"}},"type":"object"},"LookupEffectiveGuestPolicyRequest":{"description":"A request message for getting the effective guest policy assigned to the instance.","properties":{"osArchitecture":{"description":"Architecture of OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance.","type":"string"},"osShortName":{"description":"Short name of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance.","type":"string"},"osVersion":{"description":"Version of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that VM instance.","type":"string"}},"type":"object"},"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\".","properties":{"monthDay":{"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.","format":"int32","type":"integer"},"weekDayOfMonth":{"$ref":"#/components/schemas/WeekDayOfMonth","description":"Required. Week day in a month."}},"type":"object"},"OSPolicyAssignmentOperationMetadata":{"description":"OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.","properties":{"apiMethod":{"description":"The OS policy assignment API method.","enum":["API_METHOD_UNSPECIFIED","CREATE","UPDATE","DELETE"],"type":"string"},"osPolicyAssignment":{"description":"Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`","type":"string"},"rolloutStartTime":{"description":"Rollout start time","format":"google-datetime","type":"string"},"rolloutState":{"description":"State of the rollout","enum":["ROLLOUT_STATE_UNSPECIFIED","IN_PROGRESS","CANCELLING","CANCELLED","SUCCEEDED"],"type":"string"},"rolloutUpdateTime":{"description":"Rollout update time","format":"google-datetime","type":"string"}},"type":"object"},"OneTimeSchedule":{"description":"Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.","properties":{"executeTime":{"description":"Required. The desired patch job execution time.","format":"google-datetime","type":"string"}},"type":"object"},"Package":{"description":"Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3`","properties":{"desiredState":{"description":"The desired_state the agent should maintain for this package. The default is to ensure the package is installed.","enum":["DESIRED_STATE_UNSPECIFIED","INSTALLED","UPDATED","REMOVED"],"type":"string"},"manager":{"description":"Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY.","enum":["MANAGER_UNSPECIFIED","ANY","APT","YUM","ZYPPER","GOO"],"type":"string"},"name":{"description":"Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets.","type":"string"}},"type":"object"},"PackageRepository":{"description":"A package repository.","properties":{"apt":{"$ref":"#/components/schemas/AptRepository","description":"An Apt Repository."},"goo":{"$ref":"#/components/schemas/GooRepository","description":"A Goo Repository."},"yum":{"$ref":"#/components/schemas/YumRepository","description":"A Yum Repository."},"zypper":{"$ref":"#/components/schemas/ZypperRepository","description":"A Zypper Repository."}},"type":"object"},"PatchConfig":{"description":"Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.","properties":{"apt":{"$ref":"#/components/schemas/AptSettings","description":"Apt update settings. Use this setting to override the default `apt` patch rules."},"goo":{"$ref":"#/components/schemas/GooSettings","description":"Goo update settings. Use this setting to override the default `goo` patch rules."},"migInstancesAllowed":{"description":"Allows the patch job to run on Managed instance groups (MIGs).","type":"boolean"},"postStep":{"$ref":"#/components/schemas/ExecStep","description":"The `ExecStep` to run after the patch update."},"preStep":{"$ref":"#/components/schemas/ExecStep","description":"The `ExecStep` to run before the patch update."},"rebootConfig":{"description":"Post-patch reboot settings.","enum":["REBOOT_CONFIG_UNSPECIFIED","DEFAULT","ALWAYS","NEVER"],"type":"string"},"windowsUpdate":{"$ref":"#/components/schemas/WindowsUpdateSettings","description":"Windows update settings. Use this override the default windows patch rules."},"yum":{"$ref":"#/components/schemas/YumSettings","description":"Yum update settings. Use this setting to override the default `yum` patch rules."},"zypper":{"$ref":"#/components/schemas/ZypperSettings","description":"Zypper update settings. Use this setting to override the default `zypper` patch rules."}},"type":"object"},"PatchDeployment":{"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).","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","readOnly":true,"type":"string"},"description":{"description":"Optional. Description of the patch deployment. Length of the description is limited to 1024 characters.","type":"string"},"duration":{"description":"Optional. Duration of the patch. After the duration ends, the patch times out.","format":"google-duration","type":"string"},"instanceFilter":{"$ref":"#/components/schemas/PatchInstanceFilter","description":"Required. VM instances to patch."},"lastExecuteTime":{"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","readOnly":true,"type":"string"},"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"},"oneTimeSchedule":{"$ref":"#/components/schemas/OneTimeSchedule","description":"Required. Schedule a one-time execution."},"patchConfig":{"$ref":"#/components/schemas/PatchConfig","description":"Optional. Patch configuration that is applied."},"recurringSchedule":{"$ref":"#/components/schemas/RecurringSchedule","description":"Required. Schedule recurring executions."},"rollout":{"$ref":"#/components/schemas/PatchRollout","description":"Optional. Rollout strategy of the patch job."},"state":{"description":"Output only. Current state of the patch deployment.","enum":["STATE_UNSPECIFIED","ACTIVE","PAUSED"],"readOnly":true,"type":"string"},"updateTime":{"description":"Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.","format":"google-datetime","readOnly":true,"type":"string"}},"type":"object"},"PatchInstanceFilter":{"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.","properties":{"all":{"description":"Target all VM instances in the project. If true, no other criteria is permitted.","type":"boolean"},"groupLabels":{"description":"Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example \"env=prod or env=staging\".","items":{"$ref":"#/components/schemas/PatchInstanceFilterGroupLabel"},"type":"array"},"instanceNamePrefixes":{"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-\".","items":{"type":"string"},"type":"array"},"instances":{"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]`","items":{"type":"string"},"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"}},"type":"object"},"PatchInstanceFilterGroupLabel":{"description":"Represents a group of VMs that can be identified as having all these labels, for example \"env=prod and app=web\".","properties":{"labels":{"additionalProperties":{"type":"string"},"description":"Compute Engine instance labels that must be present for a VM instance to be targeted by this filter.","type":"object"}},"type":"object"},"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":{"createTime":{"description":"Time this patch job was created.","format":"google-datetime","type":"string"},"description":{"description":"Description of the patch job. Length of the description is limited to 1024 characters.","type":"string"},"displayName":{"description":"Display name for this patch job. This is not a unique identifier.","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"},"duration":{"description":"Duration of the patch job. After the duration ends, the patch job times out.","format":"google-duration","type":"string"},"errorMessage":{"description":"If this patch job failed, this message provides information about the failure.","type":"string"},"instanceDetailsSummary":{"$ref":"#/components/schemas/PatchJobInstanceDetailsSummary","description":"Summary of instance details."},"instanceFilter":{"$ref":"#/components/schemas/PatchInstanceFilter","description":"Instances to patch."},"name":{"description":"Unique identifier for this patch job in the form `projects/*/patchJobs/*`","type":"string"},"patchConfig":{"$ref":"#/components/schemas/PatchConfig","description":"Patch configuration being applied."},"patchDeployment":{"description":"Output only. Name of the patch deployment that created this patch job.","readOnly":true,"type":"string"},"percentComplete":{"description":"Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete.","format":"double","type":"number"},"rollout":{"$ref":"#/components/schemas/PatchRollout","description":"Rollout strategy being applied."},"state":{"description":"The current state of the PatchJob.","enum":["STATE_UNSPECIFIED","STARTED","INSTANCE_LOOKUP","PATCHING","SUCCEEDED","COMPLETED_WITH_ERRORS","CANCELED","TIMED_OUT"],"type":"string"},"updateTime":{"description":"Last time this patch job was updated.","format":"google-datetime","type":"string"}},"type":"object"},"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).","properties":{"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"},"instanceSystemId":{"description":"The unique identifier for the