1 // Copyright 2024 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 secretmanager is an auto-generated package for the 18 // Secret Manager API. 19 // 20 // Stores sensitive data such as API keys, passwords, and certificates. 21 // Provides convenience while improving security. 22 // 23 // NOTE: This package is in beta. It is not stable, and may be subject to changes. 24 // 25 // # General documentation 26 // 27 // For information that is relevant for all client libraries please reference 28 // https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this 29 // page includes: 30 // 31 // - [Authentication and Authorization] 32 // - [Timeouts and Cancellation] 33 // - [Testing against Client Libraries] 34 // - [Debugging Client Libraries] 35 // - [Inspecting errors] 36 // 37 // # Example usage 38 // 39 // To get started with this package, create a client. 40 // 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 := secretmanager.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. 60 // 61 // ctx := context.Background() 62 // // This snippet has been automatically generated and should be regarded as a code template only. 63 // // It will require modifications to work: 64 // // - It may require correct/in-range values for request initialization. 65 // // - It may require specifying regional endpoints when creating the service client as shown in: 66 // // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 67 // c, err := secretmanager.NewClient(ctx) 68 // if err != nil { 69 // // TODO: Handle error. 70 // } 71 // defer c.Close() 72 // 73 // req := &secretmanagerpb.AccessSecretVersionRequest{ 74 // // TODO: Fill request struct fields. 75 // // See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#AccessSecretVersionRequest. 76 // } 77 // resp, err := c.AccessSecretVersion(ctx, req) 78 // if err != nil { 79 // // TODO: Handle error. 80 // } 81 // // TODO: Use resp. 82 // _ = resp 83 // 84 // # Use of Context 85 // 86 // The ctx passed to NewClient is used for authentication requests and 87 // for creating the underlying connection, but is not used for subsequent calls. 88 // Individual methods on the client use the ctx given to them. 89 // 90 // To close the open connection, use the Close() method. 91 // 92 // [Authentication and Authorization]: https://pkg.go.dev/cloud.google.com/go#hdr-Authentication_and_Authorization 93 // [Timeouts and Cancellation]: https://pkg.go.dev/cloud.google.com/go#hdr-Timeouts_and_Cancellation 94 // [Testing against Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Testing 95 // [Debugging Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Debugging 96 // [Inspecting errors]: https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors 97 package secretmanager // import "cloud.google.com/go/secretmanager/apiv1beta2" 98 99 import ( 100 "context" 101 102 "google.golang.org/api/option" 103 ) 104 105 // For more information on implementing a client constructor hook, see 106 // https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors. 107 type clientHookParams struct{} 108 type clientHook func(context.Context, clientHookParams) ([]option.ClientOption, error) 109 110 var versionClient string 111 112 func getVersionClient() string { 113 if versionClient == "" { 114 return "UNKNOWN" 115 } 116 return versionClient 117 } 118 119 // DefaultAuthScopes reports the default set of authentication scopes to use with this package. 120 func DefaultAuthScopes() []string { 121 return []string{ 122 "https://www.googleapis.com/auth/cloud-platform", 123 } 124 } 125