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