Class ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource
The "executions" collection of methods.
Inherited Members
Namespace: Google.Apis.WorkflowExecutions.v1
Assembly: Google.Apis.WorkflowExecutions.v1.dll
Syntax
public class ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource
Constructors
ExecutionsResource(IClientService)
Constructs a new resource.
Declaration
public ExecutionsResource(IClientService service)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Properties
Callbacks
Gets the Callbacks resource.
Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.CallbacksResource Callbacks { get; }
Property Value
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.CallbacksResource |
StepEntries
Gets the StepEntries resource.
Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.StepEntriesResource StepEntries { get; }
Property Value
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.StepEntriesResource |
Methods
Cancel(CancelExecutionRequest, string)
Cancels an execution of the given name.
Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.CancelRequest Cancel(CancelExecutionRequest body, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| CancelExecutionRequest | body | The body of the request. |
| string | name | Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.CancelRequest |
Create(Execution, string)
Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow.
Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.CreateRequest Create(Execution body, string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| Execution | body | The body of the request. |
| string | 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. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.CreateRequest |
DeleteExecutionHistory(DeleteExecutionHistoryRequest, string)
Deletes all step entries for an execution.
Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.DeleteExecutionHistoryRequest DeleteExecutionHistory(DeleteExecutionHistoryRequest body, string name)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteExecutionHistoryRequest | body | The body of the request. |
| string | name | Required. Name of the execution for which step entries should be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.DeleteExecutionHistoryRequest |
ExportData(string)
Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.
Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.ExportDataRequest ExportData(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. Name of the execution for which data is to be exported. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.ExportDataRequest |
Get(string)
Returns an execution of the given name.
Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.GetRequest Get(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.GetRequest |
List(string)
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).
Declaration
public virtual ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.ListRequest List(string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow} |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.WorkflowsResource.ExecutionsResource.ListRequest |