Google.Cloud.Workflows.Common.V1 - Class WorkflowName (2.1.0)

public sealed class WorkflowName : IResourceName, IEquatable<WorkflowName>

Reference documentation and code samples for the Google.Cloud.Workflows.Common.V1 class WorkflowName.

Resource name for the Workflow resource.

Inheritance

object > WorkflowName

Namespace

GoogleGoogle.CloudGoogle.Cloud.WorkflowsGoogle.Cloud.Workflows.CommonV1

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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

workflowIdstring

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
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public WorkflowName.ResourceNameType Type { get; }

The WorkflowName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
WorkflowNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

WorkflowId

public string WorkflowId { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

workflowIdstring

The Workflow ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

workflowIdstring

The Workflow ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

workflowIdstring

The Workflow ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
WorkflowName

A new instance of WorkflowName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static WorkflowName Parse(string workflowName)

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

Parameter
NameDescription
workflowNamestring

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

Returns
TypeDescription
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, bool)

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
NameDescription
workflowNamestring

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

allowUnparsedbool

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

The string representation of the resource name.

Overrides

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
NameDescription
workflowNamestring

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

resultWorkflowName

When this method returns, the parsed WorkflowName, or null if parsing failed.

Returns
TypeDescription
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}

TryParse(string, bool, 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
NameDescription
workflowNamestring

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

allowUnparsedbool

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.

resultWorkflowName

When this method returns, the parsed WorkflowName, or null if parsing failed.

Returns
TypeDescription
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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(WorkflowName, WorkflowName)

public static bool operator ==(WorkflowName a, WorkflowName b)
Parameters
NameDescription
aWorkflowName
bWorkflowName
Returns
TypeDescription
bool

operator !=(WorkflowName, WorkflowName)

public static bool operator !=(WorkflowName a, WorkflowName b)
Parameters
NameDescription
aWorkflowName
bWorkflowName
Returns
TypeDescription
bool