Package cloud.google.com/go/secretmanager/apiv1beta1 (v0.80.0)

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.

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.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

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 
 
 }

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.

func NewClient

  func 
  
 NewClient 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 opts 
  
 ... 
  option 
 
 . 
  ClientOption 
 
 ) 
  
 ( 
 * 
  Client 
 
 , 
  
  error 
 
 )

NewClient creates a new secret manager service 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/apiv1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // 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 latest SecretVersion.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 secretmanager 
  
 "cloud.google.com/go/secretmanager/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 AccessSecretVersionRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 AddSecretVersionRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 AddSecretVersion 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 }

func (*Client) Close

  func 
  
 ( 
 c 
  
 * 
  Client 
 
 ) 
  
 Close 
 () 
  
  error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*Client) Connection

  func 
  
 ( 
 c 
  
 * 
  Client 
 
 ) 
  
 Connection 
 () 
  
 * 
  grpc 
 
 . 
  ClientConn

Connection returns a connection to the API service.

Deprecated.

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/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 CreateSecretRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 DeleteSecretRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 DestroySecretVersionRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 DisableSecretVersionRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 EnableSecretVersionRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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" 
  
 secretmanager 
  
 "cloud.google.com/go/secretmanager/apiv1beta1" 
  
 iampb 
  
 "google.golang.org/genproto/googleapis/iam/v1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import iampb "google.golang.org/genproto/googleapis/iam/v1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& iampb 
 . 
 GetIamPolicyRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 GetIamPolicy 
 ( 
 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/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 GetSecretRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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 latest SecretVersion.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 secretmanager 
  
 "cloud.google.com/go/secretmanager/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 GetSecretVersionRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 GetSecretVersion 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 }

func (*Client) IAM

  func 
  
 ( 
 c 
  
 * 
  Client 
 
 ) 
  
 IAM 
 ( 
 name 
  
  string 
 
 ) 
  
 * 
  iam 
 
 . 
  Handle

IAM returns a handle to inspect and change permissions of the resource indicated by the given resource path. Name should be of the format projects/my-project/secrets/my-secret .

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 secretmanager 
  
 "cloud.google.com/go/secretmanager/apiv1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: fill in secret resource path 
  
 secret 
  
 := 
  
 "projects/[PROJECT_ID]/secrets/[SECRET]" 
  
 handle 
  
 := 
  
 c 
 . 
 IAM 
 ( 
 secret 
 ) 
  
 policy 
 , 
  
 err 
  
 := 
  
 handle 
 . 
 Policy 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use policy. 
  
 _ 
  
 = 
  
 policy 
 }

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.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 secretmanager 
  
 "cloud.google.com/go/secretmanager/apiv1beta1" 
  
 "google.golang.org/api/iterator" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 // import "google.golang.org/api/iterator" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 ListSecretVersionsRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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 
  
 } 
 }

func (*Client) ListSecrets

  func 
  
 ( 
 c 
  
 * 
  Client 
 
 ) 
  
 ListSecrets 
 ( 
 ctx 
  
  context 
 
 . 
  Context 
 
 , 
  
 req 
  
 * 
  secretmanagerpb 
 
 . 
  ListSecretsRequest 
 
 , 
  
 opts 
  
 ... 
  gax 
 
 . 
  CallOption 
 
 ) 
  
 * 
  SecretIterator

ListSecrets lists Secrets.

Example

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 secretmanager 
  
 "cloud.google.com/go/secretmanager/apiv1beta1" 
  
 "google.golang.org/api/iterator" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 // import "google.golang.org/api/iterator" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 ListSecretsRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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 
  
 } 
 }

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" 
  
 secretmanager 
  
 "cloud.google.com/go/secretmanager/apiv1beta1" 
  
 iampb 
  
 "google.golang.org/genproto/googleapis/iam/v1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import iampb "google.golang.org/genproto/googleapis/iam/v1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& iampb 
 . 
 SetIamPolicyRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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" 
  
 secretmanager 
  
 "cloud.google.com/go/secretmanager/apiv1beta1" 
  
 iampb 
  
 "google.golang.org/genproto/googleapis/iam/v1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import iampb "google.golang.org/genproto/googleapis/iam/v1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& iampb 
 . 
 TestIamPermissionsRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 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/apiv1beta1" 
  
 secretmanagerpb 
  
 "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // import secretmanagerpb "google.golang.org/genproto/googleapis/cloud/secretmanager/v1beta1" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 c 
 , 
  
 err 
  
 := 
  
 secretmanager 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 req 
  
 := 
  
& secretmanagerpb 
 . 
 UpdateSecretRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 } 
  
 resp 
 , 
  
 err 
  
 := 
  
 c 
 . 
 UpdateSecret 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
 }

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) 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) 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.

Package cloud.google.com/go/secretmanager/apiv1beta1 (v0.80.0) Stay organized with collections Save and categorize content based on your preferences.

Use of Context

Functions

func DefaultAuthScopes

CallOptions

Client

func NewClient

Example

func (*Client) AccessSecretVersion

Example

func (*Client) AddSecretVersion

Example

func (*Client) Close

func (*Client) Connection

func (*Client) CreateSecret

Example

func (*Client) DeleteSecret

Example

func (*Client) DestroySecretVersion

Example

func (*Client) DisableSecretVersion

Example

func (*Client) EnableSecretVersion

Example

func (*Client) GetIamPolicy

Example

func (*Client) GetSecret

Example

func (*Client) GetSecretVersion

Example

func (*Client) IAM

Example

func (*Client) ListSecretVersions

Example

func (*Client) ListSecrets

Example

func (*Client) SetIamPolicy

Example

func (*Client) TestIamPermissions

Example

func (*Client) UpdateSecret

Example

SecretIterator

func (*SecretIterator) Next

func (*SecretIterator) PageInfo

SecretVersionIterator

func (*SecretVersionIterator) Next

func (*SecretVersionIterator) PageInfo

Package cloud.google.com/go/secretmanager/apiv1beta1 (v0.80.0)