Class protos.google.cloud.kms.v1.Digest (4.5.0)

Represents a Digest.

Package

@google-cloud/kms

Constructors

(constructor)(properties)

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

Constructs a new Digest.

Parameter
NameDescription
propertiesIDigest

Properties to set

Properties

digest

publicdigest?:("sha256"|"sha384"|"sha512");

Digest digest.

sha256

publicsha256?:(Uint8Array|string|null);

Digest sha256.

sha384

publicsha384?:(Uint8Array|string|null);

Digest sha384.

sha512

publicsha512?:(Uint8Array|string|null);

Digest sha512.

Methods

create(properties)

publicstaticcreate(properties?:google.cloud.kms.v1.IDigest):google.cloud.kms.v1.Digest;

Creates a new Digest instance using the specified properties.

Parameter
NameDescription
propertiesIDigest

Properties to set

Returns
TypeDescription
Digest

Digest instance

decode(reader, length)

publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.kms.v1.Digest;

Decodes a Digest message from the specified reader or buffer.

Parameters
NameDescription
reader(Reader|Uint8Array)

Reader or buffer to decode from

lengthnumber

Message length if known beforehand

Returns
TypeDescription
Digest

Digest

decodeDelimited(reader)

publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.kms.v1.Digest;

Decodes a Digest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader(Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Digest

Digest

encode(message, writer)

publicstaticencode(message:google.cloud.kms.v1.IDigest,writer?:$protobuf.Writer):$protobuf.Writer;

Encodes the specified Digest message. Does not implicitly messages.

Parameters
NameDescription
messageIDigest

Digest message or plain object to encode

writer$protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

publicstaticencodeDelimited(message:google.cloud.kms.v1.IDigest,writer?:$protobuf.Writer):$protobuf.Writer;

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

Parameters
NameDescription
messageIDigest

Digest message or plain object to encode

writer$protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

publicstaticfromObject(object:{[k:string]:any}):google.cloud.kms.v1.Digest;

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

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

Plain object

Returns
TypeDescription
Digest

Digest

getTypeUrl(typeUrlPrefix)

publicstaticgetTypeUrl(typeUrlPrefix?:string):string;

Gets the default type url for Digest

Parameter
NameDescription
typeUrlPrefixstring

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

publictoJSON():{[k:string]:any};

Converts this Digest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

publicstatictoObject(message:google.cloud.kms.v1.Digest,options?:$protobuf.IConversionOptions):{[k:string]:any};

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

Parameters
NameDescription
messageDigest

Digest

options$protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

publicstaticverify(message:{[k:string]:any}):(string|null);

Verifies a Digest 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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.