xref: /aosp_15_r20/external/googleapis/google/cloud/batch/v1/batch_v1.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1type: google.api.Service
2config_version: 3
3name: batch.googleapis.com
4title: Batch API
5
6apis:
7- name: google.cloud.batch.v1.BatchService
8- name: google.cloud.location.Locations
9- name: google.longrunning.Operations
10
11types:
12- name: google.cloud.batch.v1.OperationMetadata
13
14documentation:
15  summary: An API to manage the running of Batch resources on Google Cloud Platform.
16  overview: '(include == google/cloud/batch/doc/overview.md ==)'
17  rules:
18  - selector: google.cloud.location.Locations.GetLocation
19    description: Gets information about a location.
20
21  - selector: google.cloud.location.Locations.ListLocations
22    description: Lists information about the supported locations for this service.
23
24http:
25  rules:
26  - selector: google.cloud.location.Locations.GetLocation
27    get: '/v1/{name=projects/*/locations/*}'
28  - selector: google.cloud.location.Locations.ListLocations
29    get: '/v1/{name=projects/*}/locations'
30  - selector: google.longrunning.Operations.CancelOperation
31    post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
32    body: '*'
33  - selector: google.longrunning.Operations.DeleteOperation
34    delete: '/v1/{name=projects/*/locations/*/operations/*}'
35  - selector: google.longrunning.Operations.GetOperation
36    get: '/v1/{name=projects/*/locations/*/operations/*}'
37  - selector: google.longrunning.Operations.ListOperations
38    get: '/v1/{name=projects/*/locations/*}/operations'
39
40authentication:
41  rules:
42  - selector: 'google.cloud.batch.v1.BatchService.*'
43    oauth:
44      canonical_scopes: |-
45        https://www.googleapis.com/auth/cloud-platform
46  - selector: google.cloud.location.Locations.GetLocation
47    oauth:
48      canonical_scopes: |-
49        https://www.googleapis.com/auth/cloud-platform
50  - selector: google.cloud.location.Locations.ListLocations
51    oauth:
52      canonical_scopes: |-
53        https://www.googleapis.com/auth/cloud-platform
54  - selector: 'google.longrunning.Operations.*'
55    oauth:
56      canonical_scopes: |-
57        https://www.googleapis.com/auth/cloud-platform
58