Class SecretService

constructor

• new SecretService(sdk: SDKInterface): SecretService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns SecretService

$type

create

• create(
      request: CreateSecretRequest,
  ): Request<CreateSecretRequest, Operation<GetOperationRequest>>

  Creates a new secret in the specified container.

  Parameters

  • request: CreateSecretRequest

  Returns Request<CreateSecretRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecretRequest,
      metadata: Metadata,
  ): Request<CreateSecretRequest, Operation<GetOperationRequest>>

  Creates a new secret in the specified container.

  Parameters

  • request: CreateSecretRequest
  • metadata: Metadata

  Returns Request<CreateSecretRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateSecretRequest, Operation<GetOperationRequest>>

  Creates a new secret in the specified container.

  Parameters

  • request: CreateSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateSecretRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecretRequest,
  ): Request<CreateSecretRequest, Operation<GetOperationRequest>>

  Creates a new secret in the specified container.

  Parameters

  • request: CreateSecretRequest

  Returns Request<CreateSecretRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecretRequest,
      metadata: Metadata,
  ): Request<CreateSecretRequest, Operation<GetOperationRequest>>

  Creates a new secret in the specified container.

  Parameters

  • request: CreateSecretRequest
  • metadata: Metadata

  Returns Request<CreateSecretRequest, Operation<GetOperationRequest>>

• create(
      request: CreateSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateSecretRequest, Operation<GetOperationRequest>>

  Creates a new secret in the specified container.

  Parameters

  • request: CreateSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateSecretRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteSecretRequest,
  ): Request<DeleteSecretRequest, Operation<GetOperationRequest>>

  Soft delete secret

  Parameters

  • request: DeleteSecretRequest

  Returns Request<DeleteSecretRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecretRequest,
      metadata: Metadata,
  ): Request<DeleteSecretRequest, Operation<GetOperationRequest>>

  Soft delete secret

  Parameters

  • request: DeleteSecretRequest
  • metadata: Metadata

  Returns Request<DeleteSecretRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteSecretRequest, Operation<GetOperationRequest>>

  Soft delete secret

  Parameters

  • request: DeleteSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteSecretRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecretRequest,
  ): Request<DeleteSecretRequest, Operation<GetOperationRequest>>

  Soft delete secret

  Parameters

  • request: DeleteSecretRequest

  Returns Request<DeleteSecretRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecretRequest,
      metadata: Metadata,
  ): Request<DeleteSecretRequest, Operation<GetOperationRequest>>

  Soft delete secret

  Parameters

  • request: DeleteSecretRequest
  • metadata: Metadata

  Returns Request<DeleteSecretRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteSecretRequest, Operation<GetOperationRequest>>

  Soft delete secret

  Parameters

  • request: DeleteSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteSecretRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListSecretsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Secret>

  Calls the filter method.

  Parameters

  • request: ListSecretsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Secret>

