Package: cloud.google.com/go/secretmanager/apiv1

package secretmanager Import Path cloud.google.com/go/secretmanager/apiv1 (on go.dev) Dependency Relation imports 21 packages, and imported by one package Involved Source Files d➜ doc.go 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. iam.go secret_manager_client.go Package-Level Type Names (total 6, in which 4 are exported) /* sort exporteds by: alphabet | popularity */ type CallOptions (struct) CallOptions contains the retry settings for each method of Client. Fields (total 15, all are exported) AccessSecretVersion []gax.CallOption AddSecretVersion []gax.CallOption CreateSecret []gax.CallOption DeleteSecret []gax.CallOption DestroySecretVersion []gax.CallOption DisableSecretVersion []gax.CallOption EnableSecretVersion []gax.CallOption GetIamPolicy []gax.CallOption GetSecret []gax.CallOption GetSecretVersion []gax.CallOption ListSecretVersions []gax.CallOption ListSecrets []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []gax.CallOption UpdateSecret []gax.CallOption As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func defaultCallOptions() *CallOptions type Client (struct) 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. Fields (total 5, in which 1 are exported) CallOptions *CallOptions The call options for this service. /* 4 unexporteds ... *//* 4 unexporteds: */ client secretmanagerpb.SecretManagerServiceClient The gRPC API client. connPool gtransport.ConnPool Connection pool of gRPC connections to the service. disableDeadlines bool flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE xGoogMetadata metadata.MD The x-goog-* metadata to be sent with each request. Methods (total 19, in which 18 are exported) (*T) 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. (*T) 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. (*T) Close() error Close closes the connection to the API service. The user should invoke this when the client is no longer required. (*T) Connection() *grpc.ClientConn Connection returns a connection to the API service. Deprecated. (*T) CreateSecret(ctx context.Context, req *secretmanagerpb.CreateSecretRequest, opts ...gax.CallOption) (*secretmanagerpb.Secret, error) CreateSecret creates a new Secret containing no SecretVersions. (*T) DeleteSecret(ctx context.Context, req *secretmanagerpb.DeleteSecretRequest, opts ...gax.CallOption) error DeleteSecret deletes a Secret. (*T) 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. (*T) 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. (*T) 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. (*T) 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. (*T) GetSecret(ctx context.Context, req *secretmanagerpb.GetSecretRequest, opts ...gax.CallOption) (*secretmanagerpb.Secret, error) GetSecret gets metadata for a given Secret. (*T) 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. (*T) 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`. (*T) ListSecretVersions(ctx context.Context, req *secretmanagerpb.ListSecretVersionsRequest, opts ...gax.CallOption) *SecretVersionIterator ListSecretVersions lists SecretVersions. This call does not return secret data. (*T) ListSecrets(ctx context.Context, req *secretmanagerpb.ListSecretsRequest, opts ...gax.CallOption) *SecretIterator ListSecrets lists Secrets. (*T) 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. (*T) 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. (*T) UpdateSecret(ctx context.Context, req *secretmanagerpb.UpdateSecretRequest, opts ...gax.CallOption) (*secretmanagerpb.Secret, error) UpdateSecret updates metadata of an existing Secret. /* one unexported ... *//* one unexported: */ (*T) setGoogleClientInfo(keyval ...string) setGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients. Implements (at least one exported) *T : io.Closer As Outputs Of (at least one exported) func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error) type SecretIterator (struct) SecretIterator manages a stream of *secretmanagerpb.Secret. Fields (total 5, in which 2 are exported) InternalFetch func(pageSize int, pageToken string) (results []*secretmanagerpb.Secret, nextPageToken string, err error) 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. Response interface{} 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. /* 3 unexporteds ... *//* 3 unexporteds: */ items []*secretmanagerpb.Secret nextFunc func() error pageInfo *iterator.PageInfo Methods (total 4, in which 2 are exported) (*T) 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. (*T) PageInfo() *iterator.PageInfo PageInfo supports pagination. See the google.golang.org/api/iterator package for details. /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) bufLen() int (*T) takeBuf() interface{} Implements (at least one exported) *T : google.golang.org/api/iterator.Pageable As Outputs Of (at least one exported) func (*Client).ListSecrets(ctx context.Context, req *secretmanagerpb.ListSecretsRequest, opts ...gax.CallOption) *SecretIterator type SecretVersionIterator (struct) SecretVersionIterator manages a stream of *secretmanagerpb.SecretVersion. Fields (total 5, in which 2 are exported) InternalFetch func(pageSize int, pageToken string) (results []*secretmanagerpb.SecretVersion, nextPageToken string, err error) 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. Response interface{} 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. /* 3 unexporteds ... *//* 3 unexporteds: */ items []*secretmanagerpb.SecretVersion nextFunc func() error pageInfo *iterator.PageInfo Methods (total 4, in which 2 are exported) (*T) 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. (*T) PageInfo() *iterator.PageInfo PageInfo supports pagination. See the google.golang.org/api/iterator package for details. /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) bufLen() int (*T) takeBuf() interface{} Implements (at least one exported) *T : google.golang.org/api/iterator.Pageable As Outputs Of (at least one exported) func (*Client).ListSecretVersions(ctx context.Context, req *secretmanagerpb.ListSecretVersionsRequest, opts ...gax.CallOption) *SecretVersionIterator /* 2 unexporteds ... *//* 2 unexporteds: */ type clientHook (func) As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var newClientHook type clientHookParams (struct) For more information on implementing a client constructor hook, see https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors. Package-Level Functions (total 7, in which 2 are exported) func DefaultAuthScopes() []string DefaultAuthScopes reports the default set of authentication scopes to use with this package. 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 /* 5 unexporteds ... *//* 5 unexporteds: */ func checkDisableDeadlines() (bool, error) func defaultCallOptions() *CallOptions func defaultClientOptions() []option.ClientOption func insertMetadata(ctx context.Context, mds ...metadata.MD) context.Context func versionGo() string versionGo returns the Go runtime version. The returned string has no whitespace, suitable for reporting in header. Package-Level Variables (only one, which is unexported) /* one unexported ... *//* one unexported: */ var newClientHook clientHook Package-Level Constants (only one, which is unexported) /* one unexported ... *//* one unexported: */ const versionClient = "20200912"

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.