Class: UserGroupSpec

identity.v1.UserGroupSpec

Represents a UserGroupSpec.

Implements

• IUserGroupSpec

Constructors

constructor

• new UserGroupSpec(properties?): UserGroupSpec

Constructs a new UserGroupSpec.

Parameters

Name	Type	Description
properties?	IUserGroupSpec	Properties to set

Returns

UserGroupSpec

Properties

access

• Optional access: null | IAccess

The access assigned to the group.

Implementation of

IUserGroupSpec.access

---

displayName

• displayName: string

The display name of the group.

Implementation of

IUserGroupSpec.displayName

---

googleGroup

• Optional googleGroup: null | IGoogleGroupSpec

The specification of the google group that this group is associated with. For now only google groups are supported, and this field is required.

Implementation of

IUserGroupSpec.googleGroup

Methods

toJSON

▸ toJSON(): Object

Converts this UserGroupSpec to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): UserGroupSpec

Creates a new UserGroupSpec instance using the specified properties.

Parameters

Name	Type	Description
properties?	IUserGroupSpec	Properties to set

Returns

UserGroupSpec

UserGroupSpec instance

---

decode

▸ decode(reader, length?): UserGroupSpec

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

UserGroupSpec

UserGroupSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): UserGroupSpec

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

Parameters

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

Returns

UserGroupSpec

UserGroupSpec

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

Parameters

Name	Type	Description
message	IUserGroupSpec	UserGroupSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IUserGroupSpec	UserGroupSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): UserGroupSpec

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

UserGroupSpec

UserGroupSpec

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for UserGroupSpec

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

Parameters

Name	Type	Description
message	UserGroupSpec	UserGroupSpec
options?	IConversionOptions	Conversion options

Returns

Object

Plain object