Class protos.google.cloud.security.privateca.v1.X509Parameters.NameConstraints (4.3.0)

Represents a NameConstraints.

Package

@google-cloud/security-private-ca

Constructors

(constructor)(properties)

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

Constructs a new NameConstraints.

Parameter
NameDescription
properties INameConstraints

Properties to set

Properties

critical

public critical: boolean;

NameConstraints critical.

excludedDnsNames

public excludedDnsNames: string[];

NameConstraints excludedDnsNames.

excludedEmailAddresses

public excludedEmailAddresses: string[];

NameConstraints excludedEmailAddresses.

excludedIpRanges

public excludedIpRanges: string[];

NameConstraints excludedIpRanges.

excludedUris

public excludedUris: string[];

NameConstraints excludedUris.

permittedDnsNames

public permittedDnsNames: string[];

NameConstraints permittedDnsNames.

permittedEmailAddresses

public permittedEmailAddresses: string[];

NameConstraints permittedEmailAddresses.

permittedIpRanges

public permittedIpRanges: string[];

NameConstraints permittedIpRanges.

permittedUris

public permittedUris: string[];

NameConstraints permittedUris.

Methods

create(properties)

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

Creates a new NameConstraints instance using the specified properties.

Parameter
NameDescription
properties INameConstraints

Properties to set

Returns
TypeDescription
google.cloud.security.privateca.v1.X509Parameters.NameConstraints

NameConstraints instance

decode(reader, length)

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

Decodes a NameConstraints message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.security.privateca.v1.X509Parameters.NameConstraints

NameConstraints

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.security.privateca.v1.X509Parameters.NameConstraints

NameConstraints

encode(message, writer)

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

Encodes the specified NameConstraints message. Does not implicitly messages.

Parameters
NameDescription
message INameConstraints

NameConstraints message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message INameConstraints

NameConstraints message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.security.privateca.v1.X509Parameters.NameConstraints;

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

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

Plain object

Returns
TypeDescription
google.cloud.security.privateca.v1.X509Parameters.NameConstraints

NameConstraints

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for NameConstraints

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this NameConstraints to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.security.privateca.v1.X509Parameters.NameConstraints

NameConstraints

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

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