Class ExecutionName (1.0.0)

public sealed class ExecutionName : IResourceName, IEquatable<ExecutionName>

Resource name for the Execution resource.

Inheritance

Object > ExecutionName

Implements

IResourceName, IEquatable<ExecutionName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`ExecutionName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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, Boolean)

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`	`Boolean` 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

Object.ToString()

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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(ExecutionName, ExecutionName)

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

Parameters
Name	Description
`a`	`ExecutionName`
`b`	`ExecutionName`

Returns
Type	Description
`Boolean`

Inequality(ExecutionName, ExecutionName)

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

Parameters
Name	Description
`a`	`ExecutionName`
`b`	`ExecutionName`

Returns
Type	Description
`Boolean`