Skip to main content

Class: RemoveUserGroupMemberRequest

cloudservice.v1.RemoveUserGroupMemberRequest

Represents a RemoveUserGroupMemberRequest.

Implements

Constructors

constructor

new RemoveUserGroupMemberRequest(properties?): RemoveUserGroupMemberRequest

Constructs a new RemoveUserGroupMemberRequest.

Parameters

NameTypeDescription
properties?IRemoveUserGroupMemberRequestProperties to set

Returns

RemoveUserGroupMemberRequest

Properties

asyncOperationId

asyncOperationId: string

The id to use for this async operation. Optional, if not provided a random id will be generated.

Implementation of

IRemoveUserGroupMemberRequest.asyncOperationId


groupId

groupId: string

The id of the group to add the member for.

Implementation of

IRemoveUserGroupMemberRequest.groupId


memberId

Optional memberId: null | IUserGroupMemberId

The member id to add to the group.

Implementation of

IRemoveUserGroupMemberRequest.memberId

Methods

toJSON

toJSON(): Object

Converts this RemoveUserGroupMemberRequest to JSON.

Returns

Object

JSON object


create

create(properties?): RemoveUserGroupMemberRequest

Creates a new RemoveUserGroupMemberRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IRemoveUserGroupMemberRequestProperties to set

Returns

RemoveUserGroupMemberRequest

RemoveUserGroupMemberRequest instance


decode

decode(reader, length?): RemoveUserGroupMemberRequest

Decodes a RemoveUserGroupMemberRequest message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

RemoveUserGroupMemberRequest

RemoveUserGroupMemberRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): RemoveUserGroupMemberRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

RemoveUserGroupMemberRequest

RemoveUserGroupMemberRequest

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

Parameters

NameTypeDescription
messageIRemoveUserGroupMemberRequestRemoveUserGroupMemberRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIRemoveUserGroupMemberRequestRemoveUserGroupMemberRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): RemoveUserGroupMemberRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

RemoveUserGroupMemberRequest

RemoveUserGroupMemberRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for RemoveUserGroupMemberRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageRemoveUserGroupMemberRequestRemoveUserGroupMemberRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object