Skip to main content

Class: AccountAccess

identity.v1.AccountAccess

Represents an AccountAccess.

Implements

Constructors

constructor

new AccountAccess(properties?): AccountAccess

Constructs a new AccountAccess.

Parameters

NameTypeDescription
properties?IAccountAccessProperties to set

Returns

AccountAccess

Properties

role

role: Role

The role on the account. temporal:versioning:min_version=2024-10-01-00 temporal:enums:replaces=role_deprecated

Implementation of

IAccountAccess.role


roleDeprecated

roleDeprecated: string

The role on the account, should be one of [owner, admin, developer, financeadmin, read] owner - gives full access to the account, including users, namespaces, and billing admin - gives full access the account, including users and namespaces developer - gives access to create namespaces on the account financeadmin - gives read only access and write access for billing read - gives read only access to the account Deprecated: Not supported after 2024-10-01-00 api version. Use role instead. temporal:versioning:max_version=2024-10-01-00

Implementation of

IAccountAccess.roleDeprecated

Methods

toJSON

toJSON(): Object

Converts this AccountAccess to JSON.

Returns

Object

JSON object


create

create(properties?): AccountAccess

Creates a new AccountAccess instance using the specified properties.

Parameters

NameTypeDescription
properties?IAccountAccessProperties to set

Returns

AccountAccess

AccountAccess instance


decode

decode(reader, length?): AccountAccess

Decodes an AccountAccess message from the specified reader or buffer.

Parameters

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

Returns

AccountAccess

AccountAccess

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): AccountAccess

Decodes an AccountAccess message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

AccountAccess

AccountAccess

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): AccountAccess

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

AccountAccess

AccountAccess


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for AccountAccess

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

Parameters

NameTypeDescription
messageAccountAccessAccountAccess
options?IConversionOptionsConversion options

Returns

Object

Plain object