Class protos.google.cloud.security.privateca.v1.X509Parameters.CaOptions (2.5.0)

Represents a CaOptions.

Package

@google-cloud/security-private-ca!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.security.privateca.v1.X509Parameters.ICaOptions);

Constructs a new CaOptions.

Parameter

Name	Description
properties	`ICaOptions` Properties to set

Properties

_isCa

public _isCa?: "isCa";

CaOptions _isCa.

Property Value

Type	Description
"isCa"

_maxIssuerPathLength

public _maxIssuerPathLength?: "maxIssuerPathLength";

CaOptions _maxIssuerPathLength.

Property Value

Type	Description
"maxIssuerPathLength"

isCa

public isCa?: (boolean|null);

CaOptions isCa.

Property Value

Type	Description
(boolean\|null)

maxIssuerPathLength

public maxIssuerPathLength?: (number|null);

CaOptions maxIssuerPathLength.

Property Value

Type	Description
(number\|null)

Methods

create(properties)

public static create(properties?: google.cloud.security.privateca.v1.X509Parameters.ICaOptions): google.cloud.security.privateca.v1.X509Parameters.CaOptions;

Creates a new CaOptions instance using the specified properties.

Parameter

Name	Description
properties	`ICaOptions` Properties to set

Returns

Type	Description
google.cloud.security.privateca.v1.X509Parameters.CaOptions	CaOptions instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.security.privateca.v1.X509Parameters.CaOptions;

Decodes a CaOptions 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.v1.X509Parameters.CaOptions	CaOptions

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.security.privateca.v1.X509Parameters.CaOptions;

Decodes a CaOptions 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.v1.X509Parameters.CaOptions	CaOptions

encode(message, writer)

public static encode(message: google.cloud.security.privateca.v1.X509Parameters.ICaOptions, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CaOptions message. Does not implicitly messages.

Parameters

Name	Description
message	`ICaOptions` CaOptions 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.v1.X509Parameters.ICaOptions, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`ICaOptions` CaOptions 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.v1.X509Parameters.CaOptions;

Creates a CaOptions 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.v1.X509Parameters.CaOptions	CaOptions

toJSON()

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

Converts this CaOptions to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.security.privateca.v1.X509Parameters.CaOptions` CaOptions
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 CaOptions 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