Skip to main content

Class: DeleteScheduleRequest

workflowservice.v1.DeleteScheduleRequest

Represents a DeleteScheduleRequest.

Implements

Constructors

constructor

new DeleteScheduleRequest(properties?)

Constructs a new DeleteScheduleRequest.

Parameters

NameTypeDescription
properties?IDeleteScheduleRequestProperties to set

Properties

identity

identity: string

DeleteScheduleRequest identity.

Implementation of

IDeleteScheduleRequest.identity


namespace

namespace: string

DeleteScheduleRequest namespace.

Implementation of

IDeleteScheduleRequest.namespace


scheduleId

scheduleId: string

DeleteScheduleRequest scheduleId.

Implementation of

IDeleteScheduleRequest.scheduleId

Methods

toJSON

toJSON(): Object

Converts this DeleteScheduleRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): DeleteScheduleRequest

Creates a new DeleteScheduleRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IDeleteScheduleRequestProperties to set

Returns

DeleteScheduleRequest

DeleteScheduleRequest instance


decode

Static decode(reader, length?): DeleteScheduleRequest

Decodes a DeleteScheduleRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

DeleteScheduleRequest

DeleteScheduleRequest


decodeDelimited

Static decodeDelimited(reader): DeleteScheduleRequest

Decodes a DeleteScheduleRequest message from the specified reader or buffer, length delimited.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

DeleteScheduleRequest

DeleteScheduleRequest


encode

Static encode(message, writer?): Writer

Encodes the specified DeleteScheduleRequest message. Does not implicitly temporal.api.workflowservice.v1.DeleteScheduleRequest.verify|verify messages.

Parameters

NameTypeDescription
messageIDeleteScheduleRequestDeleteScheduleRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

Encodes the specified DeleteScheduleRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DeleteScheduleRequest.verify|verify messages.

Parameters

NameTypeDescription
messageIDeleteScheduleRequestDeleteScheduleRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

Static fromObject(object): DeleteScheduleRequest

Creates a DeleteScheduleRequest message from a plain object. Also converts values to their respective internal types.

Parameters

NameTypeDescription
objectObjectPlain object

Returns

DeleteScheduleRequest

DeleteScheduleRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DeleteScheduleRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

Creates a plain object from a DeleteScheduleRequest message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageDeleteScheduleRequestDeleteScheduleRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object