Class protos.google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions (2.4.1)

Version 2.4.1

• 5.2.0 (latest)
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.2
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.1
• 2.3.7

Represents a KeyUsageOptions.

Package

@google-cloud/security-private-ca!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.security.privateca.v1beta1.KeyUsage.IKeyUsageOptions);

Constructs a new KeyUsageOptions.

Parameter

Name	Description
properties	IKeyUsageOptions Properties to set

Properties

certSign

public certSign: boolean;

KeyUsageOptions certSign.

Property Value

Type	Description
boolean

contentCommitment

public contentCommitment: boolean;

KeyUsageOptions contentCommitment.

Property Value

Type	Description
boolean

crlSign

public crlSign: boolean;

KeyUsageOptions crlSign.

Property Value

Type	Description
boolean

dataEncipherment

public dataEncipherment: boolean;

KeyUsageOptions dataEncipherment.

Property Value

Type	Description
boolean

decipherOnly

public decipherOnly: boolean;

KeyUsageOptions decipherOnly.

Property Value

Type	Description
boolean

digitalSignature

public digitalSignature: boolean;

KeyUsageOptions digitalSignature.

Property Value

Type	Description
boolean

encipherOnly

public encipherOnly: boolean;

KeyUsageOptions encipherOnly.

Property Value

Type	Description
boolean

keyAgreement

public keyAgreement: boolean;

KeyUsageOptions keyAgreement.

Property Value

Type	Description
boolean

keyEncipherment

public keyEncipherment: boolean;

KeyUsageOptions keyEncipherment.

Property Value

Type	Description
boolean

Methods

create(properties)

public static create(properties?: google.cloud.security.privateca.v1beta1.KeyUsage.IKeyUsageOptions): google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions;

Creates a new KeyUsageOptions instance using the specified properties.

Parameter

Name	Description
properties	IKeyUsageOptions Properties to set

Returns

Type	Description
google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions	KeyUsageOptions instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions;

Decodes a KeyUsageOptions message from the specified reader or buffer.

Parameters

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions	KeyUsageOptions

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions;

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

Parameter

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions	KeyUsageOptions

encode(message, writer)

public static encode(message: google.cloud.security.privateca.v1beta1.KeyUsage.IKeyUsageOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified KeyUsageOptions message. Does not implicitly messages.

Parameters

Name	Description
message	IKeyUsageOptions KeyUsageOptions 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.security.privateca.v1beta1.KeyUsage.IKeyUsageOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IKeyUsageOptions KeyUsageOptions 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.security.privateca.v1beta1.KeyUsage.KeyUsageOptions;

Creates a KeyUsageOptions 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
google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions	KeyUsageOptions

toJSON()

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

Converts this KeyUsageOptions to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	google.cloud.security.privateca.v1beta1.KeyUsage.KeyUsageOptions KeyUsageOptions
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 KeyUsageOptions 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