Class protos.google.cloud.kms.v1.Digest

Represents a Digest.

Package

@google-cloud/kms!

Constructors

(constructor)(properties)

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

Constructs a new Digest.

Parameter
Type Name Description
IDigest
properties

Properties to set

Properties

digest

  public 
  
 digest 
 ?: 
  
 ( 
 "sha256" 
 | 
 "sha384" 
 | 
 "sha512" 
 ); 
 

Digest digest.

Property Value
Type Description
("sha256"|"sha384"|"sha512")

sha256

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

Digest sha256.

Property Value
Type Description
( Uint8Array |string|null)

sha384

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

Digest sha384.

Property Value
Type Description
( Uint8Array |string|null)

sha512

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

Digest sha512.

Property Value
Type Description
( Uint8Array |string|null)

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 kms 
 . 
 v1 
 . 
 IDigest 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 kms 
 . 
 v1 
 . 
 Digest 
 ; 
 

Creates a new Digest instance using the specified properties.

Parameter
Type Name Description
IDigest
properties

Properties to set

Returns
Type Description
google.cloud.kms.v1.Digest

Digest instance

decode(reader, length)

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

Decodes a Digest message from the specified reader or buffer.

Parameters
Type Name Description
($protobuf. Reader | Uint8Array )
reader

Reader or buffer to decode from

number
length

Message length if known beforehand

Returns
Type Description
google.cloud.kms.v1.Digest

Digest

decodeDelimited(reader)

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

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

Parameter
Type Name Description
($protobuf. Reader | Uint8Array )
reader

Reader or buffer to decode from

Returns
Type Description
google.cloud.kms.v1.Digest

Digest

encode(message, writer)

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

Encodes the specified Digest message. Does not implicitly messages.

Parameters
Type Name Description
IDigest
message

Digest message or plain object to encode

$protobuf. Writer
writer

Writer to encode to

Returns
Type Description
$protobuf. Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Type Name Description
IDigest
message

Digest message or plain object to encode

$protobuf. Writer
writer

Writer to encode to

Returns
Type Description
$protobuf. Writer

Writer

fromObject(object)

  public 
  
 static 
  
 fromObject 
 ( 
 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
Type Name Description
{ [k: string]: any }
object

Plain object

Returns
Type Description
google.cloud.kms.v1.Digest

Digest

toJSON()

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

Converts this Digest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

  public 
  
 static 
  
 toObject 
 ( 
 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
Type Name Description
google.cloud.kms.v1.Digest
message

Digest

$protobuf. IConversionOptions
options

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Digest message.

Parameter
Type Name Description
{ [k: string]: any }
message

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not

Create a Mobile Website
View Site in Mobile | Classic
Share by: