xref: /aosp_15_r20/external/googleapis/google/cloud/vmwareengine/v1/vmwareengine_v1.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1type: google.api.Service
2config_version: 3
3name: vmwareengine.googleapis.com
4title: VMware Engine API
5
6apis:
7- name: google.cloud.location.Locations
8- name: google.cloud.vmwareengine.v1.VmwareEngine
9- name: google.iam.v1.IAMPolicy
10- name: google.longrunning.Operations
11
12types:
13- name: google.cloud.vmwareengine.v1.LocationMetadata
14- name: google.cloud.vmwareengine.v1.OperationMetadata
15
16documentation:
17  summary: |-
18    The Google VMware Engine API lets you programmatically manage VMware
19    environments.
20  rules:
21  - selector: google.cloud.location.Locations.GetLocation
22    description: Gets information about a location.
23
24  - selector: google.cloud.location.Locations.ListLocations
25    description: Lists information about the supported locations for this service.
26
27  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
28    description: |-
29      Gets the access control policy for a resource. Returns an empty policy
30      if the resource exists and does not have a policy set.
31
32  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
33    description: |-
34      Sets the access control policy on the specified resource. Replaces
35      any existing policy.
36
37      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
38      errors.
39
40  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
41    description: |-
42      Returns permissions that a caller has on the specified resource. If the
43      resource does not exist, this will return an empty set of
44      permissions, not a `NOT_FOUND` error.
45
46      Note: This operation is designed to be used for building
47      permission-aware UIs and command-line tools, not for authorization
48      checking. This operation may "fail open" without warning.
49
50http:
51  rules:
52  - selector: google.cloud.location.Locations.GetLocation
53    get: '/v1/{name=projects/*/locations/*}'
54  - selector: google.cloud.location.Locations.ListLocations
55    get: '/v1/{name=projects/*}/locations'
56  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
57    get: '/v1/{resource=projects/*/locations/*/privateClouds/*}:getIamPolicy'
58    additional_bindings:
59    - get: '/v1/{resource=projects/*/locations/*/privateClouds/*/clusters/*}:getIamPolicy'
60    - get: '/v1/{resource=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}:getIamPolicy'
61  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
62    post: '/v1/{resource=projects/*/locations/*/privateClouds/*}:setIamPolicy'
63    body: '*'
64    additional_bindings:
65    - post: '/v1/{resource=projects/*/locations/*/privateClouds/*/clusters/*}:setIamPolicy'
66      body: '*'
67    - post: '/v1/{resource=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}:setIamPolicy'
68      body: '*'
69  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
70    post: '/v1/{resource=projects/*/locations/*/privateClouds/*}:testIamPermissions'
71    body: '*'
72    additional_bindings:
73    - post: '/v1/{resource=projects/*/locations/*/privateClouds/*/clusters/*}:testIamPermissions'
74      body: '*'
75    - post: '/v1/{resource=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}:testIamPermissions'
76      body: '*'
77  - selector: google.longrunning.Operations.DeleteOperation
78    delete: '/v1/{name=projects/*/locations/*/operations/*}'
79  - selector: google.longrunning.Operations.GetOperation
80    get: '/v1/{name=projects/*/locations/*/operations/*}'
81  - selector: google.longrunning.Operations.ListOperations
82    get: '/v1/{name=projects/*/locations/*}/operations'
83
84authentication:
85  rules:
86  - selector: google.cloud.location.Locations.GetLocation
87    oauth:
88      canonical_scopes: |-
89        https://www.googleapis.com/auth/cloud-platform
90  - selector: google.cloud.location.Locations.ListLocations
91    oauth:
92      canonical_scopes: |-
93        https://www.googleapis.com/auth/cloud-platform
94  - selector: 'google.cloud.vmwareengine.v1.VmwareEngine.*'
95    oauth:
96      canonical_scopes: |-
97        https://www.googleapis.com/auth/cloud-platform
98  - selector: 'google.iam.v1.IAMPolicy.*'
99    oauth:
100      canonical_scopes: |-
101        https://www.googleapis.com/auth/cloud-platform
102  - selector: 'google.longrunning.Operations.*'
103    oauth:
104      canonical_scopes: |-
105        https://www.googleapis.com/auth/cloud-platform
106