• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1type: google.api.Service
2config_version: 3
3name: alloydb.googleapis.com
4title: AlloyDB API
5
6apis:
7- name: google.cloud.alloydb.v1.AlloyDBAdmin
8- name: google.cloud.location.Locations
9- name: google.iam.v1.IAMPolicy
10- name: google.longrunning.Operations
11
12types:
13- name: google.cloud.alloydb.v1.BatchCreateInstancesResponse
14- name: google.cloud.alloydb.v1.OperationMetadata
15
16documentation:
17  summary: |-
18    AlloyDB for PostgreSQL is an open source-compatible database service that
19    provides a powerful option for migrating, modernizing, or building
20    commercial-grade applications. It offers full compatibility with standard
21    PostgreSQL, and is more than 4x faster for transactional workloads and up
22    to 100x faster for analytical queries than standard PostgreSQL in our
23    performance tests. AlloyDB for PostgreSQL offers a 99.99 percent
24    availability SLA inclusive of maintenance. <br><br> AlloyDB is optimized
25    for the most demanding use cases, allowing you to build new applications
26    that require high transaction throughput, large database sizes, or
27    multiple read resources; scale existing PostgreSQL workloads with no
28    application changes; and modernize legacy proprietary databases.
29  rules:
30  - selector: google.cloud.location.Locations.GetLocation
31    description: Gets information about a location.
32
33  - selector: google.cloud.location.Locations.ListLocations
34    description: Lists information about the supported locations for this service.
35
36  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
37    description: |-
38      Gets the access control policy for a resource. Returns an empty policy
39      if the resource exists and does not have a policy set.
40
41  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
42    description: |-
43      Sets the access control policy on the specified resource. Replaces
44      any existing policy.
45
46      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
47      errors.
48
49  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
50    description: |-
51      Returns permissions that a caller has on the specified resource. If the
52      resource does not exist, this will return an empty set of
53      permissions, not a `NOT_FOUND` error.
54
55      Note: This operation is designed to be used for building
56      permission-aware UIs and command-line tools, not for authorization
57      checking. This operation may "fail open" without warning.
58
59http:
60  rules:
61  - selector: google.cloud.location.Locations.GetLocation
62    get: '/v1/{name=projects/*/locations/*}'
63  - selector: google.cloud.location.Locations.ListLocations
64    get: '/v1/{name=projects/*}/locations'
65  - selector: google.longrunning.Operations.CancelOperation
66    post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
67    body: '*'
68  - selector: google.longrunning.Operations.DeleteOperation
69    delete: '/v1/{name=projects/*/locations/*/operations/*}'
70  - selector: google.longrunning.Operations.GetOperation
71    get: '/v1/{name=projects/*/locations/*/operations/*}'
72  - selector: google.longrunning.Operations.ListOperations
73    get: '/v1/{name=projects/*/locations/*}/operations'
74
75authentication:
76  rules:
77  - selector: 'google.cloud.alloydb.v1.AlloyDBAdmin.*'
78    oauth:
79      canonical_scopes: |-
80        https://www.googleapis.com/auth/cloud-platform
81  - selector: google.cloud.location.Locations.GetLocation
82    oauth:
83      canonical_scopes: |-
84        https://www.googleapis.com/auth/cloud-platform
85  - selector: google.cloud.location.Locations.ListLocations
86    oauth:
87      canonical_scopes: |-
88        https://www.googleapis.com/auth/cloud-platform
89  - selector: 'google.iam.v1.IAMPolicy.*'
90    oauth:
91      canonical_scopes: |-
92        https://www.googleapis.com/auth/cloud-platform
93  - selector: 'google.longrunning.Operations.*'
94    oauth:
95      canonical_scopes: |-
96        https://www.googleapis.com/auth/cloud-platform
97
98publishing:
99  new_issue_uri: https://issuetracker.google.com/issues/new?component=1194526&template=1689942
100  documentation_uri: https://cloud.google.com/alloydb/docs
101  api_short_name: alloydb
102  github_label: 'api: alloydb'
103  doc_tag_prefix: alloydb
104  organization: CLOUD
105  library_settings:
106  - version: google.cloud.alloydb.v1
107    launch_stage: GA
108    java_settings:
109      common:
110        destinations:
111        - PACKAGE_MANAGER
112    cpp_settings:
113      common:
114        destinations:
115        - PACKAGE_MANAGER
116    php_settings:
117      common:
118        destinations:
119        - PACKAGE_MANAGER
120    python_settings:
121      common:
122        destinations:
123        - PACKAGE_MANAGER
124    node_settings:
125      common:
126        destinations:
127        - PACKAGE_MANAGER
128    dotnet_settings:
129      common:
130        destinations:
131        - PACKAGE_MANAGER
132    ruby_settings:
133      common:
134        destinations:
135        - PACKAGE_MANAGER
136    go_settings:
137      common:
138        destinations:
139        - PACKAGE_MANAGER
140