Class: Limits
Represents a Limits.
Implements
Constructors
constructor
• new Limits(properties?): Limits
Constructs a new Limits.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ILimits | Properties to set |
Returns
Properties
actionsPerSecondLimit
• actionsPerSecondLimit: number
The number of actions per second (APS) that is currently allowed for the namespace. The namespace may be throttled if its APS exceeds the limit.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Limits to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Limits
Creates a new Limits instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ILimits | Properties to set |
Returns
Limits instance
decode
▸ decode(reader, length?): Limits
Decodes a Limits 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
Limits
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Limits
Decodes a Limits message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Limits
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 Limits message. Does not implicitly temporal.api.cloud.namespace.v1.Limits.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ILimits | Limits message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Limits message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.Limits.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ILimits | Limits message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Limits
Creates a Limits message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Limits
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Limits
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 Limits message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Limits | Limits |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object