@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface SymmetricKeyServiceBaseClient

    Defines the low-level gRPC client for the nebius.kms.v1.SymmetricKeyService service.

    interface SymmetricKeyServiceBaseClient {
        create(
            request: CreateSymmetricKeyRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        delete(
            request: DeleteSymmetricKeyRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        get(
            request: GetSymmetricKeyRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: SymmetricKey) => void,
        ): SurfaceCall;
        getByName(
            request: GetSymmetricKeyByNameRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: SymmetricKey) => void,
        ): SurfaceCall;
        list(
            request: ListSymmetricKeysRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListSymmetricKeysResponse,
            ) => void,
        ): SurfaceCall;
        rotate(
            request: RotateSymmetricKeyRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        undelete(
            request: UndeleteSymmetricKeyRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        update(
            request: UpdateSymmetricKeyRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        updateDeletionDelay(
            request: UpdateSymmetricKeyDeletionDelayRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
    }

    Hierarchy

    • Client
      • SymmetricKeyServiceBaseClient
    Index
    create delete get getByName list rotate undelete update updateDeletionDelay

    • Creates a symmetric KMS key in the specified container.

      Parameters

      • request: CreateSymmetricKeyRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Creates a symmetric KMS key in the specified container.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Schedules a symmetric KMS key for deletion.

      Parameters

      • request: DeleteSymmetricKeyRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Schedules a symmetric KMS key for deletion.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Returns the specified symmetric KMS key by id.

      Parameters

      • request: GetSymmetricKeyRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: SymmetricKey) => void
          • (error: ServiceError | null, response: SymmetricKey): void

          • Returns the specified symmetric KMS key by id.

            Parameters

            Returns void

      Returns SurfaceCall

    • Returns the specified symmetric KMS key by name.

      Parameters

      • request: GetSymmetricKeyByNameRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: SymmetricKey) => void
          • (error: ServiceError | null, response: SymmetricKey): void

          • Returns the specified symmetric KMS key by name.

            Parameters

            Returns void

      Returns SurfaceCall

    • Returns the list of symmetric KMS keys in the specified container.

      Parameters

      Returns SurfaceCall

    • Rotates the specified key: creates a new key version and makes it the primary version. The old version remains available for decryption of ciphertext encrypted with it.

      Parameters

      • request: RotateSymmetricKeyRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Rotates the specified key: creates a new key version and makes it the primary version. The old version remains available for decryption of ciphertext encrypted with it.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Restores a symmetric KMS key scheduled for deletion.

      Parameters

      • request: UndeleteSymmetricKeyRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Restores a symmetric KMS key scheduled for deletion.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Updates a symmetric KMS key.

      Parameters

      • request: UpdateSymmetricKeyRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Updates a symmetric KMS key.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Update deletion delay for a symmetric KMS key scheduled for deletion.

      Parameters

      • request: UpdateSymmetricKeyDeletionDelayRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Update deletion delay for a symmetric KMS key scheduled for deletion.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    Settings
    Member Visibility

    On This Page
    Methods