Package secretmanager is an auto-generated package for the Secret Manager API.
Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/secretmanager/apiv1beta2@latest ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := secretmanager . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req := & secretmanagerpb . AccessSecretVersionRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#AccessSecretVersionRequest. } resp , err := c . AccessSecretVersion ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type
CallOptions
struct
{
ListSecrets
[]
gax
.
CallOption
CreateSecret
[]
gax
.
CallOption
AddSecretVersion
[]
gax
.
CallOption
GetSecret
[]
gax
.
CallOption
UpdateSecret
[]
gax
.
CallOption
DeleteSecret
[]
gax
.
CallOption
ListSecretVersions
[]
gax
.
CallOption
GetSecretVersion
[]
gax
.
CallOption
AccessSecretVersion
[]
gax
.
CallOption
DisableSecretVersion
[]
gax
.
CallOption
EnableSecretVersion
[]
gax
.
CallOption
DestroySecretVersion
[]
gax
.
CallOption
SetIamPolicy
[]
gax
.
CallOption
GetIamPolicy
[]
gax
.
CallOption
TestIamPermissions
[]
gax
.
CallOption
GetLocation
[]
gax
.
CallOption
ListLocations
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// The call options for this service.
CallOptions
*
CallOptions
// contains filtered or unexported fields
}
Client is a client for interacting with Secret Manager API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
Secret
SecretVersion
func NewClient
NewClient creates a new secret manager service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
Secret
SecretVersion
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new secret manager service rest client.
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
Secret
SecretVersion
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) AccessSecretVersion
func
(
c
*
Client
)
AccessSecretVersion
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
AccessSecretVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
secretmanagerpb
.
AccessSecretVersionResponse
,
error
)
AccessSecretVersion accesses a SecretVersion. This call returns the secret data.
projects/ /secrets/ /versions/latest is an alias to the most recently created SecretVersion.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
AccessSecretVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#AccessSecretVersionRequest.
}
resp
,
err
:=
c
.
AccessSecretVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) AddSecretVersion
func
(
c
*
Client
)
AddSecretVersion
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
AddSecretVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
secretmanagerpb
.
SecretVersion
,
error
)
AddSecretVersion creates a new SecretVersion containing secret data and attaches it to an existing Secret.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
AddSecretVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#AddSecretVersionRequest.
}
resp
,
err
:=
c
.
AddSecretVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection (deprecated)
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) CreateSecret
func
(
c
*
Client
)
CreateSecret
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
CreateSecretRequest
,
opts
...
gax
.
CallOption
)
(
*
secretmanagerpb
.
Secret
,
error
)
CreateSecret creates a new Secret containing no SecretVersions.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
CreateSecretRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#CreateSecretRequest.
}
resp
,
err
:=
c
.
CreateSecret
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) DeleteSecret
func
(
c
*
Client
)
DeleteSecret
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
DeleteSecretRequest
,
opts
...
gax
.
CallOption
)
error
DeleteSecret deletes a Secret.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
DeleteSecretRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#DeleteSecretRequest.
}
err
=
c
.
DeleteSecret
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DestroySecretVersion
func
(
c
*
Client
)
DestroySecretVersion
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
DestroySecretVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
secretmanagerpb
.
SecretVersion
,
error
)
DestroySecretVersion destroys a SecretVersion.
Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
DestroySecretVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#DestroySecretVersionRequest.
}
resp
,
err
:=
c
.
DestroySecretVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) DisableSecretVersion
func
(
c
*
Client
)
DisableSecretVersion
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
DisableSecretVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
secretmanagerpb
.
SecretVersion
,
error
)
DisableSecretVersion disables a SecretVersion.
Sets the state of the SecretVersion to DISABLED.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
DisableSecretVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#DisableSecretVersionRequest.
}
resp
,
err
:=
c
.
DisableSecretVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) EnableSecretVersion
func
(
c
*
Client
)
EnableSecretVersion
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
EnableSecretVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
secretmanagerpb
.
SecretVersion
,
error
)
EnableSecretVersion enables a SecretVersion.
Sets the state of the SecretVersion to ENABLED.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
EnableSecretVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#EnableSecretVersionRequest.
}
resp
,
err
:=
c
.
EnableSecretVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetIamPolicy
func
(
c
*
Client
)
GetIamPolicy
(
ctx
context
.
Context
,
req
*
iampb
.
GetIamPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
iampb
.
Policy
,
error
)
GetIamPolicy gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.
Example
package
main
import
(
"context"
iampb
"cloud.google.com/go/iam/apiv1/iampb"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& iampb
.
GetIamPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest.
}
resp
,
err
:=
c
.
GetIamPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetLocation
func
(
c
*
Client
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
GetLocationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp
,
err
:=
c
.
GetLocation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetSecret
func
(
c
*
Client
)
GetSecret
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
GetSecretRequest
,
opts
...
gax
.
CallOption
)
(
*
secretmanagerpb
.
Secret
,
error
)
GetSecret gets metadata for a given Secret.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
GetSecretRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#GetSecretRequest.
}
resp
,
err
:=
c
.
GetSecret
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetSecretVersion
func
(
c
*
Client
)
GetSecretVersion
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
GetSecretVersionRequest
,
opts
...
gax
.
CallOption
)
(
*
secretmanagerpb
.
SecretVersion
,
error
)
GetSecretVersion gets metadata for a SecretVersion.
projects/ /secrets/ /versions/latest is an alias to the most recently created SecretVersion.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
GetSecretVersionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#GetSecretVersionRequest.
}
resp
,
err
:=
c
.
GetSecretVersion
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListLocations
func
(
c
*
Client
)
ListLocations
(
ctx
context
.
Context
,
req
*
locationpb
.
ListLocationsRequest
,
opts
...
gax
.
CallOption
)
*
LocationIterator
ListLocations lists information about the supported locations for this service.
Examples
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
"google.golang.org/api/iterator"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it
:=
c
.
ListLocations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
locationpb
.
ListLocationsResponse
)
}
}
all
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
for
resp
,
err
:=
range
c
.
ListLocations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListSecretVersions
func
(
c
*
Client
)
ListSecretVersions
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
ListSecretVersionsRequest
,
opts
...
gax
.
CallOption
)
*
SecretVersionIterator
ListSecretVersions lists SecretVersions. This call does not return secret data.
Examples
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
ListSecretVersionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#ListSecretVersionsRequest.
}
it
:=
c
.
ListSecretVersions
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
secretmanagerpb
.
ListSecretVersionsResponse
)
}
}
all
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
ListSecretVersionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#ListSecretVersionsRequest.
}
for
resp
,
err
:=
range
c
.
ListSecretVersions
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListSecrets
func
(
c
*
Client
)
ListSecrets
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
ListSecretsRequest
,
opts
...
gax
.
CallOption
)
*
SecretIterator
ListSecrets lists Secrets.
Examples
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
ListSecretsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#ListSecretsRequest.
}
it
:=
c
.
ListSecrets
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
secretmanagerpb
.
ListSecretsResponse
)
}
}
all
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
ListSecretsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#ListSecretsRequest.
}
for
resp
,
err
:=
range
c
.
ListSecrets
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) SetIamPolicy
func
(
c
*
Client
)
SetIamPolicy
(
ctx
context
.
Context
,
req
*
iampb
.
SetIamPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
iampb
.
Policy
,
error
)
SetIamPolicy sets the access control policy on the specified secret. Replaces any existing policy.
Permissions on SecretVersions are enforced according to the policy set on the associated Secret.
Example
package
main
import
(
"context"
iampb
"cloud.google.com/go/iam/apiv1/iampb"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& iampb
.
SetIamPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest.
}
resp
,
err
:=
c
.
SetIamPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) TestIamPermissions
func
(
c
*
Client
)
TestIamPermissions
(
ctx
context
.
Context
,
req
*
iampb
.
TestIamPermissionsRequest
,
opts
...
gax
.
CallOption
)
(
*
iampb
.
TestIamPermissionsResponse
,
error
)
TestIamPermissions returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Example
package
main
import
(
"context"
iampb
"cloud.google.com/go/iam/apiv1/iampb"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& iampb
.
TestIamPermissionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest.
}
resp
,
err
:=
c
.
TestIamPermissions
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateSecret
func
(
c
*
Client
)
UpdateSecret
(
ctx
context
.
Context
,
req
*
secretmanagerpb
.
UpdateSecretRequest
,
opts
...
gax
.
CallOption
)
(
*
secretmanagerpb
.
Secret
,
error
)
UpdateSecret updates metadata of an existing Secret.
Example
package
main
import
(
"context"
secretmanager
"cloud.google.com/go/secretmanager/apiv1beta2"
secretmanagerpb
"cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
secretmanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& secretmanagerpb
.
UpdateSecretRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/secretmanager/apiv1beta2/secretmanagerpb#UpdateSecretRequest.
}
resp
,
err
:=
c
.
UpdateSecret
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
LocationIterator
type
LocationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
locationpb
.
Location
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All
func
(
it
*
LocationIterator
)
All
()
iter
.
Seq2
[
*
locationpb
.
Location
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*LocationIterator) Next
func
(
it
*
LocationIterator
)
Next
()
(
*
locationpb
.
Location
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo
func
(
it
*
LocationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
SecretIterator
type
SecretIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
secretmanagerpb
.
Secret
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
SecretIterator manages a stream of *secretmanagerpb.Secret.
func (*SecretIterator) All
func
(
it
*
SecretIterator
)
All
()
iter
.
Seq2
[
*
secretmanagerpb
.
Secret
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*SecretIterator) Next
func
(
it
*
SecretIterator
)
Next
()
(
*
secretmanagerpb
.
Secret
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*SecretIterator) PageInfo
func
(
it
*
SecretIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
SecretVersionIterator
type
SecretVersionIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
secretmanagerpb
.
SecretVersion
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
SecretVersionIterator manages a stream of *secretmanagerpb.SecretVersion.
func (*SecretVersionIterator) All
func
(
it
*
SecretVersionIterator
)
All
()
iter
.
Seq2
[
*
secretmanagerpb
.
SecretVersion
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*SecretVersionIterator) Next
func
(
it
*
SecretVersionIterator
)
Next
()
(
*
secretmanagerpb
.
SecretVersion
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*SecretVersionIterator) PageInfo
func
(
it
*
SecretVersionIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
