WorkflowExecutions

import { WorkflowExecutions } from "https://googleapis.deno.dev/v1/workflowexecutions:v1.ts";

Execute workflows created with Workflows API.

class WorkflowExecutions {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsWorkflowsExecutionsCallbacksList(parent: string, opts?: ProjectsLocationsWorkflowsExecutionsCallbacksListOptions): Promise<ListCallbacksResponse>;

async projectsLocationsWorkflowsExecutionsCancel(name: string, req: CancelExecutionRequest): Promise<Execution>;

async projectsLocationsWorkflowsExecutionsCreate(parent: string, req: Execution): Promise<Execution>;

async projectsLocationsWorkflowsExecutionsExportData(name: string): Promise<ExportDataResponse>;

async projectsLocationsWorkflowsExecutionsGet(name: string, opts?: ProjectsLocationsWorkflowsExecutionsGetOptions): Promise<Execution>;

async projectsLocationsWorkflowsExecutionsList(parent: string, opts?: ProjectsLocationsWorkflowsExecutionsListOptions): Promise<ListExecutionsResponse>;

async projectsLocationsWorkflowsExecutionsStepEntriesGet(name: string): Promise<StepEntry>;

async projectsLocationsWorkflowsExecutionsStepEntriesList(parent: string, opts?: ProjectsLocationsWorkflowsExecutionsStepEntriesListOptions): Promise<ListStepEntriesResponse>;

async projectsLocationsWorkflowsTriggerPubsubExecution(workflow: string, req: TriggerPubsubExecutionRequest): Promise<Execution>;

}

§Constructors

new WorkflowExecutions(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsWorkflowsExecutionsCallbacksList(parent: string, opts?: ProjectsLocationsWorkflowsExecutionsCallbacksListOptions): Promise<ListCallbacksResponse>

[src]

Returns a list of active callbacks that belong to the execution with the given name. The returned callbacks are ordered by callback ID.

@param parent

Required. Name of the execution for which the callbacks should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

projectsLocationsWorkflowsExecutionsCancel(name: string, req: CancelExecutionRequest): Promise<Execution>

[src]

Cancels an execution of the given name.

@param name

Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

projectsLocationsWorkflowsExecutionsCreate(parent: string, req: Execution): Promise<Execution>

[src]

Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow.

@param parent

Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.

projectsLocationsWorkflowsExecutionsExportData(name: string): Promise<ExportDataResponse>

[src]

Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.

@param name

Required. Name of the execution for which data is to be exported. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

projectsLocationsWorkflowsExecutionsGet(name: string, opts?: ProjectsLocationsWorkflowsExecutionsGetOptions): Promise<Execution>

[src]

Returns an execution of the given name.

@param name

Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

projectsLocationsWorkflowsExecutionsList(parent: string, opts?: ProjectsLocationsWorkflowsExecutionsListOptions): Promise<ListExecutionsResponse>

[src]

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

@param parent

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

projectsLocationsWorkflowsExecutionsStepEntriesGet(name: string): Promise<StepEntry>

[src]

Gets a step entry.

@param name

Required. The name of the step entry to retrieve. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}

projectsLocationsWorkflowsExecutionsStepEntriesList(parent: string, opts?: ProjectsLocationsWorkflowsExecutionsStepEntriesListOptions): Promise<ListStepEntriesResponse>

[src]

Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.

@param parent

Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/

projectsLocationsWorkflowsTriggerPubsubExecution(workflow: string, req: TriggerPubsubExecutionRequest): Promise<Execution>

[src]

Triggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification.

@param workflow

Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow}