Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TriggerRun

Package version

Trigger runs. Interface representing a TriggerRun.

Hierarchy

  • TriggerRun

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Optional message

message: undefined | string

Trigger error message. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | {}

List of property name and value related to trigger run. Name, value pair depends on type of trigger. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

Trigger run status. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggerName

triggerName: undefined | string

Trigger name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggerRunId

triggerRunId: undefined | string

Trigger run id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggerRunTimestamp

triggerRunTimestamp: Date

Trigger run start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggerType

triggerType: undefined | string

Trigger type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggeredPipelines

triggeredPipelines: undefined | {}

List of pipeline name and run Id triggered by the trigger run. NOTE: This property will not be serialized. It can only be populated by the server.

Methods

cancelTriggerInstance

  • cancelTriggerInstance(triggerName: string, runId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>
  • Cancel single trigger instance by runId.

    Parameters

    • triggerName: string

      The trigger name.

    • runId: string

      The pipeline run identifier.

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<coreHttp.RestResponse>

queryTriggerRunsByWorkspace

rerunTriggerInstance

  • rerunTriggerInstance(triggerName: string, runId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>
  • Rerun single trigger instance by runId.

    Parameters

    • triggerName: string

      The trigger name.

    • runId: string

      The pipeline run identifier.

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<coreHttp.RestResponse>

Generated using TypeDoc