Class: UserGroup

identity.v1.UserGroup

Represents a UserGroup.

Implements

• IUserGroup

Constructors

constructor

• new UserGroup(properties?): UserGroup

Constructs a new UserGroup.

Parameters

Name	Type	Description
properties?	IUserGroup	Properties to set

Returns

UserGroup

Properties

asyncOperationId

• asyncOperationId: string

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

Implementation of

IUserGroup.asyncOperationId

---

createdTime

• Optional createdTime: null | ITimestamp

The date and time when the group was created

Implementation of

IUserGroup.createdTime

---

id

• id: string

The id of the group

Implementation of

IUserGroup.id

---

lastModifiedTime

• Optional lastModifiedTime: null | ITimestamp

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

Implementation of

IUserGroup.lastModifiedTime

---

resourceVersion

• resourceVersion: string

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

Implementation of

IUserGroup.resourceVersion

---

spec

• Optional spec: null | IUserGroupSpec

The group specification

Implementation of

IUserGroup.spec

---

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

Implementation of

IUserGroup.state

---

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

Implementation of

IUserGroup.stateDeprecated

Methods

toJSON

▸ toJSON(): Object

Converts this UserGroup to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): UserGroup

Creates a new UserGroup instance using the specified properties.

Parameters

Name	Type	Description
properties?	IUserGroup	Properties to set

Returns

UserGroup

UserGroup instance

---

decode

▸ decode(reader, length?): UserGroup

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

UserGroup

UserGroup

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): UserGroup

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

Parameters

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

Returns

UserGroup

UserGroup

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

Parameters

Name	Type	Description
message	IUserGroup	UserGroup message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IUserGroup	UserGroup message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): UserGroup

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

UserGroup

UserGroup

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for UserGroup

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 UserGroup message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	UserGroup	UserGroup
options?	IConversionOptions	Conversion options

Returns

Object

Plain object