@maxim_mazurok/gapi.client.osconfig-v1 0.0.20220725

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts ADDED
@@ -0,0 +1,2209 @@
1
+ /* Type definitions for non-npm package OS Config API v1 0.0 */
2
+ // Project: https://cloud.google.com/compute/docs/osconfig/rest
3
+ // Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
4
+ // Nick Amoscato <https://github.com/namoscato>
5
+ // Declan Vong <https://github.com/declanvong>
6
+ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
7
+ // TypeScript Version: 2.8
8
+
9
+ // IMPORTANT
10
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
+ // Generated from: https://osconfig.googleapis.com/$discovery/rest?version=v1
13
+ // Revision: 20220725
14
+
15
+ /// <reference types="gapi.client" />
16
+
17
+ declare namespace gapi.client {
18
+ /** Load OS Config API v1 */
19
+ function load(urlOrObject: "https://osconfig.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
20
+ /** @deprecated Please load APIs with discovery documents. */
21
+ function load(name: "osconfig", version: "v1"): Promise<void>;
22
+ /** @deprecated Please load APIs with discovery documents. */
23
+ function load(name: "osconfig", version: "v1", callback: () => any): void;
24
+
25
+ namespace osconfig {
26
+ interface AptSettings {
27
+ /** List of packages to exclude from update. These packages will be excluded */
28
+ excludes?: string[];
29
+ /**
30
+ * 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
31
+ * specified with any other patch configuration fields.
32
+ */
33
+ exclusivePackages?: string[];
34
+ /** By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. */
35
+ type?: string;
36
+ }
37
+ // tslint:disable-next-line:no-empty-interface
38
+ interface CancelOperationRequest {
39
+ }
40
+ // tslint:disable-next-line:no-empty-interface
41
+ interface CancelPatchJobRequest {
42
+ }
43
+ interface CVSSv3 {
44
+ /** This metric describes the conditions beyond the attacker's control that must exist in order to exploit the vulnerability. */
45
+ attackComplexity?: string;
46
+ /** This metric reflects the context by which vulnerability exploitation is possible. */
47
+ attackVector?: string;
48
+ /** This metric measures the impact to the availability of the impacted component resulting from a successfully exploited vulnerability. */
49
+ availabilityImpact?: string;
50
+ /** The base score is a function of the base metric scores. https://www.first.org/cvss/specification-document#Base-Metrics */
51
+ baseScore?: number;
52
+ /** This metric measures the impact to the confidentiality of the information resources managed by a software component due to a successfully exploited vulnerability. */
53
+ confidentialityImpact?: string;
54
+ /** The Exploitability sub-score equation is derived from the Base Exploitability metrics. https://www.first.org/cvss/specification-document#2-1-Exploitability-Metrics */
55
+ exploitabilityScore?: number;
56
+ /** The Impact sub-score equation is derived from the Base Impact metrics. */
57
+ impactScore?: number;
58
+ /** This metric measures the impact to integrity of a successfully exploited vulnerability. */
59
+ integrityImpact?: string;
60
+ /** This metric describes the level of privileges an attacker must possess before successfully exploiting the vulnerability. */
61
+ privilegesRequired?: string;
62
+ /** The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope. */
63
+ scope?: string;
64
+ /** This metric captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component. */
65
+ userInteraction?: string;
66
+ }
67
+ interface Date {
68
+ /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
69
+ day?: number;
70
+ /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
71
+ month?: number;
72
+ /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
73
+ year?: number;
74
+ }
75
+ // tslint:disable-next-line:no-empty-interface
76
+ interface Empty {
77
+ }
78
+ interface ExecStep {
79
+ /** The ExecStepConfig for all Linux VMs targeted by the PatchJob. */
80
+ linuxExecStepConfig?: ExecStepConfig;
81
+ /** The ExecStepConfig for all Windows VMs targeted by the PatchJob. */
82
+ windowsExecStepConfig?: ExecStepConfig;
83
+ }
84
+ interface ExecStepConfig {
85
+ /** Defaults to [0]. A list of possible return values that the execution can return to indicate a success. */
86
+ allowedSuccessCodes?: number[];
87
+ /** A Cloud Storage object containing the executable. */
88
+ gcsObject?: GcsObject;
89
+ /**
90
+ * 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]
91
+ * (https://en.wikipedia.org/wiki/Shebang_\(Unix\)).
92
+ */
93
+ interpreter?: string;
94
+ /** An absolute path to the executable on the VM. */
95
+ localPath?: string;
96
+ }
97
+ interface ExecutePatchJobRequest {
98
+ /** Description of the patch job. Length of the description is limited to 1024 characters. */
99
+ description?: string;
100
+ /** Display name for this patch job. This does not have to be unique. */
101
+ displayName?: string;
102
+ /** If this patch is a dry-run only, instances are contacted but will do nothing. */
103
+ dryRun?: boolean;
104
+ /** Duration of the patch job. After the duration ends, the patch job times out. */
105
+ duration?: string;
106
+ /** Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels. */
107
+ instanceFilter?: PatchInstanceFilter;
108
+ /** Patch configuration being applied. If omitted, instances are patched using the default configurations. */
109
+ patchConfig?: PatchConfig;
110
+ /** Rollout strategy of the patch job. */
111
+ rollout?: PatchRollout;
112
+ }
113
+ interface FixedOrPercent {
114
+ /** Specifies a fixed value. */
115
+ fixed?: number;
116
+ /** Specifies the relative value defined as a percentage, which will be multiplied by a reference value. */
117
+ percent?: number;
118
+ }
119
+ interface GcsObject {
120
+ /** Required. Bucket of the Cloud Storage object. */
121
+ bucket?: string;
122
+ /** Required. Generation number of the Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. */
123
+ generationNumber?: string;
124
+ /** Required. Name of the Cloud Storage object. */
125
+ object?: string;
126
+ }
127
+ interface GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata {
128
+ /** The OS policy assignment API method. */
129
+ apiMethod?: string;
130
+ /** Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}` */
131
+ osPolicyAssignment?: string;
132
+ /** Rollout start time */
133
+ rolloutStartTime?: string;
134
+ /** State of the rollout */
135
+ rolloutState?: string;
136
+ /** Rollout update time */
137
+ rolloutUpdateTime?: string;
138
+ }
139
+ // tslint:disable-next-line:no-empty-interface
140
+ interface GooSettings {
141
+ }
142
+ interface Inventory {
143
+ /**
144
+ * 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
145
+ * change, when there is a new package version.
146
+ */
147
+ items?: { [P in string]: InventoryItem };
148
+ /** Output only. The `Inventory` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/inventory` */
149
+ name?: string;
150
+ /** Base level operating system information for the VM. */
151
+ osInfo?: InventoryOsInfo;
152
+ /** Output only. Timestamp of the last reported inventory for the VM. */
153
+ updateTime?: string;
154
+ }
155
+ interface InventoryItem {
156
+ /** Software package available to be installed on the VM instance. */
157
+ availablePackage?: InventorySoftwarePackage;
158
+ /** When this inventory item was first detected. */
159
+ createTime?: string;
160
+ /** Identifier for this item, unique across items for this VM. */
161
+ id?: string;
162
+ /** Software package present on the VM instance. */
163
+ installedPackage?: InventorySoftwarePackage;
164
+ /** The origin of this inventory item. */
165
+ originType?: string;
166
+ /** The specific type of inventory, correlating to its specific details. */
167
+ type?: string;
168
+ /** When this inventory item was last modified. */
169
+ updateTime?: string;
170
+ }
171
+ interface InventoryOsInfo {
172
+ /** The system architecture of the operating system. */
173
+ architecture?: string;
174
+ /** The VM hostname. */
175
+ hostname?: string;
176
+ /** The kernel release of the operating system. */
177
+ kernelRelease?: string;
178
+ /** The kernel version of the operating system. */
179
+ kernelVersion?: string;
180
+ /** The operating system long name. For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019 Datacenter'. */
181
+ longName?: string;
182
+ /** The current version of the OS Config agent running on the VM. */
183
+ osconfigAgentVersion?: string;
184
+ /** The operating system short name. For example, 'windows' or 'debian'. */
185
+ shortName?: string;
186
+ /** The version of the operating system. */
187
+ version?: string;
188
+ }
189
+ interface InventorySoftwarePackage {
190
+ /** Details of an APT package. For details about the apt package manager, see https://wiki.debian.org/Apt. */
191
+ aptPackage?: InventoryVersionedPackage;
192
+ /** Details of a COS package. */
193
+ cosPackage?: InventoryVersionedPackage;
194
+ /** Details of a Googet package. For details about the googet package manager, see https://github.com/google/googet. */
195
+ googetPackage?: InventoryVersionedPackage;
196
+ /**
197
+ * 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
198
+ * Engineering.
199
+ */
200
+ qfePackage?: InventoryWindowsQuickFixEngineeringPackage;
201
+ /** Details of Windows Application. */
202
+ windowsApplication?: InventoryWindowsApplication;
203
+ /** Details of a Windows Update package. See https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for information about Windows Update. */
204
+ wuaPackage?: InventoryWindowsUpdatePackage;
205
+ /** 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. */
206
+ yumPackage?: InventoryVersionedPackage;
207
+ /** Details of a Zypper package. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual. */
208
+ zypperPackage?: InventoryVersionedPackage;
209
+ /** Details of a Zypper patch. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual. */
210
+ zypperPatch?: InventoryZypperPatch;
211
+ }
212
+ interface InventoryVersionedPackage {
213
+ /** The system architecture this package is intended for. */
214
+ architecture?: string;
215
+ /** The name of the package. */
216
+ packageName?: string;
217
+ /** The version of the package. */
218
+ version?: string;
219
+ }
220
+ interface InventoryWindowsApplication {
221
+ /** The name of the application or product. */
222
+ displayName?: string;
223
+ /** The version of the product or application in string format. */
224
+ displayVersion?: string;
225
+ /** The internet address for technical support. */
226
+ helpLink?: string;
227
+ /**
228
+ * The last time this product received service. The value of this property is replaced each time a patch is applied or removed from the product or the command-line option is used to
229
+ * repair the product.
230
+ */
231
+ installDate?: Date;
232
+ /** The name of the manufacturer for the product or application. */
233
+ publisher?: string;
234
+ }
235
+ interface InventoryWindowsQuickFixEngineeringPackage {
236
+ /** A short textual description of the QFE update. */
237
+ caption?: string;
238
+ /** A textual description of the QFE update. */
239
+ description?: string;
240
+ /** Unique identifier associated with a particular QFE update. */
241
+ hotFixId?: string;
242
+ /** Date that the QFE update was installed. Mapped from installed_on field. */
243
+ installTime?: string;
244
+ }
245
+ interface InventoryWindowsUpdatePackage {
246
+ /** The categories that are associated with this update package. */
247
+ categories?: InventoryWindowsUpdatePackageWindowsUpdateCategory[];
248
+ /** The localized description of the update package. */
249
+ description?: string;
250
+ /** A collection of Microsoft Knowledge Base article IDs that are associated with the update package. */
251
+ kbArticleIds?: string[];
252
+ /** The last published date of the update, in (UTC) date and time. */
253
+ lastDeploymentChangeTime?: string;
254
+ /** A collection of URLs that provide more information about the update package. */
255
+ moreInfoUrls?: string[];
256
+ /** The revision number of this update package. */
257
+ revisionNumber?: number;
258
+ /** A hyperlink to the language-specific support information for the update. */
259
+ supportUrl?: string;
260
+ /** The localized title of the update package. */
261
+ title?: string;
262
+ /** Gets the identifier of an update package. Stays the same across revisions. */
263
+ updateId?: string;
264
+ }
265
+ interface InventoryWindowsUpdatePackageWindowsUpdateCategory {
266
+ /** The identifier of the windows update category. */
267
+ id?: string;
268
+ /** The name of the windows update category. */
269
+ name?: string;
270
+ }
271
+ interface InventoryZypperPatch {
272
+ /** The category of the patch. */
273
+ category?: string;
274
+ /** The name of the patch. */
275
+ patchName?: string;
276
+ /** The severity specified for this patch */
277
+ severity?: string;
278
+ /** Any summary information provided about this patch. */
279
+ summary?: string;
280
+ }
281
+ interface ListInventoriesResponse {
282
+ /** List of inventory objects. */
283
+ inventories?: Inventory[];
284
+ /** The pagination token to retrieve the next page of inventory objects. */
285
+ nextPageToken?: string;
286
+ }
287
+ interface ListOSPolicyAssignmentReportsResponse {
288
+ /** The pagination token to retrieve the next page of OS policy assignment report objects. */
289
+ nextPageToken?: string;
290
+ /** List of OS policy assignment reports. */
291
+ osPolicyAssignmentReports?: OSPolicyAssignmentReport[];
292
+ }
293
+ interface ListOSPolicyAssignmentRevisionsResponse {
294
+ /** The pagination token to retrieve the next page of OS policy assignment revisions. */
295
+ nextPageToken?: string;
296
+ /** The OS policy assignment revisions */
297
+ osPolicyAssignments?: OSPolicyAssignment[];
298
+ }
299
+ interface ListOSPolicyAssignmentsResponse {
300
+ /** The pagination token to retrieve the next page of OS policy assignments. */
301
+ nextPageToken?: string;
302
+ /** The list of assignments */
303
+ osPolicyAssignments?: OSPolicyAssignment[];
304
+ }
305
+ interface ListPatchDeploymentsResponse {
306
+ /** A pagination token that can be used to get the next page of patch deployments. */
307
+ nextPageToken?: string;
308
+ /** The list of patch deployments. */
309
+ patchDeployments?: PatchDeployment[];
310
+ }
311
+ interface ListPatchJobInstanceDetailsResponse {
312
+ /** A pagination token that can be used to get the next page of results. */
313
+ nextPageToken?: string;
314
+ /** A list of instance status. */
315
+ patchJobInstanceDetails?: PatchJobInstanceDetails[];
316
+ }
317
+ interface ListPatchJobsResponse {
318
+ /** A pagination token that can be used to get the next page of results. */
319
+ nextPageToken?: string;
320
+ /** The list of patch jobs. */
321
+ patchJobs?: PatchJob[];
322
+ }
323
+ interface ListVulnerabilityReportsResponse {
324
+ /** The pagination token to retrieve the next page of vulnerabilityReports object. */
325
+ nextPageToken?: string;
326
+ /** List of vulnerabilityReport objects. */
327
+ vulnerabilityReports?: VulnerabilityReport[];
328
+ }
329
+ interface MonthlySchedule {
330
+ /**
331
+ * 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
332
+ * schedule to run "every month on the 31st" will not run in February, April, June, etc.
333
+ */
334
+ monthDay?: number;
335
+ /** Required. Week day in a month. */
336
+ weekDayOfMonth?: WeekDayOfMonth;
337
+ }
338
+ interface OneTimeSchedule {
339
+ /** Required. The desired patch job execution time. */
340
+ executeTime?: string;
341
+ }
342
+ interface Operation {
343
+ /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
344
+ done?: boolean;
345
+ /** The error result of the operation in case of failure or cancellation. */
346
+ error?: Status;
347
+ /**
348
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
349
+ * metadata. Any method that returns a long-running operation should document the metadata type, if any.
350
+ */
351
+ metadata?: { [P in string]: any };
352
+ /**
353
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
354
+ * with `operations/{unique_id}`.
355
+ */
356
+ name?: string;
357
+ /**
358
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
359
+ * original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
360
+ * original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
361
+ */
362
+ response?: { [P in string]: any };
363
+ }
364
+ interface OSPolicy {
365
+ /**
366
+ * This flag determines the OS policy compliance status when none of the resource groups within the policy are applicable for a VM. Set this value to `true` if the policy needs to be
367
+ * reported as compliant even if the policy has nothing to validate or enforce.
368
+ */
369
+ allowNoResourceGroupMatch?: boolean;
370
+ /** Policy description. Length of the description is limited to 1024 characters. */
371
+ description?: string;
372
+ /**
373
+ * Required. The id of the OS policy with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63
374
+ * characters. * Must end with a number or a letter. * Must be unique within the assignment.
375
+ */
376
+ id?: string;
377
+ /** Required. Policy mode */
378
+ mode?: string;
379
+ /**
380
+ * Required. List of resource groups for the policy. For a particular VM, resource groups are evaluated in the order specified and the first resource group that is applicable is
381
+ * selected and the rest are ignored. If none of the resource groups are applicable for a VM, the VM is considered to be non-compliant w.r.t this policy. This behavior can be toggled
382
+ * by the flag `allow_no_resource_group_match`
383
+ */
384
+ resourceGroups?: OSPolicyResourceGroup[];
385
+ }
386
+ interface OSPolicyAssignment {
387
+ /**
388
+ * Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy
389
+ * assignment, there is only one revision with a value of `true` for this field.
390
+ */
391
+ baseline?: boolean;
392
+ /** Output only. Indicates that this revision deletes the OS policy assignment. */
393
+ deleted?: boolean;
394
+ /** OS policy assignment description. Length of the description is limited to 1024 characters. */
395
+ description?: string;
396
+ /** The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. */
397
+ etag?: string;
398
+ /** Required. Filter to select VMs. */
399
+ instanceFilter?: OSPolicyAssignmentInstanceFilter;
400
+ /** Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. */
401
+ name?: string;
402
+ /** Required. List of OS policies to be applied to the VMs. */
403
+ osPolicies?: OSPolicy[];
404
+ /** Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING */
405
+ reconciling?: boolean;
406
+ /** Output only. The timestamp that the revision was created. */
407
+ revisionCreateTime?: string;
408
+ /** Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment */
409
+ revisionId?: string;
410
+ /**
411
+ * Required. Rollout to deploy the OS policy assignment. A rollout is triggered in the following situations: 1) OSPolicyAssignment is created. 2) OSPolicyAssignment is updated and the
412
+ * update contains changes to one of the following fields: - instance_filter - os_policies 3) OSPolicyAssignment is deleted.
413
+ */
414
+ rollout?: OSPolicyAssignmentRollout;
415
+ /** Output only. OS policy assignment rollout state */
416
+ rolloutState?: string;
417
+ /** Output only. Server generated unique id for the OS policy assignment resource. */
418
+ uid?: string;
419
+ }
420
+ interface OSPolicyAssignmentInstanceFilter {
421
+ /** Target all VMs in the project. If true, no other criteria is permitted. */
422
+ all?: boolean;
423
+ /** List of label sets used for VM exclusion. If the list has more than one label set, the VM is excluded if any of the label sets are applicable for the VM. */
424
+ exclusionLabels?: OSPolicyAssignmentLabelSet[];
425
+ /** List of label sets used for VM inclusion. If the list has more than one `LabelSet`, the VM is included if any of the label sets are applicable for the VM. */
426
+ inclusionLabels?: OSPolicyAssignmentLabelSet[];
427
+ /** List of inventories to select VMs. A VM is selected if its inventory data matches at least one of the following inventories. */
428
+ inventories?: OSPolicyAssignmentInstanceFilterInventory[];
429
+ }
430
+ interface OSPolicyAssignmentInstanceFilterInventory {
431
+ /** Required. The OS short name */
432
+ osShortName?: string;
433
+ /**
434
+ * The OS version Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following
435
+ * value for this field `7.*` An empty string matches all OS versions.
436
+ */
437
+ osVersion?: string;
438
+ }
439
+ interface OSPolicyAssignmentLabelSet {
440
+ /** Labels are identified by key/value pairs in this map. A VM should contain all the key/value pairs specified in this map to be selected. */
441
+ labels?: { [P in string]: string };
442
+ }
443
+ interface OSPolicyAssignmentOperationMetadata {
444
+ /** The OS policy assignment API method. */
445
+ apiMethod?: string;
446
+ /** Reference to the `OSPolicyAssignment` API resource. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}` */
447
+ osPolicyAssignment?: string;
448
+ /** Rollout start time */
449
+ rolloutStartTime?: string;
450
+ /** State of the rollout */
451
+ rolloutState?: string;
452
+ /** Rollout update time */
453
+ rolloutUpdateTime?: string;
454
+ }
455
+ interface OSPolicyAssignmentReport {
456
+ /** The Compute Engine VM instance name. */
457
+ instance?: string;
458
+ /**
459
+ * Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM. This ID is logged by the OS Config agent while applying the OS
460
+ * policies associated with this assignment on the VM. NOTE: If the service is unable to successfully connect to the agent for this run, then this id will not be available in the agent
461
+ * logs.
462
+ */
463
+ lastRunId?: string;
464
+ /**
465
+ * The `OSPolicyAssignmentReport` API resource name. Format:
466
+ * `projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report`
467
+ */
468
+ name?: string;
469
+ /**
470
+ * Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format:
471
+ * `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}`
472
+ */
473
+ osPolicyAssignment?: string;
474
+ /** Compliance data for each `OSPolicy` that is applied to the VM. */
475
+ osPolicyCompliances?: OSPolicyAssignmentReportOSPolicyCompliance[];
476
+ /** Timestamp for when the report was last generated. */
477
+ updateTime?: string;
478
+ }
479
+ interface OSPolicyAssignmentReportOSPolicyCompliance {
480
+ /** The compliance state of the OS policy. */
481
+ complianceState?: string;
482
+ /**
483
+ * The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of
484
+ * the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support
485
+ * running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one
486
+ * or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. *
487
+ * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a
488
+ * different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered
489
+ * while attempting to apply the policy.
490
+ */
491
+ complianceStateReason?: string;
492
+ /** The OS policy id */
493
+ osPolicyId?: string;
494
+ /** Compliance data for each resource within the policy that is applied to the VM. */
495
+ osPolicyResourceCompliances?: OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance[];
496
+ }
497
+ interface OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceCompliance {
498
+ /** The compliance state of the resource. */
499
+ complianceState?: string;
500
+ /**
501
+ * A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when
502
+ * `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. *
503
+ * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. *
504
+ * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined.
505
+ */
506
+ complianceStateReason?: string;
507
+ /** Ordered list of configuration completed by the agent for the OS policy resource. */
508
+ configSteps?: OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep[];
509
+ /** ExecResource specific output. */
510
+ execResourceOutput?: OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput;
511
+ /** The ID of the OS policy resource. */
512
+ osPolicyResourceId?: string;
513
+ }
514
+ interface OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceExecResourceOutput {
515
+ /** Output from enforcement phase output file (if run). Output size is limited to 100K bytes. */
516
+ enforcementOutput?: string;
517
+ }
518
+ interface OSPolicyAssignmentReportOSPolicyComplianceOSPolicyResourceComplianceOSPolicyResourceConfigStep {
519
+ /** An error message recorded during the execution of this step. Only populated if errors were encountered during this step execution. */
520
+ errorMessage?: string;
521
+ /** Configuration step type. */
522
+ type?: string;
523
+ }
524
+ interface OSPolicyAssignmentRollout {
525
+ /** Required. The maximum number (or percentage) of VMs per zone to disrupt at any given moment. */
526
+ disruptionBudget?: FixedOrPercent;
527
+ /**
528
+ * Required. This determines the minimum duration of time to wait after the configuration changes are applied through the current rollout. A VM continues to count towards the
529
+ * `disruption_budget` at least until this duration of time has passed after configuration changes are applied.
530
+ */
531
+ minWaitDuration?: string;
532
+ }
533
+ interface OSPolicyInventoryFilter {
534
+ /** Required. The OS short name */
535
+ osShortName?: string;
536
+ /**
537
+ * The OS version Prefix matches are supported if asterisk(*) is provided as the last character. For example, to match all versions with a major version of `7`, specify the following
538
+ * value for this field `7.*` An empty string matches all OS versions.
539
+ */
540
+ osVersion?: string;
541
+ }
542
+ interface OSPolicyResource {
543
+ /** Exec resource */
544
+ exec?: OSPolicyResourceExecResource;
545
+ /** File resource */
546
+ file?: OSPolicyResourceFileResource;
547
+ /**
548
+ * Required. The id of the resource with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63
549
+ * characters. * Must end with a number or a letter. * Must be unique within the OS policy.
550
+ */
551
+ id?: string;
552
+ /** Package resource */
553
+ pkg?: OSPolicyResourcePackageResource;
554
+ /** Package repository resource */
555
+ repository?: OSPolicyResourceRepositoryResource;
556
+ }
557
+ interface OSPolicyResourceExecResource {
558
+ /** What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce. */
559
+ enforce?: OSPolicyResourceExecResourceExec;
560
+ /**
561
+ * Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any
562
+ * other exit code indicates a failure running validate.
563
+ */
564
+ validate?: OSPolicyResourceExecResourceExec;
565
+ }
566
+ interface OSPolicyResourceExecResourceExec {
567
+ /** Optional arguments to pass to the source during execution. */
568
+ args?: string[];
569
+ /** A remote or local file. */
570
+ file?: OSPolicyResourceFile;
571
+ /** Required. The script interpreter to use. */
572
+ interpreter?: string;
573
+ /**
574
+ * Only recorded for enforce Exec. Path to an output file (that is created by this Exec) whose content will be recorded in OSPolicyResourceCompliance after a successful run. Absence or
575
+ * failure to read this file will result in this ExecResource being non-compliant. Output file size is limited to 100K bytes.
576
+ */
577
+ outputFilePath?: string;
578
+ /** An inline script. The size of the script is limited to 1024 characters. */
579
+ script?: string;
580
+ }
581
+ interface OSPolicyResourceFile {
582
+ /**
583
+ * Defaults to false. When false, files are subject to validations based on the file type: Remote: A checksum must be specified. Cloud Storage: An object generation number must be
584
+ * specified.
585
+ */
586
+ allowInsecure?: boolean;
587
+ /** A Cloud Storage object. */
588
+ gcs?: OSPolicyResourceFileGcs;
589
+ /** A local path within the VM to use. */
590
+ localPath?: string;
591
+ /** A generic remote file. */
592
+ remote?: OSPolicyResourceFileRemote;
593
+ }
594
+ interface OSPolicyResourceFileGcs {
595
+ /** Required. Bucket of the Cloud Storage object. */
596
+ bucket?: string;
597
+ /** Generation number of the Cloud Storage object. */
598
+ generation?: string;
599
+ /** Required. Name of the Cloud Storage object. */
600
+ object?: string;
601
+ }
602
+ interface OSPolicyResourceFileRemote {
603
+ /** SHA256 checksum of the remote file. */
604
+ sha256Checksum?: string;
605
+ /** Required. URI from which to fetch the object. It should contain both the protocol and path following the format `{protocol}://{location}`. */
606
+ uri?: string;
607
+ }
608
+ interface OSPolicyResourceFileResource {
609
+ /** A a file with this content. The size of the content is limited to 1024 characters. */
610
+ content?: string;
611
+ /** A remote or local source. */
612
+ file?: OSPolicyResourceFile;
613
+ /** Required. The absolute path of the file within the VM. */
614
+ path?: string;
615
+ /**
616
+ * Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod
617
+ * utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the
618
+ * execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6
619
+ * read only: 4
620
+ */
621
+ permissions?: string;
622
+ /** Required. Desired state of the file. */
623
+ state?: string;
624
+ }
625
+ interface OSPolicyResourceGroup {
626
+ /**
627
+ * List of inventory filters for the resource group. The resources in this resource group are applied to the target VM if it satisfies at least one of the following inventory filters.
628
+ * For example, to apply this resource group to VMs running either `RHEL` or `CentOS` operating systems, specify 2 items for the list with following values:
629
+ * inventory_filters[0].os_short_name='rhel' and inventory_filters[1].os_short_name='centos' If the list is empty, this resource group will be applied to the target VM unconditionally.
630
+ */
631
+ inventoryFilters?: OSPolicyInventoryFilter[];
632
+ /** Required. List of resources configured for this resource group. The resources are executed in the exact order specified here. */
633
+ resources?: OSPolicyResource[];
634
+ }
635
+ interface OSPolicyResourcePackageResource {
636
+ /** A package managed by Apt. */
637
+ apt?: OSPolicyResourcePackageResourceAPT;
638
+ /** A deb package file. */
639
+ deb?: OSPolicyResourcePackageResourceDeb;
640
+ /** Required. The desired state the agent should maintain for this package. */
641
+ desiredState?: string;
642
+ /** A package managed by GooGet. */
643
+ googet?: OSPolicyResourcePackageResourceGooGet;
644
+ /** An MSI package. */
645
+ msi?: OSPolicyResourcePackageResourceMSI;
646
+ /** An rpm package file. */
647
+ rpm?: OSPolicyResourcePackageResourceRPM;
648
+ /** A package managed by YUM. */
649
+ yum?: OSPolicyResourcePackageResourceYUM;
650
+ /** A package managed by Zypper. */
651
+ zypper?: OSPolicyResourcePackageResourceZypper;
652
+ }
653
+ interface OSPolicyResourcePackageResourceAPT {
654
+ /** Required. Package name. */
655
+ name?: string;
656
+ }
657
+ interface OSPolicyResourcePackageResourceDeb {
658
+ /** Whether dependencies should also be installed. - install when false: `dpkg -i package` - install when true: `apt-get update && apt-get -y install package.deb` */
659
+ pullDeps?: boolean;
660
+ /** Required. A deb package. */
661
+ source?: OSPolicyResourceFile;
662
+ }
663
+ interface OSPolicyResourcePackageResourceGooGet {
664
+ /** Required. Package name. */
665
+ name?: string;
666
+ }
667
+ interface OSPolicyResourcePackageResourceMSI {
668
+ /** Additional properties to use during installation. This should be in the format of Property=Setting. Appended to the defaults of `ACTION=INSTALL REBOOT=ReallySuppress`. */
669
+ properties?: string[];
670
+ /** Required. The MSI package. */
671
+ source?: OSPolicyResourceFile;
672
+ }
673
+ interface OSPolicyResourcePackageResourceRPM {
674
+ /**
675
+ * Whether dependencies should also be installed. - install when false: `rpm --upgrade --replacepkgs package.rpm` - install when true: `yum -y install package.rpm` or `zypper -y
676
+ * install package.rpm`
677
+ */
678
+ pullDeps?: boolean;
679
+ /** Required. An rpm package. */
680
+ source?: OSPolicyResourceFile;
681
+ }
682
+ interface OSPolicyResourcePackageResourceYUM {
683
+ /** Required. Package name. */
684
+ name?: string;
685
+ }
686
+ interface OSPolicyResourcePackageResourceZypper {
687
+ /** Required. Package name. */
688
+ name?: string;
689
+ }
690
+ interface OSPolicyResourceRepositoryResource {
691
+ /** An Apt Repository. */
692
+ apt?: OSPolicyResourceRepositoryResourceAptRepository;
693
+ /** A Goo Repository. */
694
+ goo?: OSPolicyResourceRepositoryResourceGooRepository;
695
+ /** A Yum Repository. */
696
+ yum?: OSPolicyResourceRepositoryResourceYumRepository;
697
+ /** A Zypper Repository. */
698
+ zypper?: OSPolicyResourceRepositoryResourceZypperRepository;
699
+ }
700
+ interface OSPolicyResourceRepositoryResourceAptRepository {
701
+ /** Required. Type of archive files in this repository. */
702
+ archiveType?: string;
703
+ /** Required. List of components for this repository. Must contain at least one item. */
704
+ components?: string[];
705
+ /** Required. Distribution of this repository. */
706
+ distribution?: string;
707
+ /** URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg`. */
708
+ gpgKey?: string;
709
+ /** Required. URI for this repository. */
710
+ uri?: string;
711
+ }
712
+ interface OSPolicyResourceRepositoryResourceGooRepository {
713
+ /** Required. The name of the repository. */
714
+ name?: string;
715
+ /** Required. The url of the repository. */
716
+ url?: string;
717
+ }
718
+ interface OSPolicyResourceRepositoryResourceYumRepository {
719
+ /** Required. The location of the repository directory. */
720
+ baseUrl?: string;
721
+ /** The display name of the repository. */
722
+ displayName?: string;
723
+ /** URIs of GPG keys. */
724
+ gpgKeys?: string[];
725
+ /**
726
+ * Required. A one word, unique name for this repository. This is the `repo id` in the yum config file and also the `display_name` if `display_name` is omitted. This id is also used as
727
+ * the unique identifier when checking for resource conflicts.
728
+ */
729
+ id?: string;
730
+ }
731
+ interface OSPolicyResourceRepositoryResourceZypperRepository {
732
+ /** Required. The location of the repository directory. */
733
+ baseUrl?: string;
734
+ /** The display name of the repository. */
735
+ displayName?: string;
736
+ /** URIs of GPG keys. */
737
+ gpgKeys?: string[];
738
+ /**
739
+ * Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used
740
+ * as the unique identifier when checking for GuestPolicy conflicts.
741
+ */
742
+ id?: string;
743
+ }
744
+ interface PatchConfig {
745
+ /** Apt update settings. Use this setting to override the default `apt` patch rules. */
746
+ apt?: AptSettings;
747
+ /** Goo update settings. Use this setting to override the default `goo` patch rules. */
748
+ goo?: any;
749
+ /** Allows the patch job to run on Managed instance groups (MIGs). */
750
+ migInstancesAllowed?: boolean;
751
+ /** The `ExecStep` to run after the patch update. */
752
+ postStep?: ExecStep;
753
+ /** The `ExecStep` to run before the patch update. */
754
+ preStep?: ExecStep;
755
+ /** Post-patch reboot settings. */
756
+ rebootConfig?: string;
757
+ /** Windows update settings. Use this override the default windows patch rules. */
758
+ windowsUpdate?: WindowsUpdateSettings;
759
+ /** Yum update settings. Use this setting to override the default `yum` patch rules. */
760
+ yum?: YumSettings;
761
+ /** Zypper update settings. Use this setting to override the default `zypper` patch rules. */
762
+ zypper?: ZypperSettings;
763
+ }
764
+ interface PatchDeployment {
765
+ /** Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */
766
+ createTime?: string;
767
+ /** Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. */
768
+ description?: string;
769
+ /** Optional. Duration of the patch. After the duration ends, the patch times out. */
770
+ duration?: string;
771
+ /** Required. VM instances to patch. */
772
+ instanceFilter?: PatchInstanceFilter;
773
+ /** 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. */
774
+ lastExecuteTime?: string;
775
+ /**
776
+ * 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
777
+ * ignored when you create a new patch deployment.
778
+ */
779
+ name?: string;
780
+ /** Required. Schedule a one-time execution. */
781
+ oneTimeSchedule?: OneTimeSchedule;
782
+ /** Optional. Patch configuration that is applied. */
783
+ patchConfig?: PatchConfig;
784
+ /** Required. Schedule recurring executions. */
785
+ recurringSchedule?: RecurringSchedule;
786
+ /** Optional. Rollout strategy of the patch job. */
787
+ rollout?: PatchRollout;
788
+ /** Output only. Current state of the patch deployment. */
789
+ state?: string;
790
+ /** Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */
791
+ updateTime?: string;
792
+ }
793
+ interface PatchInstanceFilter {
794
+ /** Target all VM instances in the project. If true, no other criteria is permitted. */
795
+ all?: boolean;
796
+ /** Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. */
797
+ groupLabels?: PatchInstanceFilterGroupLabel[];
798
+ /** 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-". */
799
+ instanceNamePrefixes?: string[];
800
+ /**
801
+ * Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`,
802
+ * `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`
803
+ */
804
+ instances?: string[];
805
+ /** Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. */
806
+ zones?: string[];
807
+ }
808
+ interface PatchInstanceFilterGroupLabel {
809
+ /** Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. */
810
+ labels?: { [P in string]: string };
811
+ }
812
+ interface PatchJob {
813
+ /** Time this patch job was created. */
814
+ createTime?: string;
815
+ /** Description of the patch job. Length of the description is limited to 1024 characters. */
816
+ description?: string;
817
+ /** Display name for this patch job. This is not a unique identifier. */
818
+ displayName?: string;
819
+ /** If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. */
820
+ dryRun?: boolean;
821
+ /** Duration of the patch job. After the duration ends, the patch job times out. */
822
+ duration?: string;
823
+ /** If this patch job failed, this message provides information about the failure. */
824
+ errorMessage?: string;
825
+ /** Summary of instance details. */
826
+ instanceDetailsSummary?: PatchJobInstanceDetailsSummary;
827
+ /** Instances to patch. */
828
+ instanceFilter?: PatchInstanceFilter;
829
+ /** Unique identifier for this patch job in the form `projects/*‍/patchJobs/*` */
830
+ name?: string;
831
+ /** Patch configuration being applied. */
832
+ patchConfig?: PatchConfig;
833
+ /** Output only. Name of the patch deployment that created this patch job. */
834
+ patchDeployment?: string;
835
+ /** Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. */
836
+ percentComplete?: number;
837
+ /** Rollout strategy being applied. */
838
+ rollout?: PatchRollout;
839
+ /** The current state of the PatchJob. */
840
+ state?: string;
841
+ /** Last time this patch job was updated. */
842
+ updateTime?: string;
843
+ }
844
+ interface PatchJobInstanceDetails {
845
+ /** The number of times the agent that the agent attempts to apply the patch. */
846
+ attemptCount?: string;
847
+ /** If the patch fails, this field provides the reason. */
848
+ failureReason?: string;
849
+ /** The unique identifier for the instance. This identifier is defined by the server. */
850
+ instanceSystemId?: string;
851
+ /** The instance name in the form `projects/*‍/zones/*‍/instances/*` */
852
+ name?: string;
853
+ /** Current state of instance patch. */
854
+ state?: string;
855
+ }
856
+ interface PatchJobInstanceDetailsSummary {
857
+ /** Number of instances that have acked and will start shortly. */
858
+ ackedInstanceCount?: string;
859
+ /** Number of instances that are applying patches. */
860
+ applyingPatchesInstanceCount?: string;
861
+ /** Number of instances that are downloading patches. */
862
+ downloadingPatchesInstanceCount?: string;
863
+ /** Number of instances that failed. */
864
+ failedInstanceCount?: string;
865
+ /** Number of instances that are inactive. */
866
+ inactiveInstanceCount?: string;
867
+ /** 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. */
868
+ noAgentDetectedInstanceCount?: string;
869
+ /** Number of instances notified about patch job. */
870
+ notifiedInstanceCount?: string;
871
+ /** Number of instances pending patch job. */
872
+ pendingInstanceCount?: string;
873
+ /** Number of instances that are running the post-patch step. */
874
+ postPatchStepInstanceCount?: string;
875
+ /** Number of instances that are running the pre-patch step. */
876
+ prePatchStepInstanceCount?: string;
877
+ /** Number of instances rebooting. */
878
+ rebootingInstanceCount?: string;
879
+ /** Number of instances that have started. */
880
+ startedInstanceCount?: string;
881
+ /** Number of instances that have completed successfully. */
882
+ succeededInstanceCount?: string;
883
+ /** Number of instances that require reboot. */
884
+ succeededRebootRequiredInstanceCount?: string;
885
+ /** Number of instances that exceeded the time out while applying the patch. */
886
+ timedOutInstanceCount?: string;
887
+ }
888
+ interface PatchRollout {
889
+ /**
890
+ * 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
891
+ * 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
892
+ * 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
893
+ * 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.
894
+ * 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
895
+ * 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
896
+ * 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
897
+ * stops.
898
+ */
899
+ disruptionBudget?: FixedOrPercent;
900
+ /** Mode of the patch rollout. */
901
+ mode?: string;
902
+ }
903
+ // tslint:disable-next-line:no-empty-interface
904
+ interface PausePatchDeploymentRequest {
905
+ }
906
+ interface RecurringSchedule {
907
+ /** Optional. The end time at which a recurring patch deployment schedule is no longer active. */
908
+ endTime?: string;
909
+ /** Required. The frequency unit of this recurring schedule. */
910
+ frequency?: string;
911
+ /** Output only. The time the last patch job ran successfully. */
912
+ lastExecuteTime?: string;
913
+ /** Required. Schedule with monthly executions. */
914
+ monthly?: MonthlySchedule;
915
+ /** Output only. The time the next patch job is scheduled to run. */
916
+ nextExecuteTime?: string;
917
+ /** Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. */
918
+ startTime?: string;
919
+ /** Required. Time of the day to run a recurring deployment. */
920
+ timeOfDay?: TimeOfDay;
921
+ /** 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. */
922
+ timeZone?: TimeZone;
923
+ /** Required. Schedule with weekly executions. */
924
+ weekly?: WeeklySchedule;
925
+ }
926
+ // tslint:disable-next-line:no-empty-interface
927
+ interface ResumePatchDeploymentRequest {
928
+ }
929
+ interface Status {
930
+ /** The status code, which should be an enum value of google.rpc.Code. */
931
+ code?: number;
932
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
933
+ details?: Array<{ [P in string]: any }>;
934
+ /**
935
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
936
+ * client.
937
+ */
938
+ message?: string;
939
+ }
940
+ interface TimeOfDay {
941
+ /** 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. */
942
+ hours?: number;
943
+ /** Minutes of hour of day. Must be from 0 to 59. */
944
+ minutes?: number;
945
+ /** Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */
946
+ nanos?: number;
947
+ /** 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. */
948
+ seconds?: number;
949
+ }
950
+ interface TimeZone {
951
+ /** IANA Time Zone Database time zone, e.g. "America/New_York". */
952
+ id?: string;
953
+ /** Optional. IANA Time Zone Database version number, e.g. "2019a". */
954
+ version?: string;
955
+ }
956
+ interface VulnerabilityReport {
957
+ /** Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport` */
958
+ name?: string;
959
+ /** Output only. The timestamp for when the last vulnerability report was generated for the VM. */
960
+ updateTime?: string;
961
+ /** Output only. List of vulnerabilities affecting the VM. */
962
+ vulnerabilities?: VulnerabilityReportVulnerability[];
963
+ }
964
+ interface VulnerabilityReportVulnerability {
965
+ /**
966
+ * Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM
967
+ * inventory. If there is no available fix, the field is empty. The `inventory_item` value specifies the latest `SoftwarePackage` available to the VM that fixes the vulnerability.
968
+ */
969
+ availableInventoryItemIds?: string[];
970
+ /** The timestamp for when the vulnerability was first detected. */
971
+ createTime?: string;
972
+ /** Contains metadata as per the upstream feed of the operating system and NVD. */
973
+ details?: VulnerabilityReportVulnerabilityDetails;
974
+ /**
975
+ * Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM. This field displays the inventory items affected by this vulnerability. If the vulnerability report was not updated
976
+ * after the VM inventory update, these values might not display in VM inventory. For some distros, this field may be empty.
977
+ */
978
+ installedInventoryItemIds?: string[];
979
+ /** List of items affected by the vulnerability. */
980
+ items?: VulnerabilityReportVulnerabilityItem[];
981
+ /** The timestamp for when the vulnerability was last modified. */
982
+ updateTime?: string;
983
+ }
984
+ interface VulnerabilityReportVulnerabilityDetails {
985
+ /** The CVE of the vulnerability. CVE cannot be empty and the combination of should be unique across vulnerabilities for a VM. */
986
+ cve?: string;
987
+ /** The CVSS V2 score of this vulnerability. CVSS V2 score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity. */
988
+ cvssV2Score?: number;
989
+ /** The full description of the CVSSv3 for this vulnerability from NVD. */
990
+ cvssV3?: CVSSv3;
991
+ /** The note or description describing the vulnerability from the distro. */
992
+ description?: string;
993
+ /** Corresponds to the references attached to the `VulnerabilityDetails`. */
994
+ references?: VulnerabilityReportVulnerabilityDetailsReference[];
995
+ /** Assigned severity/impact ranking from the distro. */
996
+ severity?: string;
997
+ }
998
+ interface VulnerabilityReportVulnerabilityDetailsReference {
999
+ /** The source of the reference e.g. NVD. */
1000
+ source?: string;
1001
+ /** The url of the reference. */
1002
+ url?: string;
1003
+ }
1004
+ interface VulnerabilityReportVulnerabilityItem {
1005
+ /**
1006
+ * Corresponds to the `AVAILABLE_PACKAGE` inventory item on the VM. If the vulnerability report was not updated after the VM inventory update, these values might not display in VM
1007
+ * inventory. If there is no available fix, the field is empty. The `inventory_item` value specifies the latest `SoftwarePackage` available to the VM that fixes the vulnerability.
1008
+ */
1009
+ availableInventoryItemId?: string;
1010
+ /** The recommended [CPE URI](https://cpe.mitre.org/specification/) update that contains a fix for this vulnerability. */
1011
+ fixedCpeUri?: string;
1012
+ /**
1013
+ * Corresponds to the `INSTALLED_PACKAGE` inventory item on the VM. This field displays the inventory items affected by this vulnerability. If the vulnerability report was not updated
1014
+ * after the VM inventory update, these values might not display in VM inventory. For some operating systems, this field might be empty.
1015
+ */
1016
+ installedInventoryItemId?: string;
1017
+ /** The upstream OS patch, packages or KB that fixes the vulnerability. */
1018
+ upstreamFix?: string;
1019
+ }
1020
+ interface WeekDayOfMonth {
1021
+ /**
1022
+ * Optional. Represents the number of days before or after the given week day of month that the patch deployment is scheduled for. For example if `week_ordinal` and `day_of_week`
1023
+ * values point to the second day of the month and this `day_offset` value is set to `3`, the patch deployment takes place three days after the second Tuesday of the month. If this
1024
+ * value is negative, for example -5, the patches are deployed five days before before the second Tuesday of the month. Allowed values are in range [-30, 30].
1025
+ */
1026
+ dayOffset?: number;
1027
+ /** Required. A day of the week. */
1028
+ dayOfWeek?: string;
1029
+ /** 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. */
1030
+ weekOrdinal?: number;
1031
+ }
1032
+ interface WeeklySchedule {
1033
+ /** Required. Day of the week. */
1034
+ dayOfWeek?: string;
1035
+ }
1036
+ interface WindowsUpdateSettings {
1037
+ /** Only apply updates of these windows update classifications. If empty, all updates are applied. */
1038
+ classifications?: string[];
1039
+ /** List of KBs to exclude from update. */
1040
+ excludes?: string[];
1041
+ /** 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. */
1042
+ exclusivePatches?: string[];
1043
+ }
1044
+ interface YumSettings {
1045
+ /** List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. */
1046
+ excludes?: string[];
1047
+ /**
1048
+ * 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
1049
+ * specified with any other patch configuration fields.
1050
+ */
1051
+ exclusivePackages?: string[];
1052
+ /** Will cause patch to run `yum update-minimal` instead. */
1053
+ minimal?: boolean;
1054
+ /** Adds the `--security` flag to `yum update`. Not supported on all platforms. */
1055
+ security?: boolean;
1056
+ }
1057
+ interface ZypperSettings {
1058
+ /** Install only patches with these categories. Common categories include security, recommended, and feature. */
1059
+ categories?: string[];
1060
+ /** List of patches to exclude from update. */
1061
+ excludes?: string[];
1062
+ /**
1063
+ * 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
1064
+ * configuration fields.
1065
+ */
1066
+ exclusivePatches?: string[];
1067
+ /** Install only patches with these severities. Common severities include critical, important, moderate, and low. */
1068
+ severities?: string[];
1069
+ /** Adds the `--with-optional` flag to `zypper patch`. */
1070
+ withOptional?: boolean;
1071
+ /** Adds the `--with-update` flag, to `zypper patch`. */
1072
+ withUpdate?: boolean;
1073
+ }
1074
+ interface InventoriesResource {
1075
+ /** Get inventory data for the specified VM instance. If the VM has no associated inventory, the message `NOT_FOUND` is returned. */
1076
+ get(request?: {
1077
+ /** V1 error format. */
1078
+ "$.xgafv"?: string;
1079
+ /** OAuth access token. */
1080
+ access_token?: string;
1081
+ /** Data format for response. */
1082
+ alt?: string;
1083
+ /** JSONP */
1084
+ callback?: string;
1085
+ /** Selector specifying which fields to include in a partial response. */
1086
+ fields?: string;
1087
+ /** 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. */
1088
+ key?: string;
1089
+ /**
1090
+ * Required. API resource name for inventory resource. Format: `projects/{project}/locations/{location}/instances/{instance}/inventory` For `{project}`, either `project-number` or
1091
+ * `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.
1092
+ */
1093
+ name: string;
1094
+ /** OAuth 2.0 token for the current user. */
1095
+ oauth_token?: string;
1096
+ /** Returns response with indentations and line breaks. */
1097
+ prettyPrint?: boolean;
1098
+ /** 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. */
1099
+ quotaUser?: string;
1100
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1101
+ upload_protocol?: string;
1102
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1103
+ uploadType?: string;
1104
+ /** Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC. */
1105
+ view?: string;
1106
+ }): Request<Inventory>;
1107
+ /** List inventory data for all VM instances in the specified zone. */
1108
+ list(request?: {
1109
+ /** V1 error format. */
1110
+ "$.xgafv"?: string;
1111
+ /** OAuth access token. */
1112
+ access_token?: string;
1113
+ /** Data format for response. */
1114
+ alt?: string;
1115
+ /** JSONP */
1116
+ callback?: string;
1117
+ /** Selector specifying which fields to include in a partial response. */
1118
+ fields?: string;
1119
+ /** If provided, this field specifies the criteria that must be met by a `Inventory` API resource to be included in the response. */
1120
+ filter?: string;
1121
+ /** 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. */
1122
+ key?: string;
1123
+ /** OAuth 2.0 token for the current user. */
1124
+ oauth_token?: string;
1125
+ /** The maximum number of results to return. */
1126
+ pageSize?: number;
1127
+ /** A pagination token returned from a previous call to `ListInventories` that indicates where this listing should continue from. */
1128
+ pageToken?: string;
1129
+ /** Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided. */
1130
+ parent: string;
1131
+ /** Returns response with indentations and line breaks. */
1132
+ prettyPrint?: boolean;
1133
+ /** 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. */
1134
+ quotaUser?: string;
1135
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1136
+ upload_protocol?: string;
1137
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1138
+ uploadType?: string;
1139
+ /** Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC. */
1140
+ view?: string;
1141
+ }): Request<ListInventoriesResponse>;
1142
+ }
1143
+ interface ReportsResource {
1144
+ /** Get the OS policy asssignment report for the specified Compute Engine VM instance. */
1145
+ get(request?: {
1146
+ /** V1 error format. */
1147
+ "$.xgafv"?: string;
1148
+ /** OAuth access token. */
1149
+ access_token?: string;
1150
+ /** Data format for response. */
1151
+ alt?: string;
1152
+ /** JSONP */
1153
+ callback?: string;
1154
+ /** Selector specifying which fields to include in a partial response. */
1155
+ fields?: string;
1156
+ /** 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. */
1157
+ key?: string;
1158
+ /**
1159
+ * Required. API resource name for OS policy assignment report. Format: `/projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report` For
1160
+ * `{project}`, either `project-number` or `project-id` can be provided. For `{instance_id}`, either Compute Engine `instance-id` or `instance-name` can be provided. For
1161
+ * `{assignment_id}`, the OSPolicyAssignment id must be provided.
1162
+ */
1163
+ name: string;
1164
+ /** OAuth 2.0 token for the current user. */
1165
+ oauth_token?: string;
1166
+ /** Returns response with indentations and line breaks. */
1167
+ prettyPrint?: boolean;
1168
+ /** 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. */
1169
+ quotaUser?: string;
1170
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1171
+ upload_protocol?: string;
1172
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1173
+ uploadType?: string;
1174
+ }): Request<OSPolicyAssignmentReport>;
1175
+ /** List OS policy asssignment reports for all Compute Engine VM instances in the specified zone. */
1176
+ list(request?: {
1177
+ /** V1 error format. */
1178
+ "$.xgafv"?: string;
1179
+ /** OAuth access token. */
1180
+ access_token?: string;
1181
+ /** Data format for response. */
1182
+ alt?: string;
1183
+ /** JSONP */
1184
+ callback?: string;
1185
+ /** Selector specifying which fields to include in a partial response. */
1186
+ fields?: string;
1187
+ /** If provided, this field specifies the criteria that must be met by the `OSPolicyAssignmentReport` API resource that is included in the response. */
1188
+ filter?: string;
1189
+ /** 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. */
1190
+ key?: string;
1191
+ /** OAuth 2.0 token for the current user. */
1192
+ oauth_token?: string;
1193
+ /** The maximum number of results to return. */
1194
+ pageSize?: number;
1195
+ /** A pagination token returned from a previous call to the `ListOSPolicyAssignmentReports` method that indicates where this listing should continue from. */
1196
+ pageToken?: string;
1197
+ /**
1198
+ * Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports` For `{project}`, either
1199
+ * `project-number` or `project-id` can be provided. For `{instance}`, either `instance-name`, `instance-id`, or `-` can be provided. If '-' is provided, the response will include
1200
+ * OSPolicyAssignmentReports for all instances in the project/location. For `{assignment}`, either `assignment-id` or `-` can be provided. If '-' is provided, the response will
1201
+ * include OSPolicyAssignmentReports for all OSPolicyAssignments in the project/location. Either {instance} or {assignment} must be `-`. For example:
1202
+ * `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports` returns all reports for the instance
1203
+ * `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports` returns all the reports for the given assignment across all instances.
1204
+ * `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports` returns all the reports for all assignments across all instances.
1205
+ */
1206
+ parent: string;
1207
+ /** Returns response with indentations and line breaks. */
1208
+ prettyPrint?: boolean;
1209
+ /** 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. */
1210
+ quotaUser?: string;
1211
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1212
+ upload_protocol?: string;
1213
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1214
+ uploadType?: string;
1215
+ }): Request<ListOSPolicyAssignmentReportsResponse>;
1216
+ }
1217
+ interface OsPolicyAssignmentsResource {
1218
+ reports: ReportsResource;
1219
+ }
1220
+ interface VulnerabilityReportsResource {
1221
+ /** Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them. */
1222
+ get(request?: {
1223
+ /** V1 error format. */
1224
+ "$.xgafv"?: string;
1225
+ /** OAuth access token. */
1226
+ access_token?: string;
1227
+ /** Data format for response. */
1228
+ alt?: string;
1229
+ /** JSONP */
1230
+ callback?: string;
1231
+ /** Selector specifying which fields to include in a partial response. */
1232
+ fields?: string;
1233
+ /** 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. */
1234
+ key?: string;
1235
+ /**
1236
+ * Required. API resource name for vulnerability resource. Format: `projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport` For `{project}`, either
1237
+ * `project-number` or `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.
1238
+ */
1239
+ name: string;
1240
+ /** OAuth 2.0 token for the current user. */
1241
+ oauth_token?: string;
1242
+ /** Returns response with indentations and line breaks. */
1243
+ prettyPrint?: boolean;
1244
+ /** 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. */
1245
+ quotaUser?: string;
1246
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1247
+ upload_protocol?: string;
1248
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1249
+ uploadType?: string;
1250
+ }): Request<VulnerabilityReport>;
1251
+ /** List vulnerability reports for all VM instances in the specified zone. */
1252
+ list(request?: {
1253
+ /** V1 error format. */
1254
+ "$.xgafv"?: string;
1255
+ /** OAuth access token. */
1256
+ access_token?: string;
1257
+ /** Data format for response. */
1258
+ alt?: string;
1259
+ /** JSONP */
1260
+ callback?: string;
1261
+ /** Selector specifying which fields to include in a partial response. */
1262
+ fields?: string;
1263
+ /**
1264
+ * This field supports filtering by the severity level for the vulnerability. For a list of severity levels, see [Severity levels for
1265
+ * vulnerabilities](https://cloud.google.com/container-analysis/docs/container-scanning-overview#severity_levels_for_vulnerabilities). The filter field follows the rules described
1266
+ * in the [AIP-160](https://google.aip.dev/160) guidelines as follows: + **Filter for a specific severity type**: you can list reports that contain vulnerabilities that are
1267
+ * classified as medium by specifying `vulnerabilities.details.severity:MEDIUM`. + **Filter for a range of severities** : you can list reports that have vulnerabilities that are
1268
+ * classified as critical or high by specifying `vulnerabilities.details.severity:HIGH OR vulnerabilities.details.severity:CRITICAL`
1269
+ */
1270
+ filter?: string;
1271
+ /** 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. */
1272
+ key?: string;
1273
+ /** OAuth 2.0 token for the current user. */
1274
+ oauth_token?: string;
1275
+ /** The maximum number of results to return. */
1276
+ pageSize?: number;
1277
+ /** A pagination token returned from a previous call to `ListVulnerabilityReports` that indicates where this listing should continue from. */
1278
+ pageToken?: string;
1279
+ /** Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided. */
1280
+ parent: string;
1281
+ /** Returns response with indentations and line breaks. */
1282
+ prettyPrint?: boolean;
1283
+ /** 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. */
1284
+ quotaUser?: string;
1285
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1286
+ upload_protocol?: string;
1287
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1288
+ uploadType?: string;
1289
+ }): Request<ListVulnerabilityReportsResponse>;
1290
+ }
1291
+ interface InstancesResource {
1292
+ inventories: InventoriesResource;
1293
+ osPolicyAssignments: OsPolicyAssignmentsResource;
1294
+ vulnerabilityReports: VulnerabilityReportsResource;
1295
+ }
1296
+ interface OperationsResource {
1297
+ /**
1298
+ * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
1299
+ * this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
1300
+ * operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
1301
+ * google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
1302
+ */
1303
+ cancel(request: {
1304
+ /** V1 error format. */
1305
+ "$.xgafv"?: string;
1306
+ /** OAuth access token. */
1307
+ access_token?: string;
1308
+ /** Data format for response. */
1309
+ alt?: string;
1310
+ /** JSONP */
1311
+ callback?: string;
1312
+ /** Selector specifying which fields to include in a partial response. */
1313
+ fields?: string;
1314
+ /** 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. */
1315
+ key?: string;
1316
+ /** The name of the operation resource to be cancelled. */
1317
+ name: string;
1318
+ /** OAuth 2.0 token for the current user. */
1319
+ oauth_token?: string;
1320
+ /** Returns response with indentations and line breaks. */
1321
+ prettyPrint?: boolean;
1322
+ /** 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. */
1323
+ quotaUser?: string;
1324
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1325
+ upload_protocol?: string;
1326
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1327
+ uploadType?: string;
1328
+ /** Request body */
1329
+ resource: CancelOperationRequest;
1330
+ }): Request<{}>;
1331
+ cancel(request: {
1332
+ /** V1 error format. */
1333
+ "$.xgafv"?: string;
1334
+ /** OAuth access token. */
1335
+ access_token?: string;
1336
+ /** Data format for response. */
1337
+ alt?: string;
1338
+ /** JSONP */
1339
+ callback?: string;
1340
+ /** Selector specifying which fields to include in a partial response. */
1341
+ fields?: string;
1342
+ /** 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. */
1343
+ key?: string;
1344
+ /** The name of the operation resource to be cancelled. */
1345
+ name: string;
1346
+ /** OAuth 2.0 token for the current user. */
1347
+ oauth_token?: string;
1348
+ /** Returns response with indentations and line breaks. */
1349
+ prettyPrint?: boolean;
1350
+ /** 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. */
1351
+ quotaUser?: string;
1352
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1353
+ upload_protocol?: string;
1354
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1355
+ uploadType?: string;
1356
+ },
1357
+ body: CancelOperationRequest): Request<{}>;
1358
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
1359
+ get(request?: {
1360
+ /** V1 error format. */
1361
+ "$.xgafv"?: string;
1362
+ /** OAuth access token. */
1363
+ access_token?: string;
1364
+ /** Data format for response. */
1365
+ alt?: string;
1366
+ /** JSONP */
1367
+ callback?: string;
1368
+ /** Selector specifying which fields to include in a partial response. */
1369
+ fields?: string;
1370
+ /** 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. */
1371
+ key?: string;
1372
+ /** The name of the operation resource. */
1373
+ name: string;
1374
+ /** OAuth 2.0 token for the current user. */
1375
+ oauth_token?: string;
1376
+ /** Returns response with indentations and line breaks. */
1377
+ prettyPrint?: boolean;
1378
+ /** 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. */
1379
+ quotaUser?: string;
1380
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1381
+ upload_protocol?: string;
1382
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1383
+ uploadType?: string;
1384
+ }): Request<Operation>;
1385
+ }
1386
+ interface OsPolicyAssignmentsResource {
1387
+ /**
1388
+ * Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout
1389
+ * details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method:
1390
+ * projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
1391
+ */
1392
+ create(request: {
1393
+ /** V1 error format. */
1394
+ "$.xgafv"?: string;
1395
+ /** OAuth access token. */
1396
+ access_token?: string;
1397
+ /** Data format for response. */
1398
+ alt?: string;
1399
+ /** JSONP */
1400
+ callback?: string;
1401
+ /** Selector specifying which fields to include in a partial response. */
1402
+ fields?: string;
1403
+ /** 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. */
1404
+ key?: string;
1405
+ /** OAuth 2.0 token for the current user. */
1406
+ oauth_token?: string;
1407
+ /**
1408
+ * Required. The logical name of the OS policy assignment in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start
1409
+ * with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
1410
+ */
1411
+ osPolicyAssignmentId?: string;
1412
+ /** Required. The parent resource name in the form: projects/{project}/locations/{location} */
1413
+ parent: string;
1414
+ /** Returns response with indentations and line breaks. */
1415
+ prettyPrint?: boolean;
1416
+ /** 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. */
1417
+ quotaUser?: string;
1418
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1419
+ upload_protocol?: string;
1420
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1421
+ uploadType?: string;
1422
+ /** Request body */
1423
+ resource: OSPolicyAssignment;
1424
+ }): Request<Operation>;
1425
+ create(request: {
1426
+ /** V1 error format. */
1427
+ "$.xgafv"?: string;
1428
+ /** OAuth access token. */
1429
+ access_token?: string;
1430
+ /** Data format for response. */
1431
+ alt?: string;
1432
+ /** JSONP */
1433
+ callback?: string;
1434
+ /** Selector specifying which fields to include in a partial response. */
1435
+ fields?: string;
1436
+ /** 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. */
1437
+ key?: string;
1438
+ /** OAuth 2.0 token for the current user. */
1439
+ oauth_token?: string;
1440
+ /**
1441
+ * Required. The logical name of the OS policy assignment in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start
1442
+ * with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
1443
+ */
1444
+ osPolicyAssignmentId?: string;
1445
+ /** Required. The parent resource name in the form: projects/{project}/locations/{location} */
1446
+ parent: string;
1447
+ /** Returns response with indentations and line breaks. */
1448
+ prettyPrint?: boolean;
1449
+ /** 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. */
1450
+ quotaUser?: string;
1451
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1452
+ upload_protocol?: string;
1453
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1454
+ uploadType?: string;
1455
+ },
1456
+ body: OSPolicyAssignment): Request<Operation>;
1457
+ /**
1458
+ * Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout
1459
+ * details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more
1460
+ * information, see [Method:
1461
+ * projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
1462
+ */
1463
+ delete(request?: {
1464
+ /** V1 error format. */
1465
+ "$.xgafv"?: string;
1466
+ /** OAuth access token. */
1467
+ access_token?: string;
1468
+ /** Data format for response. */
1469
+ alt?: string;
1470
+ /** JSONP */
1471
+ callback?: string;
1472
+ /** Selector specifying which fields to include in a partial response. */
1473
+ fields?: string;
1474
+ /** 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. */
1475
+ key?: string;
1476
+ /** Required. The name of the OS policy assignment to be deleted */
1477
+ name: string;
1478
+ /** OAuth 2.0 token for the current user. */
1479
+ oauth_token?: string;
1480
+ /** Returns response with indentations and line breaks. */
1481
+ prettyPrint?: boolean;
1482
+ /** 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. */
1483
+ quotaUser?: string;
1484
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1485
+ upload_protocol?: string;
1486
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1487
+ uploadType?: string;
1488
+ }): Request<Operation>;
1489
+ /**
1490
+ * Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID
1491
+ * in the `name` parameter.
1492
+ */
1493
+ get(request?: {
1494
+ /** V1 error format. */
1495
+ "$.xgafv"?: string;
1496
+ /** OAuth access token. */
1497
+ access_token?: string;
1498
+ /** Data format for response. */
1499
+ alt?: string;
1500
+ /** JSONP */
1501
+ callback?: string;
1502
+ /** Selector specifying which fields to include in a partial response. */
1503
+ fields?: string;
1504
+ /** 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. */
1505
+ key?: string;
1506
+ /** Required. The resource name of OS policy assignment. Format: `projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}` */
1507
+ name: string;
1508
+ /** OAuth 2.0 token for the current user. */
1509
+ oauth_token?: string;
1510
+ /** Returns response with indentations and line breaks. */
1511
+ prettyPrint?: boolean;
1512
+ /** 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. */
1513
+ quotaUser?: string;
1514
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1515
+ upload_protocol?: string;
1516
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1517
+ uploadType?: string;
1518
+ }): Request<OSPolicyAssignment>;
1519
+ /** List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned. */
1520
+ list(request?: {
1521
+ /** V1 error format. */
1522
+ "$.xgafv"?: string;
1523
+ /** OAuth access token. */
1524
+ access_token?: string;
1525
+ /** Data format for response. */
1526
+ alt?: string;
1527
+ /** JSONP */
1528
+ callback?: string;
1529
+ /** Selector specifying which fields to include in a partial response. */
1530
+ fields?: string;
1531
+ /** 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. */
1532
+ key?: string;
1533
+ /** OAuth 2.0 token for the current user. */
1534
+ oauth_token?: string;
1535
+ /** The maximum number of assignments to return. */
1536
+ pageSize?: number;
1537
+ /** A pagination token returned from a previous call to `ListOSPolicyAssignments` that indicates where this listing should continue from. */
1538
+ pageToken?: string;
1539
+ /** Required. The parent resource name. */
1540
+ parent: string;
1541
+ /** Returns response with indentations and line breaks. */
1542
+ prettyPrint?: boolean;
1543
+ /** 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. */
1544
+ quotaUser?: string;
1545
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1546
+ upload_protocol?: string;
1547
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1548
+ uploadType?: string;
1549
+ }): Request<ListOSPolicyAssignmentsResponse>;
1550
+ /** List the OS policy assignment revisions for a given OS policy assignment. */
1551
+ listRevisions(request?: {
1552
+ /** V1 error format. */
1553
+ "$.xgafv"?: string;
1554
+ /** OAuth access token. */
1555
+ access_token?: string;
1556
+ /** Data format for response. */
1557
+ alt?: string;
1558
+ /** JSONP */
1559
+ callback?: string;
1560
+ /** Selector specifying which fields to include in a partial response. */
1561
+ fields?: string;
1562
+ /** 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. */
1563
+ key?: string;
1564
+ /** Required. The name of the OS policy assignment to list revisions for. */
1565
+ name: string;
1566
+ /** OAuth 2.0 token for the current user. */
1567
+ oauth_token?: string;
1568
+ /** The maximum number of revisions to return. */
1569
+ pageSize?: number;
1570
+ /** A pagination token returned from a previous call to `ListOSPolicyAssignmentRevisions` that indicates where this listing should continue from. */
1571
+ pageToken?: string;
1572
+ /** Returns response with indentations and line breaks. */
1573
+ prettyPrint?: boolean;
1574
+ /** 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. */
1575
+ quotaUser?: string;
1576
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1577
+ upload_protocol?: string;
1578
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1579
+ uploadType?: string;
1580
+ }): Request<ListOSPolicyAssignmentRevisionsResponse>;
1581
+ /**
1582
+ * Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout
1583
+ * details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method:
1584
+ * projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).
1585
+ */
1586
+ patch(request: {
1587
+ /** V1 error format. */
1588
+ "$.xgafv"?: string;
1589
+ /** OAuth access token. */
1590
+ access_token?: string;
1591
+ /** Data format for response. */
1592
+ alt?: string;
1593
+ /** JSONP */
1594
+ callback?: string;
1595
+ /** Selector specifying which fields to include in a partial response. */
1596
+ fields?: string;
1597
+ /** 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. */
1598
+ key?: string;
1599
+ /**
1600
+ * Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy
1601
+ * assignment.
1602
+ */
1603
+ name: string;
1604
+ /** OAuth 2.0 token for the current user. */
1605
+ oauth_token?: string;
1606
+ /** Returns response with indentations and line breaks. */
1607
+ prettyPrint?: boolean;
1608
+ /** 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. */
1609
+ quotaUser?: string;
1610
+ /** Optional. Field mask that controls which fields of the assignment should be updated. */
1611
+ updateMask?: string;
1612
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1613
+ upload_protocol?: string;
1614
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1615
+ uploadType?: string;
1616
+ /** Request body */
1617
+ resource: OSPolicyAssignment;
1618
+ }): Request<Operation>;
1619
+ patch(request: {
1620
+ /** V1 error format. */
1621
+ "$.xgafv"?: string;
1622
+ /** OAuth access token. */
1623
+ access_token?: string;
1624
+ /** Data format for response. */
1625
+ alt?: string;
1626
+ /** JSONP */
1627
+ callback?: string;
1628
+ /** Selector specifying which fields to include in a partial response. */
1629
+ fields?: string;
1630
+ /** 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. */
1631
+ key?: string;
1632
+ /**
1633
+ * Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy
1634
+ * assignment.
1635
+ */
1636
+ name: string;
1637
+ /** OAuth 2.0 token for the current user. */
1638
+ oauth_token?: string;
1639
+ /** Returns response with indentations and line breaks. */
1640
+ prettyPrint?: boolean;
1641
+ /** 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. */
1642
+ quotaUser?: string;
1643
+ /** Optional. Field mask that controls which fields of the assignment should be updated. */
1644
+ updateMask?: string;
1645
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1646
+ upload_protocol?: string;
1647
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1648
+ uploadType?: string;
1649
+ },
1650
+ body: OSPolicyAssignment): Request<Operation>;
1651
+ operations: OperationsResource;
1652
+ }
1653
+ interface LocationsResource {
1654
+ instances: InstancesResource;
1655
+ osPolicyAssignments: OsPolicyAssignmentsResource;
1656
+ }
1657
+ interface PatchDeploymentsResource {
1658
+ /** Create an OS Config patch deployment. */
1659
+ create(request: {
1660
+ /** V1 error format. */
1661
+ "$.xgafv"?: string;
1662
+ /** OAuth access token. */
1663
+ access_token?: string;
1664
+ /** Data format for response. */
1665
+ alt?: string;
1666
+ /** JSONP */
1667
+ callback?: string;
1668
+ /** Selector specifying which fields to include in a partial response. */
1669
+ fields?: string;
1670
+ /** 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. */
1671
+ key?: string;
1672
+ /** OAuth 2.0 token for the current user. */
1673
+ oauth_token?: string;
1674
+ /** Required. The project to apply this patch deployment to in the form `projects/*`. */
1675
+ parent: string;
1676
+ /**
1677
+ * 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
1678
+ * start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
1679
+ */
1680
+ patchDeploymentId?: string;
1681
+ /** Returns response with indentations and line breaks. */
1682
+ prettyPrint?: boolean;
1683
+ /** 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. */
1684
+ quotaUser?: string;
1685
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1686
+ upload_protocol?: string;
1687
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1688
+ uploadType?: string;
1689
+ /** Request body */
1690
+ resource: PatchDeployment;
1691
+ }): Request<PatchDeployment>;
1692
+ create(request: {
1693
+ /** V1 error format. */
1694
+ "$.xgafv"?: string;
1695
+ /** OAuth access token. */
1696
+ access_token?: string;
1697
+ /** Data format for response. */
1698
+ alt?: string;
1699
+ /** JSONP */
1700
+ callback?: string;
1701
+ /** Selector specifying which fields to include in a partial response. */
1702
+ fields?: string;
1703
+ /** 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. */
1704
+ key?: string;
1705
+ /** OAuth 2.0 token for the current user. */
1706
+ oauth_token?: string;
1707
+ /** Required. The project to apply this patch deployment to in the form `projects/*`. */
1708
+ parent: string;
1709
+ /**
1710
+ * 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
1711
+ * start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.
1712
+ */
1713
+ patchDeploymentId?: string;
1714
+ /** Returns response with indentations and line breaks. */
1715
+ prettyPrint?: boolean;
1716
+ /** 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. */
1717
+ quotaUser?: string;
1718
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1719
+ upload_protocol?: string;
1720
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1721
+ uploadType?: string;
1722
+ },
1723
+ body: PatchDeployment): Request<PatchDeployment>;
1724
+ /** Delete an OS Config patch deployment. */
1725
+ delete(request?: {
1726
+ /** V1 error format. */
1727
+ "$.xgafv"?: string;
1728
+ /** OAuth access token. */
1729
+ access_token?: string;
1730
+ /** Data format for response. */
1731
+ alt?: string;
1732
+ /** JSONP */
1733
+ callback?: string;
1734
+ /** Selector specifying which fields to include in a partial response. */
1735
+ fields?: string;
1736
+ /** 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. */
1737
+ key?: string;
1738
+ /** Required. The resource name of the patch deployment in the form `projects/*‍/patchDeployments/*`. */
1739
+ name: string;
1740
+ /** OAuth 2.0 token for the current user. */
1741
+ oauth_token?: string;
1742
+ /** Returns response with indentations and line breaks. */
1743
+ prettyPrint?: boolean;
1744
+ /** 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. */
1745
+ quotaUser?: string;
1746
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1747
+ upload_protocol?: string;
1748
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1749
+ uploadType?: string;
1750
+ }): Request<{}>;
1751
+ /** Get an OS Config patch deployment. */
1752
+ get(request?: {
1753
+ /** V1 error format. */
1754
+ "$.xgafv"?: string;
1755
+ /** OAuth access token. */
1756
+ access_token?: string;
1757
+ /** Data format for response. */
1758
+ alt?: string;
1759
+ /** JSONP */
1760
+ callback?: string;
1761
+ /** Selector specifying which fields to include in a partial response. */
1762
+ fields?: string;
1763
+ /** 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. */
1764
+ key?: string;
1765
+ /** Required. The resource name of the patch deployment in the form `projects/*‍/patchDeployments/*`. */
1766
+ name: string;
1767
+ /** OAuth 2.0 token for the current user. */
1768
+ oauth_token?: string;
1769
+ /** Returns response with indentations and line breaks. */
1770
+ prettyPrint?: boolean;
1771
+ /** 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. */
1772
+ quotaUser?: string;
1773
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1774
+ upload_protocol?: string;
1775
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1776
+ uploadType?: string;
1777
+ }): Request<PatchDeployment>;
1778
+ /** Get a page of OS Config patch deployments. */
1779
+ list(request?: {
1780
+ /** V1 error format. */
1781
+ "$.xgafv"?: string;
1782
+ /** OAuth access token. */
1783
+ access_token?: string;
1784
+ /** Data format for response. */
1785
+ alt?: string;
1786
+ /** JSONP */
1787
+ callback?: string;
1788
+ /** Selector specifying which fields to include in a partial response. */
1789
+ fields?: string;
1790
+ /** 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. */
1791
+ key?: string;
1792
+ /** OAuth 2.0 token for the current user. */
1793
+ oauth_token?: string;
1794
+ /** Optional. The maximum number of patch deployments to return. Default is 100. */
1795
+ pageSize?: number;
1796
+ /** Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from. */
1797
+ pageToken?: string;
1798
+ /** Required. The resource name of the parent in the form `projects/*`. */
1799
+ parent: string;
1800
+ /** Returns response with indentations and line breaks. */
1801
+ prettyPrint?: boolean;
1802
+ /** 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. */
1803
+ quotaUser?: string;
1804
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1805
+ upload_protocol?: string;
1806
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1807
+ uploadType?: string;
1808
+ }): Request<ListPatchDeploymentsResponse>;
1809
+ /** Update an OS Config patch deployment. */
1810
+ patch(request: {
1811
+ /** V1 error format. */
1812
+ "$.xgafv"?: string;
1813
+ /** OAuth access token. */
1814
+ access_token?: string;
1815
+ /** Data format for response. */
1816
+ alt?: string;
1817
+ /** JSONP */
1818
+ callback?: string;
1819
+ /** Selector specifying which fields to include in a partial response. */
1820
+ fields?: string;
1821
+ /** 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. */
1822
+ key?: string;
1823
+ /**
1824
+ * 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
1825
+ * is ignored when you create a new patch deployment.
1826
+ */
1827
+ name: string;
1828
+ /** OAuth 2.0 token for the current user. */
1829
+ oauth_token?: string;
1830
+ /** Returns response with indentations and line breaks. */
1831
+ prettyPrint?: boolean;
1832
+ /** 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. */
1833
+ quotaUser?: string;
1834
+ /** Optional. Field mask that controls which fields of the patch deployment should be updated. */
1835
+ updateMask?: string;
1836
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1837
+ upload_protocol?: string;
1838
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1839
+ uploadType?: string;
1840
+ /** Request body */
1841
+ resource: PatchDeployment;
1842
+ }): Request<PatchDeployment>;
1843
+ patch(request: {
1844
+ /** V1 error format. */
1845
+ "$.xgafv"?: string;
1846
+ /** OAuth access token. */
1847
+ access_token?: string;
1848
+ /** Data format for response. */
1849
+ alt?: string;
1850
+ /** JSONP */
1851
+ callback?: string;
1852
+ /** Selector specifying which fields to include in a partial response. */
1853
+ fields?: string;
1854
+ /** 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. */
1855
+ key?: string;
1856
+ /**
1857
+ * 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
1858
+ * is ignored when you create a new patch deployment.
1859
+ */
1860
+ name: string;
1861
+ /** OAuth 2.0 token for the current user. */
1862
+ oauth_token?: string;
1863
+ /** Returns response with indentations and line breaks. */
1864
+ prettyPrint?: boolean;
1865
+ /** 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. */
1866
+ quotaUser?: string;
1867
+ /** Optional. Field mask that controls which fields of the patch deployment should be updated. */
1868
+ updateMask?: string;
1869
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1870
+ upload_protocol?: string;
1871
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1872
+ uploadType?: string;
1873
+ },
1874
+ body: PatchDeployment): Request<PatchDeployment>;
1875
+ /** Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs. */
1876
+ pause(request: {
1877
+ /** V1 error format. */
1878
+ "$.xgafv"?: string;
1879
+ /** OAuth access token. */
1880
+ access_token?: string;
1881
+ /** Data format for response. */
1882
+ alt?: string;
1883
+ /** JSONP */
1884
+ callback?: string;
1885
+ /** Selector specifying which fields to include in a partial response. */
1886
+ fields?: string;
1887
+ /** 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. */
1888
+ key?: string;
1889
+ /** Required. The resource name of the patch deployment in the form `projects/*‍/patchDeployments/*`. */
1890
+ name: string;
1891
+ /** OAuth 2.0 token for the current user. */
1892
+ oauth_token?: string;
1893
+ /** Returns response with indentations and line breaks. */
1894
+ prettyPrint?: boolean;
1895
+ /** 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. */
1896
+ quotaUser?: string;
1897
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1898
+ upload_protocol?: string;
1899
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1900
+ uploadType?: string;
1901
+ /** Request body */
1902
+ resource: PausePatchDeploymentRequest;
1903
+ }): Request<PatchDeployment>;
1904
+ pause(request: {
1905
+ /** V1 error format. */
1906
+ "$.xgafv"?: string;
1907
+ /** OAuth access token. */
1908
+ access_token?: string;
1909
+ /** Data format for response. */
1910
+ alt?: string;
1911
+ /** JSONP */
1912
+ callback?: string;
1913
+ /** Selector specifying which fields to include in a partial response. */
1914
+ fields?: string;
1915
+ /** 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. */
1916
+ key?: string;
1917
+ /** Required. The resource name of the patch deployment in the form `projects/*‍/patchDeployments/*`. */
1918
+ name: string;
1919
+ /** OAuth 2.0 token for the current user. */
1920
+ oauth_token?: string;
1921
+ /** Returns response with indentations and line breaks. */
1922
+ prettyPrint?: boolean;
1923
+ /** 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. */
1924
+ quotaUser?: string;
1925
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1926
+ upload_protocol?: string;
1927
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1928
+ uploadType?: string;
1929
+ },
1930
+ body: PausePatchDeploymentRequest): Request<PatchDeployment>;
1931
+ /** Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs. */
1932
+ resume(request: {
1933
+ /** V1 error format. */
1934
+ "$.xgafv"?: string;
1935
+ /** OAuth access token. */
1936
+ access_token?: string;
1937
+ /** Data format for response. */
1938
+ alt?: string;
1939
+ /** JSONP */
1940
+ callback?: string;
1941
+ /** Selector specifying which fields to include in a partial response. */
1942
+ fields?: string;
1943
+ /** 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. */
1944
+ key?: string;
1945
+ /** Required. The resource name of the patch deployment in the form `projects/*‍/patchDeployments/*`. */
1946
+ name: string;
1947
+ /** OAuth 2.0 token for the current user. */
1948
+ oauth_token?: string;
1949
+ /** Returns response with indentations and line breaks. */
1950
+ prettyPrint?: boolean;
1951
+ /** 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. */
1952
+ quotaUser?: string;
1953
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1954
+ upload_protocol?: string;
1955
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1956
+ uploadType?: string;
1957
+ /** Request body */
1958
+ resource: ResumePatchDeploymentRequest;
1959
+ }): Request<PatchDeployment>;
1960
+ resume(request: {
1961
+ /** V1 error format. */
1962
+ "$.xgafv"?: string;
1963
+ /** OAuth access token. */
1964
+ access_token?: string;
1965
+ /** Data format for response. */
1966
+ alt?: string;
1967
+ /** JSONP */
1968
+ callback?: string;
1969
+ /** Selector specifying which fields to include in a partial response. */
1970
+ fields?: string;
1971
+ /** 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. */
1972
+ key?: string;
1973
+ /** Required. The resource name of the patch deployment in the form `projects/*‍/patchDeployments/*`. */
1974
+ name: string;
1975
+ /** OAuth 2.0 token for the current user. */
1976
+ oauth_token?: string;
1977
+ /** Returns response with indentations and line breaks. */
1978
+ prettyPrint?: boolean;
1979
+ /** 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. */
1980
+ quotaUser?: string;
1981
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1982
+ upload_protocol?: string;
1983
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1984
+ uploadType?: string;
1985
+ },
1986
+ body: ResumePatchDeploymentRequest): Request<PatchDeployment>;
1987
+ }
1988
+ interface InstanceDetailsResource {
1989
+ /** Get a list of instance details for a given patch job. */
1990
+ list(request?: {
1991
+ /** V1 error format. */
1992
+ "$.xgafv"?: string;
1993
+ /** OAuth access token. */
1994
+ access_token?: string;
1995
+ /** Data format for response. */
1996
+ alt?: string;
1997
+ /** JSONP */
1998
+ callback?: string;
1999
+ /** Selector specifying which fields to include in a partial response. */
2000
+ fields?: string;
2001
+ /** A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`. */
2002
+ filter?: string;
2003
+ /** 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. */
2004
+ key?: string;
2005
+ /** OAuth 2.0 token for the current user. */
2006
+ oauth_token?: string;
2007
+ /** The maximum number of instance details records to return. Default is 100. */
2008
+ pageSize?: number;
2009
+ /** A pagination token returned from a previous call that indicates where this listing should continue from. */
2010
+ pageToken?: string;
2011
+ /** Required. The parent for the instances are in the form of `projects/*‍/patchJobs/*`. */
2012
+ parent: string;
2013
+ /** Returns response with indentations and line breaks. */
2014
+ prettyPrint?: boolean;
2015
+ /** 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. */
2016
+ quotaUser?: string;
2017
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2018
+ upload_protocol?: string;
2019
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2020
+ uploadType?: string;
2021
+ }): Request<ListPatchJobInstanceDetailsResponse>;
2022
+ }
2023
+ interface PatchJobsResource {
2024
+ /** Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted. */
2025
+ cancel(request: {
2026
+ /** V1 error format. */
2027
+ "$.xgafv"?: string;
2028
+ /** OAuth access token. */
2029
+ access_token?: string;
2030
+ /** Data format for response. */
2031
+ alt?: string;
2032
+ /** JSONP */
2033
+ callback?: string;
2034
+ /** Selector specifying which fields to include in a partial response. */
2035
+ fields?: string;
2036
+ /** 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. */
2037
+ key?: string;
2038
+ /** Required. Name of the patch in the form `projects/*‍/patchJobs/*` */
2039
+ name: string;
2040
+ /** OAuth 2.0 token for the current user. */
2041
+ oauth_token?: string;
2042
+ /** Returns response with indentations and line breaks. */
2043
+ prettyPrint?: boolean;
2044
+ /** 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. */
2045
+ quotaUser?: string;
2046
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2047
+ upload_protocol?: string;
2048
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2049
+ uploadType?: string;
2050
+ /** Request body */
2051
+ resource: CancelPatchJobRequest;
2052
+ }): Request<PatchJob>;
2053
+ cancel(request: {
2054
+ /** V1 error format. */
2055
+ "$.xgafv"?: string;
2056
+ /** OAuth access token. */
2057
+ access_token?: string;
2058
+ /** Data format for response. */
2059
+ alt?: string;
2060
+ /** JSONP */
2061
+ callback?: string;
2062
+ /** Selector specifying which fields to include in a partial response. */
2063
+ fields?: string;
2064
+ /** 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. */
2065
+ key?: string;
2066
+ /** Required. Name of the patch in the form `projects/*‍/patchJobs/*` */
2067
+ name: string;
2068
+ /** OAuth 2.0 token for the current user. */
2069
+ oauth_token?: string;
2070
+ /** Returns response with indentations and line breaks. */
2071
+ prettyPrint?: boolean;
2072
+ /** 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. */
2073
+ quotaUser?: string;
2074
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2075
+ upload_protocol?: string;
2076
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2077
+ uploadType?: string;
2078
+ },
2079
+ body: CancelPatchJobRequest): Request<PatchJob>;
2080
+ /** Patch VM instances by creating and running a patch job. */
2081
+ execute(request: {
2082
+ /** V1 error format. */
2083
+ "$.xgafv"?: string;
2084
+ /** OAuth access token. */
2085
+ access_token?: string;
2086
+ /** Data format for response. */
2087
+ alt?: string;
2088
+ /** JSONP */
2089
+ callback?: string;
2090
+ /** Selector specifying which fields to include in a partial response. */
2091
+ fields?: string;
2092
+ /** 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. */
2093
+ key?: string;
2094
+ /** OAuth 2.0 token for the current user. */
2095
+ oauth_token?: string;
2096
+ /** Required. The project in which to run this patch in the form `projects/*` */
2097
+ parent: string;
2098
+ /** Returns response with indentations and line breaks. */
2099
+ prettyPrint?: boolean;
2100
+ /** 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. */
2101
+ quotaUser?: string;
2102
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2103
+ upload_protocol?: string;
2104
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2105
+ uploadType?: string;
2106
+ /** Request body */
2107
+ resource: ExecutePatchJobRequest;
2108
+ }): Request<PatchJob>;
2109
+ execute(request: {
2110
+ /** V1 error format. */
2111
+ "$.xgafv"?: string;
2112
+ /** OAuth access token. */
2113
+ access_token?: string;
2114
+ /** Data format for response. */
2115
+ alt?: string;
2116
+ /** JSONP */
2117
+ callback?: string;
2118
+ /** Selector specifying which fields to include in a partial response. */
2119
+ fields?: string;
2120
+ /** 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. */
2121
+ key?: string;
2122
+ /** OAuth 2.0 token for the current user. */
2123
+ oauth_token?: string;
2124
+ /** Required. The project in which to run this patch in the form `projects/*` */
2125
+ parent: string;
2126
+ /** Returns response with indentations and line breaks. */
2127
+ prettyPrint?: boolean;
2128
+ /** 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. */
2129
+ quotaUser?: string;
2130
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2131
+ upload_protocol?: string;
2132
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2133
+ uploadType?: string;
2134
+ },
2135
+ body: ExecutePatchJobRequest): Request<PatchJob>;
2136
+ /** Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs. */
2137
+ get(request?: {
2138
+ /** V1 error format. */
2139
+ "$.xgafv"?: string;
2140
+ /** OAuth access token. */
2141
+ access_token?: string;
2142
+ /** Data format for response. */
2143
+ alt?: string;
2144
+ /** JSONP */
2145
+ callback?: string;
2146
+ /** Selector specifying which fields to include in a partial response. */
2147
+ fields?: string;
2148
+ /** 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. */
2149
+ key?: string;
2150
+ /** Required. Name of the patch in the form `projects/*‍/patchJobs/*` */
2151
+ name: string;
2152
+ /** OAuth 2.0 token for the current user. */
2153
+ oauth_token?: string;
2154
+ /** Returns response with indentations and line breaks. */
2155
+ prettyPrint?: boolean;
2156
+ /** 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. */
2157
+ quotaUser?: string;
2158
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2159
+ upload_protocol?: string;
2160
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2161
+ uploadType?: string;
2162
+ }): Request<PatchJob>;
2163
+ /** Get a list of patch jobs. */
2164
+ list(request?: {
2165
+ /** V1 error format. */
2166
+ "$.xgafv"?: string;
2167
+ /** OAuth access token. */
2168
+ access_token?: string;
2169
+ /** Data format for response. */
2170
+ alt?: string;
2171
+ /** JSONP */
2172
+ callback?: string;
2173
+ /** Selector specifying which fields to include in a partial response. */
2174
+ fields?: string;
2175
+ /**
2176
+ * 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
2177
+ * field.
2178
+ */
2179
+ filter?: string;
2180
+ /** 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. */
2181
+ key?: string;
2182
+ /** OAuth 2.0 token for the current user. */
2183
+ oauth_token?: string;
2184
+ /** The maximum number of instance status to return. */
2185
+ pageSize?: number;
2186
+ /** A pagination token returned from a previous call that indicates where this listing should continue from. */
2187
+ pageToken?: string;
2188
+ /** Required. In the form of `projects/*` */
2189
+ parent: string;
2190
+ /** Returns response with indentations and line breaks. */
2191
+ prettyPrint?: boolean;
2192
+ /** 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. */
2193
+ quotaUser?: string;
2194
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2195
+ upload_protocol?: string;
2196
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2197
+ uploadType?: string;
2198
+ }): Request<ListPatchJobsResponse>;
2199
+ instanceDetails: InstanceDetailsResource;
2200
+ }
2201
+ interface ProjectsResource {
2202
+ locations: LocationsResource;
2203
+ patchDeployments: PatchDeploymentsResource;
2204
+ patchJobs: PatchJobsResource;
2205
+ }
2206
+
2207
+ const projects: ProjectsResource;
2208
+ }
2209
+ }