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