Skip to main content

Class: NamespaceAccess

identity.v1.NamespaceAccess

Represents a NamespaceAccess.

Properties​

permission​

• permission: Permission

The permission to the namespace. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=permission_deprecated


permissionDeprecated​

• permissionDeprecated: string

The permission to the namespace, should be one of [admin, write, read] admin - gives full access to the namespace, including assigning namespace access to other users write - gives write access to the namespace configuration and workflows within the namespace read - gives read only access to the namespace configuration and workflows within the namespace Deprecated: Not supported after v0.3.0 api version. Use permission instead. temporal:versioning:max_version=v0.3.0

Methods​

toJSON​

▸ toJSON(): Object

Converts this NamespaceAccess to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): NamespaceAccess & $Properties

Creates a new NamespaceAccess instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

NamespaceAccess & $Properties

NamespaceAccess instance

▸ create(properties?): NamespaceAccess

Parameters​

NameType
properties?$Properties

Returns​

NamespaceAccess


decode​

▸ decode(reader, length?): NamespaceAccess & $Properties

Decodes a NamespaceAccess message from the specified reader or buffer.

Parameters​

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

Returns​

NamespaceAccess & $Properties

NamespaceAccess

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): NamespaceAccess & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

NamespaceAccess & $Properties

NamespaceAccess

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

Parameters​

NameTypeDescription
message$PropertiesNamespaceAccess message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesNamespaceAccess message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): NamespaceAccess

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

NamespaceAccess

NamespaceAccess


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageNamespaceAccessNamespaceAccess
options?IConversionOptionsConversion options

Returns​

Object

Plain object