Class AsymmetricKeyService

constructor

• new AsymmetricKeyService(sdk: SDKInterface): AsymmetricKeyService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns AsymmetricKeyService

$type

create

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

  Creates an asymmetric KMS key in the specified container.

  Parameters

  • request: CreateAsymmetricKeyRequest

  Returns Request<CreateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Creates an asymmetric KMS key in the specified container.

  Parameters

  • request: CreateAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<CreateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Creates an asymmetric KMS key in the specified container.

  Parameters

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

  Returns Request<CreateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Creates an asymmetric KMS key in the specified container.

  Parameters

  • request: CreateAsymmetricKeyRequest

  Returns Request<CreateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Creates an asymmetric KMS key in the specified container.

  Parameters

  • request: CreateAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<CreateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Creates an asymmetric KMS key in the specified container.

  Parameters

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

  Returns Request<CreateAsymmetricKeyRequest, Operation<GetOperationRequest>>

delete

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

  Schedules an asymmetric KMS key for deletion.

  Parameters

  • request: DeleteAsymmetricKeyRequest

  Returns Request<DeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Schedules an asymmetric KMS key for deletion.

  Parameters

  • request: DeleteAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<DeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Schedules an asymmetric KMS key for deletion.

  Parameters

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

  Returns Request<DeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Schedules an asymmetric KMS key for deletion.

  Parameters

  • request: DeleteAsymmetricKeyRequest

  Returns Request<DeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Schedules an asymmetric KMS key for deletion.

  Parameters

  • request: DeleteAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<DeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Schedules an asymmetric KMS key for deletion.

  Parameters

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

  Returns Request<DeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<AsymmetricKey>

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

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

  Parameters

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

  Returns AsyncGenerator<AsymmetricKey>

get

• get(
      request: GetAsymmetricKeyRequest,
  ): Request<GetAsymmetricKeyRequest, AsymmetricKey>

  Returns the specified asymmetric KMS key by id.

  Parameters

  • request: GetAsymmetricKeyRequest

  Returns Request<GetAsymmetricKeyRequest, AsymmetricKey>

• get(
      request: GetAsymmetricKeyRequest,
      metadata: Metadata,
  ): Request<GetAsymmetricKeyRequest, AsymmetricKey>

  Returns the specified asymmetric KMS key by id.

  Parameters

  • request: GetAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<GetAsymmetricKeyRequest, AsymmetricKey>

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

  Returns the specified asymmetric KMS key by id.

  Parameters

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

  Returns Request<GetAsymmetricKeyRequest, AsymmetricKey>

• get(
      request: GetAsymmetricKeyRequest,
  ): Request<GetAsymmetricKeyRequest, AsymmetricKey>

  Returns the specified asymmetric KMS key by id.

  Parameters

  • request: GetAsymmetricKeyRequest

  Returns Request<GetAsymmetricKeyRequest, AsymmetricKey>

• get(
      request: GetAsymmetricKeyRequest,
      metadata: Metadata,
  ): Request<GetAsymmetricKeyRequest, AsymmetricKey>

  Returns the specified asymmetric KMS key by id.

  Parameters

  • request: GetAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<GetAsymmetricKeyRequest, AsymmetricKey>

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

  Returns the specified asymmetric KMS key by id.

  Parameters

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

  Returns Request<GetAsymmetricKeyRequest, AsymmetricKey>

getByName

• getByName(
      request: GetAsymmetricKeyByNameRequest,
  ): Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

  Returns the specified asymmetric KMS key by name.

  Parameters

  • request: GetAsymmetricKeyByNameRequest

  Returns Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

• getByName(
      request: GetAsymmetricKeyByNameRequest,
      metadata: Metadata,
  ): Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

  Returns the specified asymmetric KMS key by name.

  Parameters

  • request: GetAsymmetricKeyByNameRequest
  • metadata: Metadata

  Returns Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

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

  Returns the specified asymmetric KMS key by name.

  Parameters

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

  Returns Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

• getByName(
      request: GetAsymmetricKeyByNameRequest,
  ): Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

  Returns the specified asymmetric KMS key by name.

  Parameters

  • request: GetAsymmetricKeyByNameRequest

  Returns Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

• getByName(
      request: GetAsymmetricKeyByNameRequest,
      metadata: Metadata,
  ): Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

  Returns the specified asymmetric KMS key by name.

  Parameters

  • request: GetAsymmetricKeyByNameRequest
  • metadata: Metadata

  Returns Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

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

  Returns the specified asymmetric KMS key by name.

  Parameters

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

  Returns Request<GetAsymmetricKeyByNameRequest, AsymmetricKey>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListAsymmetricKeysRequest,
  ): Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

  Returns the list of asymmetric KMS keys in the specified container.

  Parameters

  • request: ListAsymmetricKeysRequest

  Returns Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

