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