Debian Codegraph @

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