Skip to main content

Class: UserGroup

Represents a UserGroup.

Properties​

asyncOperationId​

asyncOperationId: string

The id of the async operation that is creating/updating/deleting the group, if any

createdTime?​

optional createdTime?: $Properties | null

The date and time when the group was created

id​

id: string

The id of the group

lastModifiedTime?​

optional lastModifiedTime?: $Properties | null

The date and time when the group was last modified Will not be set if the group has never been modified

resourceVersion​

resourceVersion: string

The current version of the group specification The next update operation will have to include this version

spec?​

optional spec?: $Properties | null

The group specification

state​

state: ResourceState

The current state of the group. For any failed state, reach out to Temporal Cloud support for remediation. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=state_deprecated

stateDeprecated​

stateDeprecated: string

The current state of the group. Deprecated: Not supported after v0.3.0 api version. Use state instead. temporal:versioning:max_version=v0.3.0

Methods​

toJSON()​

toJSON(): object

Converts this UserGroup to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UserGroup & $Shape

Creates a new UserGroup instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

UserGroup & $Shape

UserGroup instance

Call Signature​

static create(properties?): UserGroup

Creates a new UserGroup instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UserGroup

UserGroup instance

decode()​

static decode(reader, length?): UserGroup & $Shape

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

UserGroup & $Shape

UserGroup

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UserGroup & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UserGroup & $Shape

UserGroup

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

Parameters​

message​

$Properties

UserGroup message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UserGroup message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UserGroup

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

UserGroup

UserGroup

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UserGroup

UserGroup

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object