• filter(
      request: ListSecretsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Secret>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListSecretsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Secret>

get

• get(request: GetSecretRequest): Request<GetSecretRequest, Secret>

  Returns the specified secret, without its Payload.

  Parameters

  • request: GetSecretRequest

  Returns Request<GetSecretRequest, Secret>

• get(
      request: GetSecretRequest,
      metadata: Metadata,
  ): Request<GetSecretRequest, Secret>

  Returns the specified secret, without its Payload.

  Parameters

  • request: GetSecretRequest
  • metadata: Metadata

  Returns Request<GetSecretRequest, Secret>

• get(
      request: GetSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSecretRequest, Secret>

  Returns the specified secret, without its Payload.

  Parameters

  • request: GetSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSecretRequest, Secret>

• get(request: GetSecretRequest): Request<GetSecretRequest, Secret>

  Returns the specified secret, without its Payload.

  Parameters

  • request: GetSecretRequest

  Returns Request<GetSecretRequest, Secret>

• get(
      request: GetSecretRequest,
      metadata: Metadata,
  ): Request<GetSecretRequest, Secret>

  Returns the specified secret, without its Payload.

  Parameters

  • request: GetSecretRequest
  • metadata: Metadata

  Returns Request<GetSecretRequest, Secret>

• get(
      request: GetSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSecretRequest, Secret>

  Returns the specified secret, without its Payload.

  Parameters

  • request: GetSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSecretRequest, Secret>

getByName

• getByName(
      request: GetSecretByNameRequest,
  ): Request<GetSecretByNameRequest, Secret>

  Returns the specified secret by name, without its Payload.

  Parameters

  • request: GetSecretByNameRequest

  Returns Request<GetSecretByNameRequest, Secret>

• getByName(
      request: GetSecretByNameRequest,
      metadata: Metadata,
  ): Request<GetSecretByNameRequest, Secret>

  Returns the specified secret by name, without its Payload.

  Parameters

  • request: GetSecretByNameRequest
  • metadata: Metadata

  Returns Request<GetSecretByNameRequest, Secret>

• getByName(
      request: GetSecretByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSecretByNameRequest, Secret>

  Returns the specified secret by name, without its Payload.

  Parameters

  • request: GetSecretByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSecretByNameRequest, Secret>

• getByName(
      request: GetSecretByNameRequest,
  ): Request<GetSecretByNameRequest, Secret>

  Returns the specified secret by name, without its Payload.

  Parameters

  • request: GetSecretByNameRequest

  Returns Request<GetSecretByNameRequest, Secret>

• getByName(
      request: GetSecretByNameRequest,
      metadata: Metadata,
  ): Request<GetSecretByNameRequest, Secret>

  Returns the specified secret by name, without its Payload.

  Parameters

  • request: GetSecretByNameRequest
  • metadata: Metadata

  Returns Request<GetSecretByNameRequest, Secret>

• getByName(
      request: GetSecretByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetSecretByNameRequest, Secret>

  Returns the specified secret by name, without its Payload.

  Parameters

  • request: GetSecretByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetSecretByNameRequest, Secret>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListSecretsRequest,
  ): Request<ListSecretsRequest, ListSecretsResponse>

  Returns the list of secrets in a specified container, without its Payload.

  Parameters

  • request: ListSecretsRequest

  Returns Request<ListSecretsRequest, ListSecretsResponse>

• list(
      request: ListSecretsRequest,
      metadata: Metadata,
  ): Request<ListSecretsRequest, ListSecretsResponse>

  Returns the list of secrets in a specified container, without its Payload.

  Parameters

  • request: ListSecretsRequest
  • metadata: Metadata

  Returns Request<ListSecretsRequest, ListSecretsResponse>

• list(
      request: ListSecretsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSecretsRequest, ListSecretsResponse>

  Returns the list of secrets in a specified container, without its Payload.

  Parameters

  • request: ListSecretsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListSecretsRequest, ListSecretsResponse>

• list(
      request: ListSecretsRequest,
  ): Request<ListSecretsRequest, ListSecretsResponse>

  Returns the list of secrets in a specified container, without its Payload.

  Parameters

  • request: ListSecretsRequest

  Returns Request<ListSecretsRequest, ListSecretsResponse>

• list(
      request: ListSecretsRequest,
      metadata: Metadata,
  ): Request<ListSecretsRequest, ListSecretsResponse>

  Returns the list of secrets in a specified container, without its Payload.

  Parameters

  • request: ListSecretsRequest
  • metadata: Metadata

  Returns Request<ListSecretsRequest, ListSecretsResponse>

• list(
      request: ListSecretsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListSecretsRequest, ListSecretsResponse>

  Returns the list of secrets in a specified container, without its Payload.

  Parameters

  • request: ListSecretsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListSecretsRequest, ListSecretsResponse>

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>

undelete

• undelete(
      request: UndeleteSecretRequest,
  ): Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

  Undelete secret version

  Parameters

  • request: UndeleteSecretRequest

  Returns Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSecretRequest,
      metadata: Metadata,
  ): Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

  Undelete secret version

  Parameters

  • request: UndeleteSecretRequest
  • metadata: Metadata

  Returns Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

  Undelete secret version

  Parameters

  • request: UndeleteSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSecretRequest,
  ): Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

  Undelete secret version

  Parameters

  • request: UndeleteSecretRequest

  Returns Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSecretRequest,
      metadata: Metadata,
  ): Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

  Undelete secret version

  Parameters

  • request: UndeleteSecretRequest
  • metadata: Metadata

  Returns Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

• undelete(
      request: UndeleteSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

  Undelete secret version

  Parameters

  • request: UndeleteSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UndeleteSecretRequest, Operation<GetOperationRequest>>

update

• update(
      request: UpdateSecretRequest,
  ): Request<UpdateSecretRequest, Operation<GetOperationRequest>>

  Updates an existing secret, excluded its Payload.

  Parameters

  • request: UpdateSecretRequest

  Returns Request<UpdateSecretRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecretRequest,
      metadata: Metadata,
  ): Request<UpdateSecretRequest, Operation<GetOperationRequest>>

  Updates an existing secret, excluded its Payload.

  Parameters

  • request: UpdateSecretRequest
  • metadata: Metadata

  Returns Request<UpdateSecretRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateSecretRequest, Operation<GetOperationRequest>>

  Updates an existing secret, excluded its Payload.

  Parameters

  • request: UpdateSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateSecretRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecretRequest,
  ): Request<UpdateSecretRequest, Operation<GetOperationRequest>>

  Updates an existing secret, excluded its Payload.

  Parameters

  • request: UpdateSecretRequest

  Returns Request<UpdateSecretRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecretRequest,
      metadata: Metadata,
  ): Request<UpdateSecretRequest, Operation<GetOperationRequest>>

  Updates an existing secret, excluded its Payload.

  Parameters

  • request: UpdateSecretRequest
  • metadata: Metadata

  Returns Request<UpdateSecretRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateSecretRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateSecretRequest, Operation<GetOperationRequest>>

  Updates an existing secret, excluded its Payload.

  Parameters

  • request: UpdateSecretRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateSecretRequest, Operation<GetOperationRequest>>