Class: DeleteScheduleRequest
workflowservice.v1.DeleteScheduleRequest
(-- api-linter: core::0135::request-name-required=disabled aip.dev/not-precedent: DeleteSchedule doesn't follow Google API format --) (-- api-linter: core::0135::request-unknown-fields=disabled aip.dev/not-precedent: DeleteSchedule doesn't follow Google API format --)
Implements
Constructors
constructor
• new DeleteScheduleRequest(properties?): DeleteScheduleRequest
Constructs a new DeleteScheduleRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteScheduleRequest | Properties to set |
Returns
Properties
identity
• identity: string
The identity of the client who initiated this request.
Implementation of
IDeleteScheduleRequest.identity
namespace
• namespace: string
The namespace of the schedule to delete.
Implementation of
IDeleteScheduleRequest.namespace
scheduleId
• scheduleId: string
The id of the schedule to delete.
Implementation of
IDeleteScheduleRequest.scheduleId
Methods
toJSON
▸ toJSON(): Object
Converts this DeleteScheduleRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeleteScheduleRequest
Creates a new DeleteScheduleRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteScheduleRequest | Properties to set |
Returns
DeleteScheduleRequest instance
decode
▸ decode(reader, length?): DeleteScheduleRequest
Decodes a DeleteScheduleRequest 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
DeleteScheduleRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeleteScheduleRequest
Decodes a DeleteScheduleRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DeleteScheduleRequest
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 DeleteScheduleRequest message. Does not implicitly temporal.api.workflowservice.v1.DeleteScheduleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeleteScheduleRequest | DeleteScheduleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeleteScheduleRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DeleteScheduleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeleteScheduleRequest | DeleteScheduleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeleteScheduleRequest
Creates a DeleteScheduleRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeleteScheduleRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DeleteScheduleRequest
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 DeleteScheduleRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeleteScheduleRequest | DeleteScheduleRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object