xref: /aosp_15_r20/external/googleapis/google/cloud/gkebackup/v1/gkebackup_v1.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9) 
1type: google.api.Service
2config_version: 3
3name: gkebackup.googleapis.com
4title: Backup for GKE API
5
6apis:
7- name: google.cloud.gkebackup.v1.BackupForGKE
8- name: google.cloud.location.Locations
9- name: google.iam.v1.IAMPolicy
10- name: google.longrunning.Operations
11
12types:
13- name: google.cloud.gkebackup.v1.OperationMetadata
14
15documentation:
16  summary: |-
17    Backup for GKE is a managed Kubernetes workload backup and restore
18    service for GKE clusters.
19  rules:
20  - selector: google.cloud.location.Locations.GetLocation
21    description: Gets information about a location.
22
23  - selector: google.cloud.location.Locations.ListLocations
24    description: Lists information about the supported locations for this service.
25
26  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
27    description: |-
28      Gets the access control policy for a resource. Returns an empty policy
29      if the resource exists and does not have a policy set.
30
31  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
32    description: |-
33      Sets the access control policy on the specified resource. Replaces
34      any existing policy.
35
36      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
37      errors.
38
39  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
40    description: |-
41      Returns permissions that a caller has on the specified resource. If the
42      resource does not exist, this will return an empty set of
43      permissions, not a `NOT_FOUND` error.
44
45      Note: This operation is designed to be used for building
46      permission-aware UIs and command-line tools, not for authorization
47      checking. This operation may "fail open" without warning.
48
49http:
50  rules:
51  - selector: google.cloud.location.Locations.GetLocation
52    get: '/v1/{name=projects/*/locations/*}'
53  - selector: google.cloud.location.Locations.ListLocations
54    get: '/v1/{name=projects/*}/locations'
55  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
56    get: '/v1/{resource=projects/*/locations/*/backupPlans/*}:getIamPolicy'
57    additional_bindings:
58    - get: '/v1/{resource=projects/*/locations/*/backupPlans/*/backups/*}:getIamPolicy'
59    - get: '/v1/{resource=projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*}:getIamPolicy'
60    - get: '/v1/{resource=projects/*/locations/*/restorePlans/*}:getIamPolicy'
61    - get: '/v1/{resource=projects/*/locations/*/restorePlans/*/restores/*}:getIamPolicy'
62    - get: '/v1/{resource=projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*}:getIamPolicy'
63  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
64    post: '/v1/{resource=projects/*/locations/*/backupPlans/*}:setIamPolicy'
65    body: '*'
66    additional_bindings:
67    - post: '/v1/{resource=projects/*/locations/*/backupPlans/*/backups/*}:setIamPolicy'
68      body: '*'
69    - post: '/v1/{resource=projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*}:setIamPolicy'
70      body: '*'
71    - post: '/v1/{resource=projects/*/locations/*/restorePlans/*}:setIamPolicy'
72      body: '*'
73    - post: '/v1/{resource=projects/*/locations/*/restorePlans/*/restores/*}:setIamPolicy'
74      body: '*'
75    - post: '/v1/{resource=projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*}:setIamPolicy'
76      body: '*'
77  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
78    post: '/v1/{resource=projects/*/locations/*/backupPlans/*}:testIamPermissions'
79    body: '*'
80    additional_bindings:
81    - post: '/v1/{resource=projects/*/locations/*/backupPlans/*/backups/*}:testIamPermissions'
82      body: '*'
83    - post: '/v1/{resource=projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*}:testIamPermissions'
84      body: '*'
85    - post: '/v1/{resource=projects/*/locations/*/restorePlans/*}:testIamPermissions'
86      body: '*'
87    - post: '/v1/{resource=projects/*/locations/*/restorePlans/*/restores/*}:testIamPermissions'
88      body: '*'
89    - post: '/v1/{resource=projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*}:testIamPermissions'
90      body: '*'
91  - selector: google.longrunning.Operations.CancelOperation
92    post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
93    body: '*'
94  - selector: google.longrunning.Operations.DeleteOperation
95    delete: '/v1/{name=projects/*/locations/*/operations/*}'
96  - selector: google.longrunning.Operations.GetOperation
97    get: '/v1/{name=projects/*/locations/*/operations/*}'
98  - selector: google.longrunning.Operations.ListOperations
99    get: '/v1/{name=projects/*/locations/*}/operations'
100
101authentication:
102  rules:
103  - selector: 'google.cloud.gkebackup.v1.BackupForGKE.*'
104    oauth:
105      canonical_scopes: |-
106        https://www.googleapis.com/auth/cloud-platform
107  - selector: google.cloud.location.Locations.GetLocation
108    oauth:
109      canonical_scopes: |-
110        https://www.googleapis.com/auth/cloud-platform
111  - selector: google.cloud.location.Locations.ListLocations
112    oauth:
113      canonical_scopes: |-
114        https://www.googleapis.com/auth/cloud-platform
115  - selector: 'google.iam.v1.IAMPolicy.*'
116    oauth:
117      canonical_scopes: |-
118        https://www.googleapis.com/auth/cloud-platform
119  - selector: 'google.longrunning.Operations.*'
120    oauth:
121      canonical_scopes: |-
122        https://www.googleapis.com/auth/cloud-platform
123
124publishing:
125  new_issue_uri: https://issuetracker.google.com/issues/new?component=1126471
126  documentation_uri: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/concepts/backup-for-gke
127  api_short_name: gkebackup
128  github_label: 'api: gkebackup'
129  doc_tag_prefix: gkebackup
130  organization: CLOUD
131  library_settings:
132  - version: google.cloud.gkebackup.v1
133    launch_stage: GA
134    java_settings:
135      common:
136        destinations:
137        - PACKAGE_MANAGER
138    cpp_settings:
139      common:
140        destinations:
141        - PACKAGE_MANAGER
142    php_settings:
143      common:
144        destinations:
145        - PACKAGE_MANAGER
146    python_settings:
147      common:
148        destinations:
149        - PACKAGE_MANAGER
150    node_settings:
151      common:
152        destinations:
153        - PACKAGE_MANAGER
154    dotnet_settings:
155      common:
156        destinations:
157        - PACKAGE_MANAGER
158    ruby_settings:
159      common:
160        destinations:
161        - PACKAGE_MANAGER
162    go_settings:
163      common:
164        destinations:
165        - PACKAGE_MANAGER
166  proto_reference_documentation_uri: https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest
167