Debian Codegraph @

alloydb/apiv1alpha/doc.go

raw
1 // Copyright 2025 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 // Code generated by protoc-gen-go_gapic. DO NOT EDIT.
16
17 // Package alloydb is an auto-generated package for the
18 // AlloyDB API.
19 //
20 // AlloyDB for PostgreSQL is an open source-compatible database service that
21 // provides a powerful option for migrating, modernizing, or building
22 // commercial-grade applications. It offers full compatibility with standard
23 // PostgreSQL, and is more than 4x faster for transactional workloads and up
24 // to 100x faster for analytical queries than standard PostgreSQL in our
25 // performance tests. AlloyDB for PostgreSQL offers a 99.99 percent
26 // availability SLA inclusive of maintenance. AlloyDB is optimized for the
27 // most demanding use cases, allowing you to build new applications that
28 // require high transaction throughput, large database sizes, or multiple
29 // read resources; scale existing PostgreSQL workloads with no application
30 // changes; and modernize legacy proprietary databases.
31 //
32 // NOTE: This package is in beta. It is not stable, and may be subject to changes.
33 //
34 // # General documentation
35 //
36 // For information that is relevant for all client libraries please reference
37 // https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this
38 // page includes:
39 //
40 // - [Authentication and Authorization]
41 // - [Timeouts and Cancellation]
42 // - [Testing against Client Libraries]
43 // - [Debugging Client Libraries]
44 // - [Inspecting errors]
45 //
46 // # Example usage
47 //
48 // To get started with this package, create a client.
49 //
50 // // go get cloud.google.com/go/alloydb/apiv1alpha@latest
51 // ctx := context.Background()
52 // // This snippet has been automatically generated and should be regarded as a code template only.
53 // // It will require modifications to work:
54 // // - It may require correct/in-range values for request initialization.
55 // // - It may require specifying regional endpoints when creating the service client as shown in:
56 // // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
57 // c, err := alloydb.NewAlloyDBAdminClient(ctx)
58 // if err != nil {
59 // // TODO: Handle error.
60 // }
61 // defer c.Close()
62 //
63 // The client will use your default application credentials. Clients should be reused instead of created as needed.
64 // The methods of Client are safe for concurrent use by multiple goroutines.
65 // The returned client must be Closed when it is done being used.
66 //
67 // # Using the Client
68 //
69 // The following is an example of making an API call with the newly created client, mentioned above.
70 //
71 // req := &alloydbpb.BatchCreateInstancesRequest{
72 // // TODO: Fill request struct fields.
73 // // See https://pkg.go.dev/cloud.google.com/go/alloydb/apiv1alpha/alloydbpb#BatchCreateInstancesRequest.
74 // }
75 // op, err := c.BatchCreateInstances(ctx, req)
76 // if err != nil {
77 // // TODO: Handle error.
78 // }
79 //
80 // resp, err := op.Wait(ctx)
81 // if err != nil {
82 // // TODO: Handle error.
83 // }
84 // // TODO: Use resp.
85 // _ = resp
86 //
87 // # Use of Context
88 //
89 // The ctx passed to NewAlloyDBAdminClient is used for authentication requests and
90 // for creating the underlying connection, but is not used for subsequent calls.
91 // Individual methods on the client use the ctx given to them.
92 //
93 // To close the open connection, use the Close() method.
94 //
95 // [Authentication and Authorization]: https://pkg.go.dev/cloud.google.com/go#hdr-Authentication_and_Authorization
96 // [Timeouts and Cancellation]: https://pkg.go.dev/cloud.google.com/go#hdr-Timeouts_and_Cancellation
97 // [Testing against Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Testing
98 // [Debugging Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Debugging
99 // [Inspecting errors]: https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors
100 package alloydb // import "cloud.google.com/go/alloydb/apiv1alpha"