Struct SecretManagerService

pub struct SecretManagerService { /* private fields */ }

Implements a client for the Secret Manager API.

Service Description

Secret Manager Service

Manages secrets and operations using those secrets. Implements a REST model with the following objects:

• Secret
• SecretVersion

Configuration

SecretManagerService has various configuration parameters, the defaults should work with most applications.

Pooling and Cloning

SecretManagerService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap SecretManagerService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl SecretManagerService

pub async fn new() -> Result<Self>

Creates a new client with the default configuration.

pub async fn new_with_config(conf: ClientConfig) -> Result<Self>

Creates a new client with the specified configuration.

pub fn from_stub<T>(stub: T) -> Self

where T: SecretManagerService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is when mocking the client.

pub fn list_secrets(&self, parent: impl Into<String>) -> ListSecrets

Lists Secrets.

pub fn create_secret(&self, parent: impl Into<String>) -> CreateSecret

Creates a new Secret containing no SecretVersions.

pub fn add_secret_version(&self, parent: impl Into<String>) -> AddSecretVersion

Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

pub fn get_secret(&self, name: impl Into<String>) -> GetSecret

Gets metadata for a given Secret.

pub fn update_secret(&self, secret: impl Into<Secret>) -> UpdateSecret

Updates metadata of an existing Secret.

pub fn delete_secret(&self, name: impl Into<String>) -> DeleteSecret

Deletes a Secret.

pub fn list_secret_versions( &self, parent: impl Into<String>, ) -> ListSecretVersions

Lists SecretVersions. This call does not return secret data.

pub fn get_secret_version(&self, name: impl Into<String>) -> GetSecretVersion

Gets metadata for a SecretVersion.

projects/*/secrets/*/versions/latest is an alias to the most recently created SecretVersion.

pub fn access_secret_version( &self, name: impl Into<String>, ) -> AccessSecretVersion

Accesses a SecretVersion. This call returns the secret data.

projects/*/secrets/*/versions/latest is an alias to the most recently created SecretVersion.

pub fn disable_secret_version( &self, name: impl Into<String>, ) -> DisableSecretVersion

Disables a SecretVersion.

Sets the state of the SecretVersion to DISABLED.

pub fn enable_secret_version( &self, name: impl Into<String>, ) -> EnableSecretVersion

Enables a SecretVersion.

Sets the state of the SecretVersion to ENABLED.

pub fn destroy_secret_version( &self, name: impl Into<String>, ) -> DestroySecretVersion

Destroys a SecretVersion.

Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.

pub fn set_iam_policy(&self, resource: impl Into<String>) -> 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.

pub fn get_iam_policy(&self, resource: impl Into<String>) -> GetIamPolicy

Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.

pub fn test_iam_permissions( &self, resource: impl Into<String>, ) -> 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.

pub fn list_locations(&self, name: impl Into<String>) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self, name: impl Into<String>) -> GetLocation

Gets information about a location.

Trait Implementations

impl Clone for SecretManagerService

fn clone(&self) -> SecretManagerService

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecretManagerService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.