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 inventory is an auto-generated package for the 18 // KMS Inventory 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 // ctx := context.Background() 37 // // This snippet has been automatically generated and should be regarded as a code template only. 38 // // It will require modifications to work: 39 // // - It may require correct/in-range values for request initialization. 40 // // - It may require specifying regional endpoints when creating the service client as shown in: 41 // // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 42 // c, err := inventory.NewKeyDashboardClient(ctx) 43 // if err != nil { 44 // // TODO: Handle error. 45 // } 46 // defer c.Close() 47 // 48 // The client will use your default application credentials. Clients should be reused instead of created as needed. 49 // The methods of Client are safe for concurrent use by multiple goroutines. 50 // The returned client must be Closed when it is done being used. 51 // 52 // # Using the Client 53 // 54 // The following is an example of making an API call with the newly created client. 55 // 56 // ctx := context.Background() 57 // // This snippet has been automatically generated and should be regarded as a code template only. 58 // // It will require modifications to work: 59 // // - It may require correct/in-range values for request initialization. 60 // // - It may require specifying regional endpoints when creating the service client as shown in: 61 // // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 62 // c, err := inventory.NewKeyDashboardClient(ctx) 63 // if err != nil { 64 // // TODO: Handle error. 65 // } 66 // defer c.Close() 67 // 68 // req := &inventorypb.ListCryptoKeysRequest{ 69 // // TODO: Fill request struct fields. 70 // // See https://pkg.go.dev/cloud.google.com/go/kms/inventory/apiv1/inventorypb#ListCryptoKeysRequest. 71 // } 72 // it := c.ListCryptoKeys(ctx, req) 73 // for { 74 // resp, err := it.Next() 75 // if err == iterator.Done { 76 // break 77 // } 78 // if err != nil { 79 // // TODO: Handle error. 80 // } 81 // // TODO: Use resp. 82 // _ = resp 83 // 84 // // If you need to access the underlying RPC response, 85 // // you can do so by casting the `Response` as below. 86 // // Otherwise, remove this line. Only populated after 87 // // first call to Next(). Not safe for concurrent access. 88 // _ = it.Response.(*inventorypb.ListCryptoKeysResponse) 89 // } 90 // 91 // # Use of Context 92 // 93 // The ctx passed to NewKeyDashboardClient is used for authentication requests and 94 // for creating the underlying connection, but is not used for subsequent calls. 95 // Individual methods on the client use the ctx given to them. 96 // 97 // To close the open connection, use the Close() method. 98 // 99 // [Authentication and Authorization]: https://pkg.go.dev/cloud.google.com/go#hdr-Authentication_and_Authorization 100 // [Timeouts and Cancellation]: https://pkg.go.dev/cloud.google.com/go#hdr-Timeouts_and_Cancellation 101 // [Testing against Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Testing 102 // [Debugging Client Libraries]: https://pkg.go.dev/cloud.google.com/go#hdr-Debugging 103 // [Inspecting errors]: https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors 104 package inventory // import "cloud.google.com/go/kms/inventory/apiv1" 105 106 import ( 107 "context" 108 109 "google.golang.org/api/option" 110 ) 111 112 // For more information on implementing a client constructor hook, see 113 // https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors. 114 type clientHookParams struct{} 115 type clientHook func(context.Context, clientHookParams) ([]option.ClientOption, error) 116 117 var versionClient string 118 119 func getVersionClient() string { 120 if versionClient == "" { 121 return "UNKNOWN" 122 } 123 return versionClient 124 } 125 126 // DefaultAuthScopes reports the default set of authentication scopes to use with this package. 127 func DefaultAuthScopes() []string { 128 return []string{ 129 "https://www.googleapis.com/auth/cloud-platform", 130 } 131 } 132