Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.WorkflowsResource

The "workflows" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.WorkflowsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Workflows.v1
Assembly: Google.Apis.Workflows.v1.dll
Syntax
public class ProjectsResource.LocationsResource.WorkflowsResource

Constructors

WorkflowsResource(IClientService)

Constructs a new resource.

Declaration
public WorkflowsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(Workflow, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.CreateRequest Create(Workflow body, string parent)
Parameters
Type Name Description
Workflow body

The body of the request.

string parent

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

Returns
Type Description
ProjectsResource.LocationsResource.WorkflowsResource.CreateRequest

Delete(string)

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

Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.LocationsResource.WorkflowsResource.DeleteRequest

Get(string)

Gets details of a single workflow.

Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.LocationsResource.WorkflowsResource.GetRequest

List(string)

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

Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

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

Returns
Type Description
ProjectsResource.LocationsResource.WorkflowsResource.ListRequest

ListRevisions(string)

Lists revisions for a given workflow.

Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ListRevisionsRequest ListRevisions(string name)
Parameters
Type Name Description
string name

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

Returns
Type Description
ProjectsResource.LocationsResource.WorkflowsResource.ListRevisionsRequest

Patch(Workflow, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.PatchRequest Patch(Workflow body, string name)
Parameters
Type Name Description
Workflow body

The body of the request.

string 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.

Returns
Type Description
ProjectsResource.LocationsResource.WorkflowsResource.PatchRequest
In this article
Back to top Generated by DocFX