Class: Request

v1.Capacity.Request

Represents a Request.

Implements

• IRequest

Constructors

constructor

• new Request(properties?): Request

Constructs a new Request.

Parameters

Name	Type	Description
properties?	IRequest	Properties to set

Returns

Request

Properties

asyncOperationId

• asyncOperationId: string

The id of the async operation that is creating/updating/deleting the capacity, if any.

Implementation of

IRequest.asyncOperationId

---

endTime

• Optional endTime: null | ITimestamp

The date and time when the capacity request was completed or failed.

Implementation of

IRequest.endTime

---

spec

• Optional spec: null | ICapacitySpec

The requested capacity specification.

Implementation of

IRequest.spec

---

startTime

• Optional startTime: null | ITimestamp

The date and time when the capacity request was created.

Implementation of

IRequest.startTime

---

state

• state: State

The current state of the capacity request (e.g. in-progress, completed, failed).

Implementation of

IRequest.state

Methods

toJSON

▸ toJSON(): Object

Converts this Request to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Request

Creates a new Request instance using the specified properties.

Parameters

Name	Type	Description
properties?	IRequest	Properties to set

Returns

Request

Request instance

---

decode

▸ decode(reader, length?): Request

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

Request

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Request

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

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	IRequest	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	IRequest	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

Request

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Request

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 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