Class: ListSchedulesRequest
workflowservice.v1.ListSchedulesRequest
Represents a ListSchedulesRequest.
Implements
Constructors
constructor
• new ListSchedulesRequest(properties?): ListSchedulesRequest
Constructs a new ListSchedulesRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListSchedulesRequest | Properties to set |
Returns
Properties
maximumPageSize
• maximumPageSize: number
How many to return at once.
Implementation of
IListSchedulesRequest.maximumPageSize
namespace
• namespace: string
The namespace to list schedules in.
Implementation of
IListSchedulesRequest.namespace
nextPageToken
• nextPageToken: Uint8Array
Token to get the next page of results.
Implementation of
IListSchedulesRequest.nextPageToken
query
• query: string
Query to filter schedules.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this ListSchedulesRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ListSchedulesRequest
Creates a new ListSchedulesRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListSchedulesRequest | Properties to set |
Returns
ListSchedulesRequest instance
decode
▸ decode(reader, length?): ListSchedulesRequest
Decodes a ListSchedulesRequest 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
ListSchedulesRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ListSchedulesRequest
Decodes a ListSchedulesRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ListSchedulesRequest
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 ListSchedulesRequest message. Does not implicitly temporal.api.workflowservice.v1.ListSchedulesRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListSchedulesRequest | ListSchedulesRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ListSchedulesRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ListSchedulesRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListSchedulesRequest | ListSchedulesRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ListSchedulesRequest
Creates a ListSchedulesRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ListSchedulesRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ListSchedulesRequest
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 ListSchedulesRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ListSchedulesRequest | ListSchedulesRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object