Class: UpdateActivityOptionsByIdRequest
workflowservice.v1.UpdateActivityOptionsByIdRequest
Represents an UpdateActivityOptionsByIdRequest.
Implements
Constructors
constructor
• new UpdateActivityOptionsByIdRequest(properties?): UpdateActivityOptionsByIdRequest
Constructs a new UpdateActivityOptionsByIdRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateActivityOptionsByIdRequest | Properties to set |
Returns
UpdateActivityOptionsByIdRequest
Properties
activityId
• activityId: string
ID of the activity we're updating
Implementation of
IUpdateActivityOptionsByIdRequest.activityId
activityOptions
• Optional activityOptions: null | IActivityOptions
Activity options. Partial updates are accepted and controlled by update_mask
Implementation of
IUpdateActivityOptionsByIdRequest.activityOptions
identity
• identity: string
The identity of the client who initiated this request
Implementation of
IUpdateActivityOptionsByIdRequest.identity
namespace
• namespace: string
Namespace of the workflow which scheduled this activity
Implementation of
IUpdateActivityOptionsByIdRequest.namespace
requestId
• requestId: string
Used to de-dupe requests
Implementation of
IUpdateActivityOptionsByIdRequest.requestId
runId
• runId: string
Run ID of the workflow which scheduled this activity if empty - latest workflow is used
Implementation of
IUpdateActivityOptionsByIdRequest.runId
updateMask
• Optional updateMask: null | IFieldMask
Controls which fields from activity_options will be applied
Implementation of
IUpdateActivityOptionsByIdRequest.updateMask
workflowId
• workflowId: string
ID of the workflow which scheduled this activity
Implementation of
IUpdateActivityOptionsByIdRequest.workflowId
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateActivityOptionsByIdRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateActivityOptionsByIdRequest
Creates a new UpdateActivityOptionsByIdRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateActivityOptionsByIdRequest | Properties to set |
Returns
UpdateActivityOptionsByIdRequest
UpdateActivityOptionsByIdRequest instance
decode
▸ decode(reader, length?): UpdateActivityOptionsByIdRequest
Decodes an UpdateActivityOptionsByIdRequest 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
UpdateActivityOptionsByIdRequest
UpdateActivityOptionsByIdRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateActivityOptionsByIdRequest
Decodes an UpdateActivityOptionsByIdRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateActivityOptionsByIdRequest
UpdateActivityOptionsByIdRequest
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 UpdateActivityOptionsByIdRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateActivityOptionsByIdRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateActivityOptionsByIdRequest | UpdateActivityOptionsByIdRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateActivityOptionsByIdRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateActivityOptionsByIdRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateActivityOptionsByIdRequest | UpdateActivityOptionsByIdRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateActivityOptionsByIdRequest
Creates an UpdateActivityOptionsByIdRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateActivityOptionsByIdRequest
UpdateActivityOptionsByIdRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateActivityOptionsByIdRequest
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 an UpdateActivityOptionsByIdRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateActivityOptionsByIdRequest | UpdateActivityOptionsByIdRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object