Class protos.google.cloud.kms.v1.ImportCryptoKeyVersionRequest

Represents an ImportCryptoKeyVersionRequest.

Package

@google-cloud/kms

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.kms.v1.IImportCryptoKeyVersionRequest);

Constructs a new ImportCryptoKeyVersionRequest.

Parameter
NameDescription
properties google.cloud.kms.v1.IImportCryptoKeyVersionRequest

Properties to set

Properties

algorithm

public algorithm: (google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm|keyof typeof google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm);

ImportCryptoKeyVersionRequest algorithm.

cryptoKeyVersion

public cryptoKeyVersion: string;

ImportCryptoKeyVersionRequest cryptoKeyVersion.

importJob

public importJob: string;

ImportCryptoKeyVersionRequest importJob.

parent

public parent: string;

ImportCryptoKeyVersionRequest parent.

rsaAesWrappedKey

public rsaAesWrappedKey?: (Uint8Array|string|null);

ImportCryptoKeyVersionRequest rsaAesWrappedKey.

wrappedKeyMaterial

public wrappedKeyMaterial?: "rsaAesWrappedKey";

ImportCryptoKeyVersionRequest wrappedKeyMaterial.

Methods

create(properties)

public static create(properties?: google.cloud.kms.v1.IImportCryptoKeyVersionRequest): google.cloud.kms.v1.ImportCryptoKeyVersionRequest;

Creates a new ImportCryptoKeyVersionRequest instance using the specified properties.

Parameter
NameDescription
properties google.cloud.kms.v1.IImportCryptoKeyVersionRequest

Properties to set

Returns
TypeDescription
google.cloud.kms.v1.ImportCryptoKeyVersionRequest

ImportCryptoKeyVersionRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.kms.v1.ImportCryptoKeyVersionRequest;

Decodes an ImportCryptoKeyVersionRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.kms.v1.ImportCryptoKeyVersionRequest

ImportCryptoKeyVersionRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.kms.v1.ImportCryptoKeyVersionRequest;

Decodes an ImportCryptoKeyVersionRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.kms.v1.ImportCryptoKeyVersionRequest

ImportCryptoKeyVersionRequest

encode(message, writer)

public static encode(message: google.cloud.kms.v1.IImportCryptoKeyVersionRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ImportCryptoKeyVersionRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.cloud.kms.v1.IImportCryptoKeyVersionRequest

ImportCryptoKeyVersionRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.kms.v1.IImportCryptoKeyVersionRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ImportCryptoKeyVersionRequest message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message google.cloud.kms.v1.IImportCryptoKeyVersionRequest

ImportCryptoKeyVersionRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.kms.v1.ImportCryptoKeyVersionRequest;

Creates an ImportCryptoKeyVersionRequest message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.kms.v1.ImportCryptoKeyVersionRequest

ImportCryptoKeyVersionRequest

toJSON()

public toJSON(): { [k: string]: any };

Converts this ImportCryptoKeyVersionRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.kms.v1.ImportCryptoKeyVersionRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an ImportCryptoKeyVersionRequest message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.kms.v1.ImportCryptoKeyVersionRequest

ImportCryptoKeyVersionRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an ImportCryptoKeyVersionRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not