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

Represents a Certificate.

Package

@google-cloud/kms

Constructors

(constructor)(properties)

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

Constructs a new Certificate.

Parameter
Name
Description
properties
ICertificate

Properties to set

Properties

issuer

  public 
  
 issuer 
 : 
  
 string 
 ; 
 

Certificate issuer.

notAfterTime

  public 
  
 notAfterTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Certificate notAfterTime.

notBeforeTime

  public 
  
 notBeforeTime 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

Certificate notBeforeTime.

parsed

  public 
  
 parsed 
 : 
  
 boolean 
 ; 
 

Certificate parsed.

rawDer

  public 
  
 rawDer 
 : 
  
 ( 
 Uint8Array 
 | 
 string 
 ); 
 

Certificate rawDer.

serialNumber

  public 
  
 serialNumber 
 : 
  
 string 
 ; 
 

Certificate serialNumber.

sha256Fingerprint

  public 
  
 sha256Fingerprint 
 : 
  
 string 
 ; 
 

Certificate sha256Fingerprint.

subject

  public 
  
 subject 
 : 
  
 string 
 ; 
 

Certificate subject.

subjectAlternativeDnsNames

  public 
  
 subjectAlternativeDnsNames 
 : 
  
 string 
 []; 
 

Certificate subjectAlternativeDnsNames.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 kms 
 . 
 v1 
 . 
 ICertificate 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 kms 
 . 
 v1 
 . 
 Certificate 
 ; 
 

Creates a new Certificate instance using the specified properties.

Parameter
Name
Description
properties
ICertificate

Properties to set

Returns
Type
Description

Certificate instance

decode(reader, length)

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

Decodes a Certificate message from the specified reader or buffer.

Parameters
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

length
number

Message length if known beforehand

Returns
Type
Description

Certificate

decodeDelimited(reader)

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

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

Parameter
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type
Description

Certificate

encode(message, writer)

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

Encodes the specified Certificate message. Does not implicitly messages.

Parameters
Name
Description
message
ICertificate

Certificate message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Name
Description
message
ICertificate

Certificate message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
Name
Description
object
{ [k: string]: any }

Plain object

Returns
Type
Description

Certificate

getTypeUrl(typeUrlPrefix)

  public 
  
 static 
  
 getTypeUrl 
 ( 
 typeUrlPrefix 
 ?: 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Gets the default type url for Certificate

Parameter
Name
Description
typeUrlPrefix
string

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

Returns
Type
Description
string

The default type url

toJSON()

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

Converts this Certificate to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name
Description
message
Certificate

Certificate

options
$protobuf.IConversionOptions

Conversion options

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

Plain object

verify(message)

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

Verifies a Certificate message.

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

Plain object to verify

Returns
Type
Description
(string|null)

null if valid, otherwise the reason why it is not

Design a Mobile Site
View Site in Mobile | Classic
Share by: