Class protos.google.cloud.security.privateca.v1.Subject

Represents a Subject.

Package

@google-cloud/security-private-ca!

Constructors

(constructor)(properties)

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

Constructs a new Subject.

Parameter
NameDescription
properties ISubject

Properties to set

Properties

commonName

public commonName: string;

Subject commonName.

Property Value
TypeDescription
string

countryCode

public countryCode: string;

Subject countryCode.

Property Value
TypeDescription
string

locality

public locality: string;

Subject locality.

Property Value
TypeDescription
string

organization

public organization: string;

Subject organization.

Property Value
TypeDescription
string

organizationalUnit

public organizationalUnit: string;

Subject organizationalUnit.

Property Value
TypeDescription
string

postalCode

public postalCode: string;

Subject postalCode.

Property Value
TypeDescription
string

province

public province: string;

Subject province.

Property Value
TypeDescription
string

streetAddress

public streetAddress: string;

Subject streetAddress.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.cloud.security.privateca.v1.ISubject): google.cloud.security.privateca.v1.Subject;

Creates a new Subject instance using the specified properties.

Parameter
NameDescription
properties ISubject

Properties to set

Returns
TypeDescription
google.cloud.security.privateca.v1.Subject

Subject instance

decode(reader, length)

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

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

Subject

decodeDelimited(reader)

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

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

Subject

encode(message, writer)

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

Encodes the specified Subject message. Does not implicitly messages.

Parameters
NameDescription
message ISubject

Subject 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.ISubject, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISubject

Subject 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.Subject;

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

Subject

toJSON()

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

Converts this Subject to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.security.privateca.v1.Subject

Subject

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 Subject 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