Skip to main content

SecretService

Trait SecretService 

Source
pub trait SecretService<I: Iterator<Item = Result<Bytes, Error>>> {
    // Required methods
    fn create(
        &self,
        auth_: &BearerToken,
        request: &CreateSecretRequest,
    ) -> Result<Secret, Error>;
    fn get(&self, auth_: &BearerToken, rid: &SecretRid) -> Result<Secret, Error>;
    fn get_batch(
        &self,
        auth_: &BearerToken,
        request: &GetSecretsRequest,
    ) -> Result<GetSecretsResponse, Error>;
    fn update(
        &self,
        auth_: &BearerToken,
        rid: &SecretRid,
        request: &UpdateSecretRequest,
    ) -> Result<Secret, Error>;
    fn delete(&self, auth_: &BearerToken, rid: &SecretRid) -> Result<(), Error>;
    fn archive(&self, auth_: &BearerToken, rid: &SecretRid) -> Result<(), Error>;
    fn unarchive(
        &self,
        auth_: &BearerToken,
        rid: &SecretRid,
    ) -> Result<(), Error>;
    fn search(
        &self,
        auth_: &BearerToken,
        request: &SearchSecretsRequest,
    ) -> Result<SearchSecretsResponse, Error>;
}
Expand description

The secrets service provides functionality for creating and retrieving customer secrets (e.g. influx passwords, API keys, etc)

Required Methods§

Source

fn create( &self, auth_: &BearerToken, request: &CreateSecretRequest, ) -> Result<Secret, Error>

Create a new secret.

Source

fn get(&self, auth_: &BearerToken, rid: &SecretRid) -> Result<Secret, Error>

Get secret by rid.

Source

fn get_batch( &self, auth_: &BearerToken, request: &GetSecretsRequest, ) -> Result<GetSecretsResponse, Error>

Get secrets by a set of rids.

Source

fn update( &self, auth_: &BearerToken, rid: &SecretRid, request: &UpdateSecretRequest, ) -> Result<Secret, Error>

Update a secret by rid.

Source

fn delete(&self, auth_: &BearerToken, rid: &SecretRid) -> Result<(), Error>

Delete a secret by rid. This is a permanent deletion. To perform a soft delete, use the archive endpoint.

Source

fn archive(&self, auth_: &BearerToken, rid: &SecretRid) -> Result<(), Error>

Archive a secret by rid.

Source

fn unarchive(&self, auth_: &BearerToken, rid: &SecretRid) -> Result<(), Error>

Unarchive a secret by rid.

Source

fn search( &self, auth_: &BearerToken, request: &SearchSecretsRequest, ) -> Result<SearchSecretsResponse, Error>

Returns metadata about secrets that match a given query.

Implementors§

Source§

impl<I: Iterator<Item = Result<Bytes, Error>>, __C> SecretService<I> for SecretServiceClient<__C>
where __C: Client<ResponseBody = I>,