Workflows

import { Workflows } from "https://googleapis.deno.dev/v1/workflows:v1.ts";

Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.

class Workflows {

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

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsWorkflowsCreate(

parent: string,

req: Workflow,

opts?: ProjectsLocationsWorkflowsCreateOptions,

): Promise<Operation>;

async projectsLocationsWorkflowsDelete(name: string): Promise<Operation>;

async projectsLocationsWorkflowsGet(name: string, opts?: ProjectsLocationsWorkflowsGetOptions): Promise<Workflow>;

async projectsLocationsWorkflowsList(parent: string, opts?: ProjectsLocationsWorkflowsListOptions): Promise<ListWorkflowsResponse>;

async projectsLocationsWorkflowsListRevisions(name: string, opts?: ProjectsLocationsWorkflowsListRevisionsOptions): Promise<ListWorkflowRevisionsResponse>;

async projectsLocationsWorkflowsPatch(

name: string,

req: Workflow,

opts?: ProjectsLocationsWorkflowsPatchOptions,

): Promise<Operation>;

}

§Constructors

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

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsWorkflowsCreate(parent: string, req: Workflow, opts?: ProjectsLocationsWorkflowsCreateOptions): Promise<Operation>

[src]

Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error.

@param parent

Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}

projectsLocationsWorkflowsDelete(name: string): Promise<Operation>

[src]

Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.

@param name

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

projectsLocationsWorkflowsGet(name: string, opts?: ProjectsLocationsWorkflowsGetOptions): Promise<Workflow>

[src]

Gets details of a single workflow.

@param name

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

projectsLocationsWorkflowsList(parent: string, opts?: ProjectsLocationsWorkflowsListOptions): Promise<ListWorkflowsResponse>

[src]

Lists workflows in a given project and location. The default order is not specified.

@param parent

Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}

projectsLocationsWorkflowsListRevisions(name: string, opts?: ProjectsLocationsWorkflowsListRevisionsOptions): Promise<ListWorkflowRevisionsResponse>

[src]

Lists revisions for a given workflow.

@param name

Required. Workflow for which the revisions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

projectsLocationsWorkflowsPatch(name: string, req: Workflow, opts?: ProjectsLocationsWorkflowsPatchOptions): Promise<Operation>

[src]

Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions.

@param name

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.