Class protos.google.cloud.security.privateca.v1.SubjectAltNames (4.1.2)

Represents a SubjectAltNames.

Package

Constructors

(constructor)(properties)

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

Constructs a new SubjectAltNames.

Parameter

Name	Description
properties	`ISubjectAltNames` Properties to set

Properties

customSans

public customSans: google.cloud.security.privateca.v1.IX509Extension[];

SubjectAltNames customSans.

dnsNames

public dnsNames: string[];

SubjectAltNames dnsNames.

emailAddresses

public emailAddresses: string[];

SubjectAltNames emailAddresses.

ipAddresses

public ipAddresses: string[];

SubjectAltNames ipAddresses.

uris

public uris: string[];

SubjectAltNames uris.

Methods

create(properties)

public static create(properties?: google.cloud.security.privateca.v1.ISubjectAltNames): google.cloud.security.privateca.v1.SubjectAltNames;

Creates a new SubjectAltNames instance using the specified properties.

Parameter

Name	Description
properties	`ISubjectAltNames` Properties to set

Returns

Type	Description
google.cloud.security.privateca.v1.SubjectAltNames	SubjectAltNames instance

decode(reader, length)

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

Decodes a SubjectAltNames 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.SubjectAltNames	SubjectAltNames

decodeDelimited(reader)

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

Decodes a SubjectAltNames 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.SubjectAltNames	SubjectAltNames

encode(message, writer)

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

Encodes the specified SubjectAltNames message. Does not implicitly messages.

Parameters

Name	Description
message	`ISubjectAltNames` SubjectAltNames 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.ISubjectAltNames, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`ISubjectAltNames` SubjectAltNames 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.SubjectAltNames;

Creates a SubjectAltNames 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.SubjectAltNames	SubjectAltNames

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SubjectAltNames

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 SubjectAltNames to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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