• 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.v1beta.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.v1beta.BatchCreateInstancesResponse
14- name: google.cloud.alloydb.v1beta.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: '/v1beta/{name=projects/*/locations/*}'
63  - selector: google.cloud.location.Locations.ListLocations
64    get: '/v1beta/{name=projects/*}/locations'
65  - selector: google.longrunning.Operations.CancelOperation
66    post: '/v1beta/{name=projects/*/locations/*/operations/*}:cancel'
67  - selector: google.longrunning.Operations.DeleteOperation
68    delete: '/v1beta/{name=projects/*/locations/*/operations/*}'
69  - selector: google.longrunning.Operations.GetOperation
70    get: '/v1beta/{name=projects/*/locations/*/operations/*}'
71  - selector: google.longrunning.Operations.ListOperations
72    get: '/v1beta/{name=projects/*/locations/*}/operations'
73
74authentication:
75  rules:
76  - selector: 'google.cloud.alloydb.v1beta.AlloyDBAdmin.*'
77    oauth:
78      canonical_scopes: |-
79        https://www.googleapis.com/auth/cloud-platform
80  - selector: google.cloud.location.Locations.GetLocation
81    oauth:
82      canonical_scopes: |-
83        https://www.googleapis.com/auth/cloud-platform
84  - selector: google.cloud.location.Locations.ListLocations
85    oauth:
86      canonical_scopes: |-
87        https://www.googleapis.com/auth/cloud-platform
88  - selector: 'google.iam.v1.IAMPolicy.*'
89    oauth:
90      canonical_scopes: |-
91        https://www.googleapis.com/auth/cloud-platform
92  - selector: 'google.longrunning.Operations.*'
93    oauth:
94      canonical_scopes: |-
95        https://www.googleapis.com/auth/cloud-platform
96
97publishing:
98  new_issue_uri: https://issuetracker.google.com/issues/new?component=1194526&template=1689942
99  documentation_uri: https://cloud.google.com/alloydb/docs
100  api_short_name: alloydb
101  github_label: 'api: alloydb'
102  doc_tag_prefix: alloydb
103  organization: CLOUD
104  library_settings:
105  - version: google.cloud.alloydb.v1beta
106    launch_stage: BETA
107    java_settings:
108      common:
109        destinations:
110        - PACKAGE_MANAGER
111    cpp_settings:
112      common:
113        destinations:
114        - PACKAGE_MANAGER
115    php_settings:
116      common:
117        destinations:
118        - PACKAGE_MANAGER
119    python_settings:
120      common:
121        destinations:
122        - PACKAGE_MANAGER
123    node_settings:
124      common:
125        destinations:
126        - PACKAGE_MANAGER
127    dotnet_settings:
128      common:
129        destinations:
130        - PACKAGE_MANAGER
131    ruby_settings:
132      common:
133        destinations:
134        - PACKAGE_MANAGER
135    go_settings:
136      common:
137        destinations:
138        - PACKAGE_MANAGER
139