Debian Codegraph @

bigquery/biglake/apiv1alpha1/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 biglake is an auto-generated package for the
18 // BigLake API.
19 //
20 // The BigLake API provides access to BigLake Metastore, a serverless, fully
21 // managed, and highly available metastore for open-source data that can be
22 // used for querying Apache Iceberg tables in BigQuery.
23 //
24 // NOTE: This package is in beta. It is not stable, and may be subject to changes.
25 //
26 // # General documentation
27 //
28 // For information that is relevant for all client libraries please reference
29 // https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this
30 // page includes:
31 //
32 // - [Authentication and Authorization]
33 // - [Timeouts and Cancellation]
34 // - [Testing against Client Libraries]
35 // - [Debugging Client Libraries]
36 // - [Inspecting errors]
37 //
38 // # Example usage
39 //
40 // To get started with this package, create a client.
41 //
42 // // go get cloud.google.com/go/bigquery/biglake/apiv1alpha1@latest
43 // ctx := context.Background()
44 // // This snippet has been automatically generated and should be regarded as a code template only.
45 // // It will require modifications to work:
46 // // - It may require correct/in-range values for request initialization.
47 // // - It may require specifying regional endpoints when creating the service client as shown in:
48 // // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
49 // c, err := biglake.NewMetastoreClient(ctx)
50 // if err != nil {
51 // // TODO: Handle error.
52 // }
53 // defer c.Close()
54 //
55 // The client will use your default application credentials. Clients should be reused instead of created as needed.
56 // The methods of Client are safe for concurrent use by multiple goroutines.
57 // The returned client must be Closed when it is done being used.
58 //
59 // # Using the Client
60 //
61 // The following is an example of making an API call with the newly created client, mentioned above.
62 //
63 // req := &biglakepb.CheckLockRequest{
64 // // TODO: Fill request struct fields.
65 // // See https://pkg.go.dev/cloud.google.com/go/bigquery/biglake/apiv1alpha1/biglakepb#CheckLockRequest.
66 // }
67 // resp, err := c.CheckLock(ctx, req)
68 // if err != nil {
69 // // TODO: Handle error.
70 // }
71 // // TODO: Use resp.
72 // _ = resp
73 //
74 // # Use of Context
75 //
76 // The ctx passed to NewMetastoreClient is used for authentication requests and
77 // for creating the underlying connection, but is not used for subsequent calls.
78 // Individual methods on the client use the ctx given to them.
79 //
80 // To close the open connection, use the Close() method.
81 //
82 // [Authentication and Authorization]: https://pkg.go.dev/cloud.google.com/go#hdr-Authentication_and_Authorization
83 // [Timeouts and Cancellation]: https://pkg.go.dev/cloud.google.com/go#hdr-Timeouts_and_Cancellation
84 // [Testing against Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Testing
85 // [Debugging Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Debugging
86 // [Inspecting errors]: https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors
87 package biglake // import "cloud.google.com/go/bigquery/biglake/apiv1alpha1"