Class: Request
Represents a Request.
Properties
asyncOperationId
• asyncOperationId: string
The id of the async operation that is creating/updating/deleting the capacity, if any.
endTime
• Optional endTime: null | $Properties
The date and time when the capacity request was completed or failed.
spec
• Optional spec: null | $Properties
The requested capacity specification.
startTime
• Optional startTime: null | $Properties
The date and time when the capacity request was created.
state
• state: State
The current state of the capacity request (e.g. in-progress, completed, failed).
Methods
toJSON
▸ toJSON(): Object
Converts this Request to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Request & $Shape
Creates a new Request instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
Request instance
▸ create(properties?): Request
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Request & $Shape
Decodes a Request 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
Request
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Request & $Shape
Decodes a Request message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Request
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 Request message. Does not implicitly temporal.api.cloud.namespace.v1.Capacity.Request.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Request message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Request message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.Capacity.Request.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Request message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Request
Creates a Request message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Request
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Request message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Request | Request |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object