Debian Codegraph @

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