Class: Principal

auditlog.v1.Principal

Represents a Principal.

Implements

• IPrincipal

Constructors

constructor

• new Principal(properties?): Principal

Constructs a new Principal.

Parameters

Name	Type	Description
properties?	IPrincipal	Properties to set

Returns

Principal

Properties

apiKeyId

• apiKeyId: string

The api key id of the principal if provided.

Implementation of

IPrincipal.apiKeyId

---

id

• id: string

The id of the principal.

Implementation of

IPrincipal.id

---

name

• name: string

The name of the principal.

Implementation of

IPrincipal.name

---

type

• type: string

The type of the principal. Possible type values: user, serviceaccount.

Implementation of

IPrincipal.type

Methods

toJSON

▸ toJSON(): Object

Converts this Principal to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Principal

Creates a new Principal instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPrincipal	Properties to set

Returns

Principal

Principal instance

---

decode

▸ decode(reader, length?): Principal

Decodes a Principal message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

Principal

Principal

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Principal

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

Principal

Principal

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

Encodes the specified Principal message. Does not implicitly temporal.api.cloud.auditlog.v1.Principal.verify|verify messages.

Parameters

Name	Type	Description
message	IPrincipal	Principal message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified Principal message, length delimited. Does not implicitly temporal.api.cloud.auditlog.v1.Principal.verify|verify messages.

Parameters

Name	Type	Description
message	IPrincipal	Principal message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): Principal

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

Principal

Principal

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Principal

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	Principal	Principal
options?	IConversionOptions	Conversion options

Returns

Object

Plain object