Class: ResolvedPrincipal

ResolvedPrincipal is a principal returned to an API caller.

Properties

nameAtWriteTime

nameAtWriteTime: string

Identifier within that category (e.g., sub JWT claim, email address).

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: Identifies the principal name snapshot used for this response. --) (-- api-linter: core::0142::time-field-type=disabled aip.dev/not-precedent: This string is a principal name snapshot, not a timestamp. --)

---

type

type: string

Low-cardinality category of the principal (e.g., "jwt", "users").

Methods

toJSON()

toJSON(): object

Converts this ResolvedPrincipal to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): ResolvedPrincipal & $Properties

Creates a new ResolvedPrincipal instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

ResolvedPrincipal & $Properties

ResolvedPrincipal instance

Call Signature

static create(properties?): ResolvedPrincipal

Creates a new ResolvedPrincipal instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

ResolvedPrincipal

ResolvedPrincipal instance

---

decode()

static decode(reader, length?): ResolvedPrincipal & $Properties

Decodes a ResolvedPrincipal message from the specified reader or buffer.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?

number

Message length if known beforehand

Returns

ResolvedPrincipal & $Properties

ResolvedPrincipal

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): ResolvedPrincipal & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

ResolvedPrincipal & $Properties

ResolvedPrincipal

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Encodes the specified ResolvedPrincipal message. Does not implicitly temporal.api.common.v1.ResolvedPrincipal.verify|verify messages.

Parameters

message

$Properties

ResolvedPrincipal message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified ResolvedPrincipal message, length delimited. Does not implicitly temporal.api.common.v1.ResolvedPrincipal.verify|verify messages.

Parameters

message

$Properties

ResolvedPrincipal message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): ResolvedPrincipal

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

Parameters

object

{[k: string]: any; }

Plain object

Returns

ResolvedPrincipal

ResolvedPrincipal

---

toObject()

static toObject(message, options?): object

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

Parameters

message

ResolvedPrincipal

ResolvedPrincipal

options?

IConversionOptions

Conversion options

Returns

object

Plain object