• list(
      request: ListAsymmetricKeysRequest,
      metadata: Metadata,
  ): Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

  Returns the list of asymmetric KMS keys in the specified container.

  Parameters

  • request: ListAsymmetricKeysRequest
  • metadata: Metadata

  Returns Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

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

  Returns the list of asymmetric KMS keys in the specified container.

  Parameters

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

  Returns Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

• list(
      request: ListAsymmetricKeysRequest,
  ): Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

  Returns the list of asymmetric KMS keys in the specified container.

  Parameters

  • request: ListAsymmetricKeysRequest

  Returns Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

• list(
      request: ListAsymmetricKeysRequest,
      metadata: Metadata,
  ): Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

  Returns the list of asymmetric KMS keys in the specified container.

  Parameters

  • request: ListAsymmetricKeysRequest
  • metadata: Metadata

  Returns Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

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

  Returns the list of asymmetric KMS keys in the specified container.

  Parameters

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

  Returns Request<ListAsymmetricKeysRequest, ListAsymmetricKeysResponse>

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: UndeleteAsymmetricKeyRequest,
  ): Request<UndeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

  Restores an asymmetric KMS key scheduled for deletion.

  Parameters

  • request: UndeleteAsymmetricKeyRequest

  Returns Request<UndeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Restores an asymmetric KMS key scheduled for deletion.

  Parameters

  • request: UndeleteAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<UndeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Restores an asymmetric KMS key scheduled for deletion.

  Parameters

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

  Returns Request<UndeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Restores an asymmetric KMS key scheduled for deletion.

  Parameters

  • request: UndeleteAsymmetricKeyRequest

  Returns Request<UndeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Restores an asymmetric KMS key scheduled for deletion.

  Parameters

  • request: UndeleteAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<UndeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Restores an asymmetric KMS key scheduled for deletion.

  Parameters

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

  Returns Request<UndeleteAsymmetricKeyRequest, Operation<GetOperationRequest>>

update

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

  Updates an asymmetric KMS key.

  Parameters

  • request: UpdateAsymmetricKeyRequest

  Returns Request<UpdateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Updates an asymmetric KMS key.

  Parameters

  • request: UpdateAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<UpdateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Updates an asymmetric KMS key.

  Parameters

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

  Returns Request<UpdateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Updates an asymmetric KMS key.

  Parameters

  • request: UpdateAsymmetricKeyRequest

  Returns Request<UpdateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Updates an asymmetric KMS key.

  Parameters

  • request: UpdateAsymmetricKeyRequest
  • metadata: Metadata

  Returns Request<UpdateAsymmetricKeyRequest, Operation<GetOperationRequest>>

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

  Updates an asymmetric KMS key.

  Parameters

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

  Returns Request<UpdateAsymmetricKeyRequest, Operation<GetOperationRequest>>

updateDeletionDelay

• updateDeletionDelay(
      request: UpdateAsymmetricKeyDeletionDelayRequest,
  ): Request<
      UpdateAsymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Update deletion delay for an asymmetric KMS key scheduled for deletion.

  Parameters

  • request: UpdateAsymmetricKeyDeletionDelayRequest

  Returns Request<UpdateAsymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

• updateDeletionDelay(
      request: UpdateAsymmetricKeyDeletionDelayRequest,
      metadata: Metadata,
  ): Request<
      UpdateAsymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Update deletion delay for an asymmetric KMS key scheduled for deletion.

  Parameters

  • request: UpdateAsymmetricKeyDeletionDelayRequest
  • metadata: Metadata

  Returns Request<UpdateAsymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

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

  Update deletion delay for an asymmetric KMS key scheduled for deletion.

  Parameters

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

  Returns Request<UpdateAsymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

• updateDeletionDelay(
      request: UpdateAsymmetricKeyDeletionDelayRequest,
  ): Request<
      UpdateAsymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Update deletion delay for an asymmetric KMS key scheduled for deletion.

  Parameters

  • request: UpdateAsymmetricKeyDeletionDelayRequest

  Returns Request<UpdateAsymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

• updateDeletionDelay(
      request: UpdateAsymmetricKeyDeletionDelayRequest,
      metadata: Metadata,
  ): Request<
      UpdateAsymmetricKeyDeletionDelayRequest,
      Operation<GetOperationRequest>,
  >

  Update deletion delay for an asymmetric KMS key scheduled for deletion.

  Parameters

  • request: UpdateAsymmetricKeyDeletionDelayRequest
  • metadata: Metadata

  Returns Request<UpdateAsymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>

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

  Update deletion delay for an asymmetric KMS key scheduled for deletion.

  Parameters

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

  Returns Request<UpdateAsymmetricKeyDeletionDelayRequest, Operation<GetOperationRequest>>