Skip to main content

Class: ServiceAccountSpec

Represents a ServiceAccountSpec.

Properties​

access?​

optional access?: $Properties | null

Note: one of Access or NamespaceScopedAccess must be provided, but not both. The access assigned to the service account. If set, creates an account scoped service account. The access is mutable.


description​

description: string

The description associated with the service account - optional. The description is mutable.


name​

name: string

The name associated with the service account. The name is mutable, but must be unique across all your active service accounts.


namespaceScopedAccess?​

optional namespaceScopedAccess?: $Properties | null

The namespace scoped access assigned to the service account. If set, creates a namespace scoped service account (limited to a single namespace). The namespace scoped access is partially mutable. Refer to NamespaceScopedAccess for details.

Methods​

toJSON()​

toJSON(): object

Converts this ServiceAccountSpec to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): ServiceAccountSpec & $Properties

Creates a new ServiceAccountSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ServiceAccountSpec & $Properties

ServiceAccountSpec instance

Call Signature​

static create(properties?): ServiceAccountSpec

Creates a new ServiceAccountSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ServiceAccountSpec

ServiceAccountSpec instance


decode()​

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

Decodes a ServiceAccountSpec 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​

ServiceAccountSpec & $Properties

ServiceAccountSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): ServiceAccountSpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ServiceAccountSpec & $Properties

ServiceAccountSpec

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 ServiceAccountSpec message. Does not implicitly temporal.api.cloud.identity.v1.ServiceAccountSpec.verify|verify messages.

Parameters​

message​

$Properties

ServiceAccountSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ServiceAccountSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): ServiceAccountSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ServiceAccountSpec

ServiceAccountSpec


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ServiceAccountSpec

ServiceAccountSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object