Class default

SecretsDrainAPI is the implementation for the SecretsDrain facade.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

changeSecretBackend getSecretBackendConfigs getSecretContentInfo getSecretRevisionContentInfo getSecretsToDrain watchSecretBackendChanged

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/user-secrets-drain/UserSecretsDrainV1.ts:164

Properties

NAME

NAME: string = "UserSecretsDrain"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "UserSecretsDrain"

`Static` VERSION

VERSION: number = 1

Methods

changeSecretBackend

changeSecretBackend(params: ChangeSecretBackendArgs): Promise<ErrorResults>
ChangeSecretBackend updates the backend for the specified secret after migration done.
Parameters
- params: ChangeSecretBackendArgs
Returns Promise<ErrorResults>
- Defined in api/facades/user-secrets-drain/UserSecretsDrainV1.ts:174

getSecretBackendConfigs

getSecretBackendConfigs(params: SecretBackendArgs): Promise<SecretBackendConfigResults>
GetSecretBackendConfigs gets the config needed to create a client to secret backends for the drain worker.
Parameters
- params: SecretBackendArgs
Returns Promise<SecretBackendConfigResults>
- Defined in api/facades/user-secrets-drain/UserSecretsDrainV1.ts:190

getSecretContentInfo

getSecretContentInfo(params: GetSecretContentArgs): Promise<SecretContentResults>
GetSecretContentInfo returns the secret values for the specified secrets.
Parameters
- params: GetSecretContentArgs
Returns Promise<SecretContentResults>
- Defined in api/facades/user-secrets-drain/UserSecretsDrainV1.ts:208

getSecretRevisionContentInfo

getSecretRevisionContentInfo(params: SecretRevisionArg): Promise<SecretContentResults>
GetSecretRevisionContentInfo returns the secret values for the specified secret revisions.
Parameters
- params: SecretRevisionArg
Returns Promise<SecretContentResults>
- Defined in api/facades/user-secrets-drain/UserSecretsDrainV1.ts:226

getSecretsToDrain

getSecretsToDrain(params: any): Promise<ListSecretResults>
GetSecretsToDrain returns metadata for the secrets that need to be drained.
Parameters
- params: any
Returns Promise<ListSecretResults>
- Defined in api/facades/user-secrets-drain/UserSecretsDrainV1.ts:244

watchSecretBackendChanged

watchSecretBackendChanged(params: any): Promise<NotifyWatchResult>
WatchSecretBackendChanged sets up a watcher to notify of changes to the secret backend.
Parameters
- params: any
Returns Promise<NotifyWatchResult>
- Defined in api/facades/user-secrets-drain/UserSecretsDrainV1.ts:260

Generated using TypeDoc