Class WorkflowName (2.0.0)

public sealed class WorkflowName : IResourceName, IEquatable<WorkflowName>

Resource name for the Workflow resource.

Inheritance

Object > WorkflowName

Implements

IResourceName, IEquatable<WorkflowName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Workflows.Common.V1

Assembly

Google.Cloud.Workflows.Common.V1.dll

Constructors

WorkflowName(String, String, String)

public WorkflowName(string projectId, string locationId, string workflowId)

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

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.

Properties

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 WorkflowName.ResourceNameType Type { get; }

The WorkflowName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`WorkflowName.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)

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

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

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.

Returns
Type	Description
`String`	The string representation of this WorkflowName with pattern `projects/{project}/locations/{location}/workflows/{workflow}`.

FormatProjectLocationWorkflow(String, String, String)

public static string FormatProjectLocationWorkflow(string projectId, string locationId, string workflowId)

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

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.

Returns
Type	Description
`String`	The string representation of this WorkflowName with pattern `projects/{project}/locations/{location}/workflows/{workflow}`.

FromProjectLocationWorkflow(String, String, String)

public static WorkflowName FromProjectLocationWorkflow(string projectId, string locationId, string workflowId)

Creates a WorkflowName with the pattern projects/{project}/locations/{location}/workflows/{workflow}.

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.

Returns
Type	Description
`WorkflowName`	A new instance of WorkflowName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WorkflowName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WorkflowName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`WorkflowName`	A new instance of WorkflowName 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 WorkflowName Parse(string workflowName)

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

Parameter
Name	Description
`workflowName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`WorkflowName`	The parsed WorkflowName if successful.

Remarks

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

projects/{project}/locations/{location}/workflows/{workflow}

Parse(String, Boolean)

public static WorkflowName Parse(string workflowName, bool allowUnparsed)

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

Parameters
Name	Description
`workflowName`	`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
`WorkflowName`	The parsed WorkflowName if successful.

Remarks

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

projects/{project}/locations/{location}/workflows/{workflow}

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 WorkflowName)

public static bool TryParse(string workflowName, out WorkflowName result)

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

Parameters
Name	Description
`workflowName`	`String` The resource name in string form. Must not be `null`.
`result`	`WorkflowName` When this method returns, the parsed WorkflowName, 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}

TryParse(String, Boolean, out WorkflowName)

public static bool TryParse(string workflowName, bool allowUnparsed, out WorkflowName result)

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

Parameters
Name	Description
`workflowName`	`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`	`WorkflowName` When this method returns, the parsed WorkflowName, 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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(WorkflowName, WorkflowName)

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

Parameters
Name	Description
`a`	`WorkflowName`
`b`	`WorkflowName`

Returns
Type	Description
`Boolean`

Inequality(WorkflowName, WorkflowName)

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

Parameters
Name	Description
`a`	`WorkflowName`
`b`	`WorkflowName`

Returns
Type	Description
`Boolean`