@yandex-cloud/nodejs-sdk
Version:
Yandex.Cloud NodeJS SDK
1,028 lines • 70 kB
TypeScript
/// <reference types="node" />
import { ChannelCredentials, ChannelOptions, UntypedServiceImplementation, handleUnaryCall, Client, ClientUnaryCall, Metadata, CallOptions, ServiceError } from "@grpc/grpc-js";
import _m0 from "protobufjs/minimal";
import { SymmetricAlgorithm, SymmetricKey_Status, SymmetricKey, SymmetricKeyVersion } from "../../../../yandex/cloud/kms/v1/symmetric_key";
import { Duration } from "../../../../google/protobuf/duration";
import { FieldMask } from "../../../../google/protobuf/field_mask";
import { Operation } from "../../../../yandex/cloud/operation/operation";
import { ListAccessBindingsRequest, ListAccessBindingsResponse, SetAccessBindingsRequest, UpdateAccessBindingsRequest } from "../../../../yandex/cloud/access/access";
export declare const protobufPackage = "yandex.cloud.kms.v1";
export interface CreateSymmetricKeyRequest {
$type: "yandex.cloud.kms.v1.CreateSymmetricKeyRequest";
/** ID of the folder to create a symmetric KMS key in. */
folderId: string;
/** Name of the key. */
name: string;
/** Description of the key. */
description: string;
/**
* Custom labels for the symmetric KMS key as `key:value` pairs. Maximum 64 per key.
* For example, `"project": "mvp"` or `"source": "dictionary"`.
*/
labels: {
[key: string]: string;
};
/** Encryption algorithm to be used with a new key version, generated with the next rotation. */
defaultAlgorithm: SymmetricAlgorithm;
/**
* Interval between automatic rotations. To disable automatic rotation, don't include
* this field in the creation request.
*/
rotationPeriod?: Duration;
/** Flag that inhibits deletion of the symmetric KMS key */
deletionProtection: boolean;
}
export interface CreateSymmetricKeyRequest_LabelsEntry {
$type: "yandex.cloud.kms.v1.CreateSymmetricKeyRequest.LabelsEntry";
key: string;
value: string;
}
export interface CreateSymmetricKeyMetadata {
$type: "yandex.cloud.kms.v1.CreateSymmetricKeyMetadata";
/** ID of the key being created. */
keyId: string;
/** ID of the primary version of the key being created. */
primaryVersionId: string;
}
export interface GetSymmetricKeyRequest {
$type: "yandex.cloud.kms.v1.GetSymmetricKeyRequest";
/**
* ID of the symmetric KMS key to return.
* To get the ID of a symmetric KMS key use a [SymmetricKeyService.List] request.
*/
keyId: string;
}
export interface ListSymmetricKeysRequest {
$type: "yandex.cloud.kms.v1.ListSymmetricKeysRequest";
/** ID of the folder to list symmetric KMS keys in. */
folderId: string;
/**
* The maximum number of results per page to return. If the number of available
* results is larger than [page_size], the service returns a [ListSymmetricKeysResponse.next_page_token]
* that can be used to get the next page of results in subsequent list requests.
* Default value: 100.
*/
pageSize: number;
/**
* Page token. To get the next page of results, set [page_token] to the
* [ListSymmetricKeysResponse.next_page_token] returned by a previous list request.
*/
pageToken: string;
}
export interface ListSymmetricKeysResponse {
$type: "yandex.cloud.kms.v1.ListSymmetricKeysResponse";
/** List of symmetric KMS keys in the specified folder. */
keys: SymmetricKey[];
/**
* This token allows you to get the next page of results for list requests. If the number
* of results is greater than the specified [ListSymmetricKeysRequest.page_size], use
* the [next_page_token] as the value for the [ListSymmetricKeysRequest.page_token] query parameter
* in the next list request. Each subsequent list request will have its own
* [next_page_token] to continue paging through the results.
*/
nextPageToken: string;
}
export interface ListSymmetricKeyVersionsRequest {
$type: "yandex.cloud.kms.v1.ListSymmetricKeyVersionsRequest";
/** ID of the symmetric KMS key to list versions for. */
keyId: string;
/**
* The maximum number of results per page to return. If the number of available
* results is larger than [page_size], the service returns a [ListSymmetricKeyVersionsResponse.next_page_token]
* that can be used to get the next page of results in subsequent list requests.
* Default value: 100.
*/
pageSize: number;
/**
* Page token. To get the next page of results, set [page_token] to the
* [ListSymmetricKeyVersionsResponse.next_page_token] returned by a previous list request.
*/
pageToken: string;
}
export interface ListSymmetricKeyVersionsResponse {
$type: "yandex.cloud.kms.v1.ListSymmetricKeyVersionsResponse";
/** List of versions for the specified symmetric KMS key. */
keyVersions: SymmetricKeyVersion[];
/**
* This token allows you to get the next page of results for list requests. If the number
* of results is greater than the specified [ListSymmetricKeyVersionsRequest.page_size], use
* the [next_page_token] as the value for the [ListSymmetricKeyVersionsRequest.page_token] query parameter
* in the next list request. Each subsequent list request will have its own
* [next_page_token] to continue paging through the results.
*/
nextPageToken: string;
}
export interface UpdateSymmetricKeyRequest {
$type: "yandex.cloud.kms.v1.UpdateSymmetricKeyRequest";
/**
* ID of the symmetric KMS key to update.
* To get the ID of a symmetric KMS key use a [SymmetricKeyService.List] request.
*/
keyId: string;
/** Field mask that specifies which attributes of the symmetric KMS key are going to be updated. */
updateMask?: FieldMask;
/** New name for the symmetric KMS key. */
name: string;
/** New description for the symmetric KMS key. */
description: string;
/**
* New status for the symmetric KMS key.
* Using the [SymmetricKeyService.Update] method you can only set ACTIVE or INACTIVE status.
*/
status: SymmetricKey_Status;
/** Custom labels for the symmetric KMS key as `key:value` pairs. Maximum 64 per key. */
labels: {
[key: string]: string;
};
/** Default encryption algorithm to be used with new versions of the symmetric KMS key. */
defaultAlgorithm: SymmetricAlgorithm;
/** Time period between automatic symmetric KMS key rotations. */
rotationPeriod?: Duration;
/** Flag that inhibits deletion of the symmetric KMS key */
deletionProtection: boolean;
}
export interface UpdateSymmetricKeyRequest_LabelsEntry {
$type: "yandex.cloud.kms.v1.UpdateSymmetricKeyRequest.LabelsEntry";
key: string;
value: string;
}
export interface UpdateSymmetricKeyMetadata {
$type: "yandex.cloud.kms.v1.UpdateSymmetricKeyMetadata";
/** ID of the key being updated. */
keyId: string;
}
export interface DeleteSymmetricKeyRequest {
$type: "yandex.cloud.kms.v1.DeleteSymmetricKeyRequest";
/** ID of the key to be deleted. */
keyId: string;
}
export interface DeleteSymmetricKeyMetadata {
$type: "yandex.cloud.kms.v1.DeleteSymmetricKeyMetadata";
/** ID of the key being deleted. */
keyId: string;
}
export interface SetPrimarySymmetricKeyVersionRequest {
$type: "yandex.cloud.kms.v1.SetPrimarySymmetricKeyVersionRequest";
/** ID of the key to set a primary version for. */
keyId: string;
/** ID of the version that should become primary for the specified key. */
versionId: string;
}
export interface SetPrimarySymmetricKeyVersionMetadata {
$type: "yandex.cloud.kms.v1.SetPrimarySymmetricKeyVersionMetadata";
/** ID of the key that the primary version if being changed for. */
keyId: string;
/** ID of the version that is being made primary for the key. */
versionId: string;
}
export interface RotateSymmetricKeyRequest {
$type: "yandex.cloud.kms.v1.RotateSymmetricKeyRequest";
/** ID of the key to be rotated. */
keyId: string;
}
export interface RotateSymmetricKeyMetadata {
$type: "yandex.cloud.kms.v1.RotateSymmetricKeyMetadata";
/** ID of the key being rotated. */
keyId: string;
/** ID of the version generated as a result of key rotation. */
newPrimaryVersionId: string;
}
export interface ScheduleSymmetricKeyVersionDestructionRequest {
$type: "yandex.cloud.kms.v1.ScheduleSymmetricKeyVersionDestructionRequest";
/** ID of the key whose version should be scheduled for destruction. */
keyId: string;
/** ID of the version to be destroyed. */
versionId: string;
/**
* Time interval between the version destruction request and actual destruction.
* Default value: 7 days.
*/
pendingPeriod?: Duration;
}
export interface ScheduleSymmetricKeyVersionDestructionMetadata {
$type: "yandex.cloud.kms.v1.ScheduleSymmetricKeyVersionDestructionMetadata";
/** ID of the key whose version is being scheduled for destruction. */
keyId: string;
/** ID of the version that is being scheduled for destruction. */
versionId: string;
/** Time when the version is scheduled to be destroyed. */
destroyAt?: Date;
}
export interface CancelSymmetricKeyVersionDestructionRequest {
$type: "yandex.cloud.kms.v1.CancelSymmetricKeyVersionDestructionRequest";
/** ID of the key to cancel a version's destruction for. */
keyId: string;
/** ID of the version whose scheduled destruction should be cancelled. */
versionId: string;
}
export interface CancelSymmetricKeyVersionDestructionMetadata {
$type: "yandex.cloud.kms.v1.CancelSymmetricKeyVersionDestructionMetadata";
/** ID of the key whose version's destruction is being cancelled. */
keyId: string;
/** ID of the version whose scheduled destruction is being cancelled. */
versionId: string;
}
export interface ListSymmetricKeyOperationsRequest {
$type: "yandex.cloud.kms.v1.ListSymmetricKeyOperationsRequest";
/**
* ID of the symmetric KMS key to get operations for.
*
* To get the key ID, use a [SymmetricKeyService.List] request.
*/
keyId: string;
/**
* The maximum number of results per page that should be returned. If the number of available
* results is larger than [page_size], the service returns a [ListSymmetricKeyOperationsResponse.next_page_token]
* that can be used to get the next page of results in subsequent list requests.
* Default value: 100.
*/
pageSize: number;
/**
* Page token. To get the next page of results, set [page_token] to the
* [ListSymmetricKeyOperationsResponse.next_page_token] returned by a previous list request.
*/
pageToken: string;
}
export interface ListSymmetricKeyOperationsResponse {
$type: "yandex.cloud.kms.v1.ListSymmetricKeyOperationsResponse";
/** List of operations for the specified key. */
operations: Operation[];
/**
* This token allows you to get the next page of results for list requests. If the number of results
* is larger than [ListSymmetricKeyOperationsRequest.page_size], use the [next_page_token] as the value
* for the [ListSymmetricKeyOperationsRequest.page_token] query parameter in the next list request.
* Each subsequent list request will have its own [next_page_token] to continue paging through the results.
*/
nextPageToken: string;
}
export declare const CreateSymmetricKeyRequest: {
$type: "yandex.cloud.kms.v1.CreateSymmetricKeyRequest";
encode(message: CreateSymmetricKeyRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): CreateSymmetricKeyRequest;
fromJSON(object: any): CreateSymmetricKeyRequest;
toJSON(message: CreateSymmetricKeyRequest): unknown;
fromPartial<I extends {
description?: string | undefined;
name?: string | undefined;
folderId?: string | undefined;
labels?: {
[x: string]: string | undefined;
[x: number]: string | undefined;
} | undefined;
deletionProtection?: boolean | undefined;
defaultAlgorithm?: SymmetricAlgorithm | undefined;
rotationPeriod?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} & {
description?: string | undefined;
name?: string | undefined;
folderId?: string | undefined;
labels?: ({
[x: string]: string | undefined;
[x: number]: string | undefined;
} & {
[x: string]: string | undefined;
[x: number]: string | undefined;
} & Record<Exclude<keyof I["labels"], string | number>, never>) | undefined;
deletionProtection?: boolean | undefined;
defaultAlgorithm?: SymmetricAlgorithm | undefined;
rotationPeriod?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & Record<Exclude<keyof I["rotationPeriod"], "$type" | "seconds" | "nanos">, never>) | undefined;
} & Record<Exclude<keyof I, "$type" | "description" | "name" | "folderId" | "labels" | "deletionProtection" | "defaultAlgorithm" | "rotationPeriod">, never>>(object: I): CreateSymmetricKeyRequest;
};
export declare const CreateSymmetricKeyRequest_LabelsEntry: {
$type: "yandex.cloud.kms.v1.CreateSymmetricKeyRequest.LabelsEntry";
encode(message: CreateSymmetricKeyRequest_LabelsEntry, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): CreateSymmetricKeyRequest_LabelsEntry;
fromJSON(object: any): CreateSymmetricKeyRequest_LabelsEntry;
toJSON(message: CreateSymmetricKeyRequest_LabelsEntry): unknown;
fromPartial<I extends {
value?: string | undefined;
key?: string | undefined;
} & {
value?: string | undefined;
key?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "value" | "key">, never>>(object: I): CreateSymmetricKeyRequest_LabelsEntry;
};
export declare const CreateSymmetricKeyMetadata: {
$type: "yandex.cloud.kms.v1.CreateSymmetricKeyMetadata";
encode(message: CreateSymmetricKeyMetadata, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): CreateSymmetricKeyMetadata;
fromJSON(object: any): CreateSymmetricKeyMetadata;
toJSON(message: CreateSymmetricKeyMetadata): unknown;
fromPartial<I extends {
keyId?: string | undefined;
primaryVersionId?: string | undefined;
} & {
keyId?: string | undefined;
primaryVersionId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "keyId" | "primaryVersionId">, never>>(object: I): CreateSymmetricKeyMetadata;
};
export declare const GetSymmetricKeyRequest: {
$type: "yandex.cloud.kms.v1.GetSymmetricKeyRequest";
encode(message: GetSymmetricKeyRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): GetSymmetricKeyRequest;
fromJSON(object: any): GetSymmetricKeyRequest;
toJSON(message: GetSymmetricKeyRequest): unknown;
fromPartial<I extends {
keyId?: string | undefined;
} & {
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "keyId">, never>>(object: I): GetSymmetricKeyRequest;
};
export declare const ListSymmetricKeysRequest: {
$type: "yandex.cloud.kms.v1.ListSymmetricKeysRequest";
encode(message: ListSymmetricKeysRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListSymmetricKeysRequest;
fromJSON(object: any): ListSymmetricKeysRequest;
toJSON(message: ListSymmetricKeysRequest): unknown;
fromPartial<I extends {
pageSize?: number | undefined;
pageToken?: string | undefined;
folderId?: string | undefined;
} & {
pageSize?: number | undefined;
pageToken?: string | undefined;
folderId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "pageSize" | "pageToken" | "folderId">, never>>(object: I): ListSymmetricKeysRequest;
};
export declare const ListSymmetricKeysResponse: {
$type: "yandex.cloud.kms.v1.ListSymmetricKeysResponse";
encode(message: ListSymmetricKeysResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListSymmetricKeysResponse;
fromJSON(object: any): ListSymmetricKeysResponse;
toJSON(message: ListSymmetricKeysResponse): unknown;
fromPartial<I extends {
nextPageToken?: string | undefined;
keys?: {
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: SymmetricKey_Status | undefined;
folderId?: string | undefined;
labels?: {
[x: string]: string | undefined;
[x: number]: string | undefined;
} | undefined;
deletionProtection?: boolean | undefined;
defaultAlgorithm?: SymmetricAlgorithm | undefined;
primaryVersion?: {
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
} | undefined;
rotatedAt?: Date | undefined;
rotationPeriod?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
}[] | undefined;
} & {
nextPageToken?: string | undefined;
keys?: ({
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: SymmetricKey_Status | undefined;
folderId?: string | undefined;
labels?: {
[x: string]: string | undefined;
[x: number]: string | undefined;
} | undefined;
deletionProtection?: boolean | undefined;
defaultAlgorithm?: SymmetricAlgorithm | undefined;
primaryVersion?: {
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
} | undefined;
rotatedAt?: Date | undefined;
rotationPeriod?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
}[] & ({
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: SymmetricKey_Status | undefined;
folderId?: string | undefined;
labels?: {
[x: string]: string | undefined;
[x: number]: string | undefined;
} | undefined;
deletionProtection?: boolean | undefined;
defaultAlgorithm?: SymmetricAlgorithm | undefined;
primaryVersion?: {
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
} | undefined;
rotatedAt?: Date | undefined;
rotationPeriod?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} & {
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: SymmetricKey_Status | undefined;
folderId?: string | undefined;
labels?: ({
[x: string]: string | undefined;
[x: number]: string | undefined;
} & {
[x: string]: string | undefined;
[x: number]: string | undefined;
} & Record<Exclude<keyof I["keys"][number]["labels"], string | number>, never>) | undefined;
deletionProtection?: boolean | undefined;
defaultAlgorithm?: SymmetricAlgorithm | undefined;
primaryVersion?: ({
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
} & {
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
} & Record<Exclude<keyof I["keys"][number]["primaryVersion"], "$type" | "id" | "createdAt" | "status" | "keyId" | "algorithm" | "primary" | "destroyAt" | "hostedByHsm">, never>) | undefined;
rotatedAt?: Date | undefined;
rotationPeriod?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & Record<Exclude<keyof I["keys"][number]["rotationPeriod"], "$type" | "seconds" | "nanos">, never>) | undefined;
} & Record<Exclude<keyof I["keys"][number], "$type" | "description" | "id" | "name" | "createdAt" | "status" | "folderId" | "labels" | "deletionProtection" | "defaultAlgorithm" | "primaryVersion" | "rotatedAt" | "rotationPeriod">, never>)[] & Record<Exclude<keyof I["keys"], "$type" | keyof {
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: SymmetricKey_Status | undefined;
folderId?: string | undefined;
labels?: {
[x: string]: string | undefined;
[x: number]: string | undefined;
} | undefined;
deletionProtection?: boolean | undefined;
defaultAlgorithm?: SymmetricAlgorithm | undefined;
primaryVersion?: {
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
} | undefined;
rotatedAt?: Date | undefined;
rotationPeriod?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
}[]>, never>) | undefined;
} & Record<Exclude<keyof I, "$type" | "nextPageToken" | "keys">, never>>(object: I): ListSymmetricKeysResponse;
};
export declare const ListSymmetricKeyVersionsRequest: {
$type: "yandex.cloud.kms.v1.ListSymmetricKeyVersionsRequest";
encode(message: ListSymmetricKeyVersionsRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListSymmetricKeyVersionsRequest;
fromJSON(object: any): ListSymmetricKeyVersionsRequest;
toJSON(message: ListSymmetricKeyVersionsRequest): unknown;
fromPartial<I extends {
pageSize?: number | undefined;
pageToken?: string | undefined;
keyId?: string | undefined;
} & {
pageSize?: number | undefined;
pageToken?: string | undefined;
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "pageSize" | "pageToken" | "keyId">, never>>(object: I): ListSymmetricKeyVersionsRequest;
};
export declare const ListSymmetricKeyVersionsResponse: {
$type: "yandex.cloud.kms.v1.ListSymmetricKeyVersionsResponse";
encode(message: ListSymmetricKeyVersionsResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListSymmetricKeyVersionsResponse;
fromJSON(object: any): ListSymmetricKeyVersionsResponse;
toJSON(message: ListSymmetricKeyVersionsResponse): unknown;
fromPartial<I extends {
nextPageToken?: string | undefined;
keyVersions?: {
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
}[] | undefined;
} & {
nextPageToken?: string | undefined;
keyVersions?: ({
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
}[] & ({
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
} & {
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
} & Record<Exclude<keyof I["keyVersions"][number], "$type" | "id" | "createdAt" | "status" | "keyId" | "algorithm" | "primary" | "destroyAt" | "hostedByHsm">, never>)[] & Record<Exclude<keyof I["keyVersions"], "$type" | keyof {
id?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../yandex/cloud/kms/v1/symmetric_key").SymmetricKeyVersion_Status | undefined;
keyId?: string | undefined;
algorithm?: SymmetricAlgorithm | undefined;
primary?: boolean | undefined;
destroyAt?: Date | undefined;
hostedByHsm?: boolean | undefined;
}[]>, never>) | undefined;
} & Record<Exclude<keyof I, "$type" | "nextPageToken" | "keyVersions">, never>>(object: I): ListSymmetricKeyVersionsResponse;
};
export declare const UpdateSymmetricKeyRequest: {
$type: "yandex.cloud.kms.v1.UpdateSymmetricKeyRequest";
encode(message: UpdateSymmetricKeyRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): UpdateSymmetricKeyRequest;
fromJSON(object: any): UpdateSymmetricKeyRequest;
toJSON(message: UpdateSymmetricKeyRequest): unknown;
fromPartial<I extends {
description?: string | undefined;
name?: string | undefined;
status?: SymmetricKey_Status | undefined;
labels?: {
[x: string]: string | undefined;
[x: number]: string | undefined;
} | undefined;
updateMask?: {
paths?: string[] | undefined;
} | undefined;
deletionProtection?: boolean | undefined;
keyId?: string | undefined;
defaultAlgorithm?: SymmetricAlgorithm | undefined;
rotationPeriod?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} & {
description?: string | undefined;
name?: string | undefined;
status?: SymmetricKey_Status | undefined;
labels?: ({
[x: string]: string | undefined;
[x: number]: string | undefined;
} & {
[x: string]: string | undefined;
[x: number]: string | undefined;
} & Record<Exclude<keyof I["labels"], string | number>, never>) | undefined;
updateMask?: ({
paths?: string[] | undefined;
} & {
paths?: (string[] & string[] & Record<Exclude<keyof I["updateMask"]["paths"], "$type" | keyof string[]>, never>) | undefined;
} & Record<Exclude<keyof I["updateMask"], "$type" | "paths">, never>) | undefined;
deletionProtection?: boolean | undefined;
keyId?: string | undefined;
defaultAlgorithm?: SymmetricAlgorithm | undefined;
rotationPeriod?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & Record<Exclude<keyof I["rotationPeriod"], "$type" | "seconds" | "nanos">, never>) | undefined;
} & Record<Exclude<keyof I, "$type" | "description" | "name" | "status" | "labels" | "updateMask" | "deletionProtection" | "keyId" | "defaultAlgorithm" | "rotationPeriod">, never>>(object: I): UpdateSymmetricKeyRequest;
};
export declare const UpdateSymmetricKeyRequest_LabelsEntry: {
$type: "yandex.cloud.kms.v1.UpdateSymmetricKeyRequest.LabelsEntry";
encode(message: UpdateSymmetricKeyRequest_LabelsEntry, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): UpdateSymmetricKeyRequest_LabelsEntry;
fromJSON(object: any): UpdateSymmetricKeyRequest_LabelsEntry;
toJSON(message: UpdateSymmetricKeyRequest_LabelsEntry): unknown;
fromPartial<I extends {
value?: string | undefined;
key?: string | undefined;
} & {
value?: string | undefined;
key?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "value" | "key">, never>>(object: I): UpdateSymmetricKeyRequest_LabelsEntry;
};
export declare const UpdateSymmetricKeyMetadata: {
$type: "yandex.cloud.kms.v1.UpdateSymmetricKeyMetadata";
encode(message: UpdateSymmetricKeyMetadata, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): UpdateSymmetricKeyMetadata;
fromJSON(object: any): UpdateSymmetricKeyMetadata;
toJSON(message: UpdateSymmetricKeyMetadata): unknown;
fromPartial<I extends {
keyId?: string | undefined;
} & {
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "keyId">, never>>(object: I): UpdateSymmetricKeyMetadata;
};
export declare const DeleteSymmetricKeyRequest: {
$type: "yandex.cloud.kms.v1.DeleteSymmetricKeyRequest";
encode(message: DeleteSymmetricKeyRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): DeleteSymmetricKeyRequest;
fromJSON(object: any): DeleteSymmetricKeyRequest;
toJSON(message: DeleteSymmetricKeyRequest): unknown;
fromPartial<I extends {
keyId?: string | undefined;
} & {
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "keyId">, never>>(object: I): DeleteSymmetricKeyRequest;
};
export declare const DeleteSymmetricKeyMetadata: {
$type: "yandex.cloud.kms.v1.DeleteSymmetricKeyMetadata";
encode(message: DeleteSymmetricKeyMetadata, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): DeleteSymmetricKeyMetadata;
fromJSON(object: any): DeleteSymmetricKeyMetadata;
toJSON(message: DeleteSymmetricKeyMetadata): unknown;
fromPartial<I extends {
keyId?: string | undefined;
} & {
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "keyId">, never>>(object: I): DeleteSymmetricKeyMetadata;
};
export declare const SetPrimarySymmetricKeyVersionRequest: {
$type: "yandex.cloud.kms.v1.SetPrimarySymmetricKeyVersionRequest";
encode(message: SetPrimarySymmetricKeyVersionRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): SetPrimarySymmetricKeyVersionRequest;
fromJSON(object: any): SetPrimarySymmetricKeyVersionRequest;
toJSON(message: SetPrimarySymmetricKeyVersionRequest): unknown;
fromPartial<I extends {
versionId?: string | undefined;
keyId?: string | undefined;
} & {
versionId?: string | undefined;
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "versionId" | "keyId">, never>>(object: I): SetPrimarySymmetricKeyVersionRequest;
};
export declare const SetPrimarySymmetricKeyVersionMetadata: {
$type: "yandex.cloud.kms.v1.SetPrimarySymmetricKeyVersionMetadata";
encode(message: SetPrimarySymmetricKeyVersionMetadata, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): SetPrimarySymmetricKeyVersionMetadata;
fromJSON(object: any): SetPrimarySymmetricKeyVersionMetadata;
toJSON(message: SetPrimarySymmetricKeyVersionMetadata): unknown;
fromPartial<I extends {
versionId?: string | undefined;
keyId?: string | undefined;
} & {
versionId?: string | undefined;
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "versionId" | "keyId">, never>>(object: I): SetPrimarySymmetricKeyVersionMetadata;
};
export declare const RotateSymmetricKeyRequest: {
$type: "yandex.cloud.kms.v1.RotateSymmetricKeyRequest";
encode(message: RotateSymmetricKeyRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RotateSymmetricKeyRequest;
fromJSON(object: any): RotateSymmetricKeyRequest;
toJSON(message: RotateSymmetricKeyRequest): unknown;
fromPartial<I extends {
keyId?: string | undefined;
} & {
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "keyId">, never>>(object: I): RotateSymmetricKeyRequest;
};
export declare const RotateSymmetricKeyMetadata: {
$type: "yandex.cloud.kms.v1.RotateSymmetricKeyMetadata";
encode(message: RotateSymmetricKeyMetadata, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): RotateSymmetricKeyMetadata;
fromJSON(object: any): RotateSymmetricKeyMetadata;
toJSON(message: RotateSymmetricKeyMetadata): unknown;
fromPartial<I extends {
keyId?: string | undefined;
newPrimaryVersionId?: string | undefined;
} & {
keyId?: string | undefined;
newPrimaryVersionId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "keyId" | "newPrimaryVersionId">, never>>(object: I): RotateSymmetricKeyMetadata;
};
export declare const ScheduleSymmetricKeyVersionDestructionRequest: {
$type: "yandex.cloud.kms.v1.ScheduleSymmetricKeyVersionDestructionRequest";
encode(message: ScheduleSymmetricKeyVersionDestructionRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ScheduleSymmetricKeyVersionDestructionRequest;
fromJSON(object: any): ScheduleSymmetricKeyVersionDestructionRequest;
toJSON(message: ScheduleSymmetricKeyVersionDestructionRequest): unknown;
fromPartial<I extends {
versionId?: string | undefined;
keyId?: string | undefined;
pendingPeriod?: {
seconds?: number | undefined;
nanos?: number | undefined;
} | undefined;
} & {
versionId?: string | undefined;
keyId?: string | undefined;
pendingPeriod?: ({
seconds?: number | undefined;
nanos?: number | undefined;
} & {
seconds?: number | undefined;
nanos?: number | undefined;
} & Record<Exclude<keyof I["pendingPeriod"], "$type" | "seconds" | "nanos">, never>) | undefined;
} & Record<Exclude<keyof I, "$type" | "versionId" | "keyId" | "pendingPeriod">, never>>(object: I): ScheduleSymmetricKeyVersionDestructionRequest;
};
export declare const ScheduleSymmetricKeyVersionDestructionMetadata: {
$type: "yandex.cloud.kms.v1.ScheduleSymmetricKeyVersionDestructionMetadata";
encode(message: ScheduleSymmetricKeyVersionDestructionMetadata, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ScheduleSymmetricKeyVersionDestructionMetadata;
fromJSON(object: any): ScheduleSymmetricKeyVersionDestructionMetadata;
toJSON(message: ScheduleSymmetricKeyVersionDestructionMetadata): unknown;
fromPartial<I extends {
versionId?: string | undefined;
keyId?: string | undefined;
destroyAt?: Date | undefined;
} & {
versionId?: string | undefined;
keyId?: string | undefined;
destroyAt?: Date | undefined;
} & Record<Exclude<keyof I, "$type" | "versionId" | "keyId" | "destroyAt">, never>>(object: I): ScheduleSymmetricKeyVersionDestructionMetadata;
};
export declare const CancelSymmetricKeyVersionDestructionRequest: {
$type: "yandex.cloud.kms.v1.CancelSymmetricKeyVersionDestructionRequest";
encode(message: CancelSymmetricKeyVersionDestructionRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): CancelSymmetricKeyVersionDestructionRequest;
fromJSON(object: any): CancelSymmetricKeyVersionDestructionRequest;
toJSON(message: CancelSymmetricKeyVersionDestructionRequest): unknown;
fromPartial<I extends {
versionId?: string | undefined;
keyId?: string | undefined;
} & {
versionId?: string | undefined;
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "versionId" | "keyId">, never>>(object: I): CancelSymmetricKeyVersionDestructionRequest;
};
export declare const CancelSymmetricKeyVersionDestructionMetadata: {
$type: "yandex.cloud.kms.v1.CancelSymmetricKeyVersionDestructionMetadata";
encode(message: CancelSymmetricKeyVersionDestructionMetadata, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): CancelSymmetricKeyVersionDestructionMetadata;
fromJSON(object: any): CancelSymmetricKeyVersionDestructionMetadata;
toJSON(message: CancelSymmetricKeyVersionDestructionMetadata): unknown;
fromPartial<I extends {
versionId?: string | undefined;
keyId?: string | undefined;
} & {
versionId?: string | undefined;
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "versionId" | "keyId">, never>>(object: I): CancelSymmetricKeyVersionDestructionMetadata;
};
export declare const ListSymmetricKeyOperationsRequest: {
$type: "yandex.cloud.kms.v1.ListSymmetricKeyOperationsRequest";
encode(message: ListSymmetricKeyOperationsRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListSymmetricKeyOperationsRequest;
fromJSON(object: any): ListSymmetricKeyOperationsRequest;
toJSON(message: ListSymmetricKeyOperationsRequest): unknown;
fromPartial<I extends {
pageSize?: number | undefined;
pageToken?: string | undefined;
keyId?: string | undefined;
} & {
pageSize?: number | undefined;
pageToken?: string | undefined;
keyId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "pageSize" | "pageToken" | "keyId">, never>>(object: I): ListSymmetricKeyOperationsRequest;
};
export declare const ListSymmetricKeyOperationsResponse: {
$type: "yandex.cloud.kms.v1.ListSymmetricKeyOperationsResponse";
encode(message: ListSymmetricKeyOperationsResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListSymmetricKeyOperationsResponse;
fromJSON(object: any): ListSymmetricKeyOperationsResponse;
toJSON(message: ListSymmetricKeyOperationsResponse): unknown;
fromPartial<I extends {
nextPageToken?: string | undefined;
operations?: {
description?: string | undefined;
id?: string | undefined;
createdBy?: string | undefined;
done?: boolean | undefined;
createdAt?: Date | undefined;
modifiedAt?: Date | undefined;
metadata?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} | undefined;
error?: {
code?: number | undefined;
message?: string | undefined;
details?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
}[] | undefined;
} | undefined;
response?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} | undefined;
}[] | undefined;
} & {
nextPageToken?: string | undefined;
operations?: ({
description?: string | undefined;
id?: string | undefined;
createdBy?: string | undefined;
done?: boolean | undefined;
createdAt?: Date | undefined;
modifiedAt?: Date | undefined;
metadata?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} | undefined;
error?: {
code?: number | undefined;
message?: string | undefined;
details?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
}[] | undefined;
} | undefined;
response?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} | undefined;
}[] & ({
description?: string | undefined;
id?: string | undefined;
createdBy?: string | undefined;
done?: boolean | undefined;
createdAt?: Date | undefined;
modifiedAt?: Date | undefined;
metadata?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} | undefined;
error?: {
code?: number | undefined;
message?: string | undefined;
details?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
}[] | undefined;
} | undefined;
response?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} | undefined;
} & {
description?: string | undefined;
id?: string | undefined;
createdBy?: string | undefined;
done?: boolean | undefined;
createdAt?: Date | undefined;
modifiedAt?: Date | undefined;
metadata?: ({
typeUrl?: string | undefined;
value?: Buffer | undefined;
} & {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} & Record<Exclude<keyof I["operations"][number]["metadata"], "$type" | "typeUrl" | "value">, never>) | undefined;
error?: ({
code?: number | undefined;
message?: string | undefined;
details?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
}[] | undefined;
} & {
code?: number | undefined;
message?: string | undefined;
details?: ({
typeUrl?: string | undefined;
value?: Buffer | undefined;
}[] & ({
typeUrl?: string | undefined;
value?: Buffer | undefined;
} & {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} & Record<Exclude<keyof I["operations"][number]["error"]["details"][number], "$type" | "typeUrl" | "value">, never>)[] & Record<Exclude<keyof I["operations"][number]["error"]["details"], "$type" | keyof {
typeUrl?: string | undefined;
value?: Buffer | undefined;
}[]>, never>) | undefined;
} & Record<Exclude<keyof I["operations"][number]["error"], "$type" | "code" | "message" | "details">, never>) | undefined;
response?: ({
typeUrl?: string | undefined;
value?: Buffer | undefined;
} & {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} & Record<Exclude<keyof I["operations"][number]["response"], "$type" | "typeUrl" | "value">, never>) | undefined;
} & Record<Exclude<keyof I["operations"][number], "$type" | "description" | "id" | "createdBy" | "done" | "createdAt" | "modifiedAt" | "metadata" | "error" | "response">, never>)[] & Record<Exclude<keyof I["operations"], "$type" | keyof {
description?: string | undefined;
id?: string | undefined;
createdBy?: string | undefined;
done?: boolean | undefined;
createdAt?: Date | undefined;
modifiedAt?: Date | undefined;
metadata?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} | undefined;
error?: {
code?: number | undefined;
message?: string | undefined;
details?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
}[] | undefined;
} | undefined;
response?: {
typeUrl?: string | undefined;
value?: Buffer | undefined;
} | undefined;
}[]>, never>) | undefined;
} & Record<Exclude<keyof I, "$type" | "nextPageToken" | "operations">, never>>(object: I): ListSymmetricKeyOperationsResponse;
};
/** Set of methods for managing symmetric KMS keys. */
export declare const SymmetricKeyServiceService: {
/** Creates a symmetric KMS key in the specified folder. */
readonly create: {
readonly path: "/yandex.cloud.kms.v1.SymmetricKeyService/Create";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: CreateSymmetricKeyRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => CreateSymmetricKeyRequest;
readonly responseSerialize: (value: Operation) => Buffer;
readonly responseDeserialize: (value: Buffer) => Operation;
};
/**
* Returns the specified symmetric KMS key.
*
* To get the list of available symmetric KMS keys, make a [SymmetricKeyService.List] request.
*/
readonly get: {
readonly path: "/yandex.cloud.kms.v1.SymmetricKeyService/Get";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: GetSymmetricKeyRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => GetSymmetricKeyRequest;
readonly responseSerialize: (value: SymmetricKey) => Buffer;
readonly responseDeserialize: (value: Buffer) => SymmetricKey;
};
/** Returns the list of symmetric KMS keys in the specified folder. */
readonly list: {
readonly path: "/yandex.cloud.kms.v1.SymmetricKeyService/List";
readonly requestStream: false;
readonly responseStream: false;
readonly requestSerialize: (value: ListSymmetricKeysRequest) => Buffer;
readonly requestDeserialize: (value: Buffer) => ListSymmetricKeysRequest;
readonly responseSerialize: (value: ListSymmetricKeysResponse) => Buffer;
readonly responseDeserialize: (value: Buffer) => ListSymmetricKeysResponse;
};
/** Returns the list of versions of the specified symmetric KMS key. *