Workflow Executions v1 API - Class ExecutionName (2.6.0) 

public sealed class ExecutionName : IResourceName, IEquatable<ExecutionName>

Reference documentation and code samples for the Workflow Executions v1 API class ExecutionName.

Resource name for the Execution resource.

Inheritance

object > ExecutionName

Namespace

Google.Cloud.Workflows.Executions.V1

Assembly

Google.Cloud.Workflows.Executions.V1.dll

Constructors

ExecutionName(string, string, string, string)

public ExecutionName(string projectId, string locationId, string workflowId, string executionId)

Constructs a new instance of a ExecutionName class from the component parts of pattern projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
workflowId string

The Workflow ID. Must not be null or empty.
executionId string

The Execution ID. Must not be null or empty.

Properties

ExecutionId

public string ExecutionId { get; }

The Execution ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public ExecutionName.ResourceNameType Type { get; }

The ExecutionName.ResourceNameType of the contained resource name.

Property Value
Type Description
ExecutionNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

WorkflowId

public string WorkflowId { get; }

The Workflow ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string workflowId, string executionId)

Formats the IDs into the string representation of this ExecutionName with pattern projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
workflowId string

The Workflow ID. Must not be null or empty.
executionId string

The Execution ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ExecutionName with pattern projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}.

FormatProjectLocationWorkflowExecution(string, string, string, string)

public static string FormatProjectLocationWorkflowExecution(string projectId, string locationId, string workflowId, string executionId)

Formats the IDs into the string representation of this ExecutionName with pattern projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
workflowId string

The Workflow ID. Must not be null or empty.
executionId string

The Execution ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ExecutionName with pattern projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}.

FromProjectLocationWorkflowExecution(string, string, string, string)

public static ExecutionName FromProjectLocationWorkflowExecution(string projectId, string locationId, string workflowId, string executionId)

Creates a ExecutionName with the pattern projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
workflowId string

The Workflow ID. Must not be null or empty.
executionId string

The Execution ID. Must not be null or empty.
Returns
Type Description
ExecutionName

A new instance of ExecutionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ExecutionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExecutionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ExecutionName

A new instance of ExecutionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ExecutionName Parse(string executionName)

Parses the given resource name string into a new ExecutionName instance.

Parameter
Name Description
executionName string

The resource name in string form. Must not be null.
Returns
Type Description
ExecutionName

The parsed ExecutionName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Parse(string, bool)

public static ExecutionName Parse(string executionName, bool allowUnparsed)

Parses the given resource name string into a new ExecutionName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
executionName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
Returns
Type Description
ExecutionName

The parsed ExecutionName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out ExecutionName)

public static bool TryParse(string executionName, out ExecutionName result)

Tries to parse the given resource name string into a new ExecutionName instance.

Parameters
Name Description
executionName string

The resource name in string form. Must not be null.
result ExecutionName

When this method returns, the parsed ExecutionName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

TryParse(string, bool, out ExecutionName)

public static bool TryParse(string executionName, bool allowUnparsed, out ExecutionName result)

Tries to parse the given resource name string into a new ExecutionName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
executionName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result ExecutionName

When this method returns, the parsed ExecutionName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ExecutionName, ExecutionName)

public static bool operator ==(ExecutionName a, ExecutionName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ExecutionName

The first resource name to compare, or null.
b ExecutionName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ExecutionName, ExecutionName)

public static bool operator !=(ExecutionName a, ExecutionName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a ExecutionName

The first resource name to compare, or null.
b ExecutionName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.