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.
Namespace
Google.Cloud.Workflows.Common.V1Assembly
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 |
locationId | string The |
workflowId | string The |
Properties
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 WorkflowName.ResourceNameType Type { get; }
The WorkflowName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
WorkflowNameResourceNameType |
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 |
locationId | string The |
workflowId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this WorkflowName with pattern
|
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 |
locationId | string The |
workflowId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this WorkflowName with pattern
|
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 |
locationId | string The |
workflowId | string The |
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 |
Returns | |
---|---|
Type | Description |
WorkflowName | A new instance of WorkflowName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
WorkflowName | The parsed WorkflowName if successful. |
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 | |
---|---|
Name | Description |
workflowName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
WorkflowName | The parsed WorkflowName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/workflows/{workflow}
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. |
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 |
result | WorkflowName When this method returns, the parsed WorkflowName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 | |
---|---|
Name | Description |
workflowName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | WorkflowName When this method returns, the parsed WorkflowName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/workflows/{workflow}
allowUnparsed
is true
.
Operators
operator ==(WorkflowName, WorkflowName)
public static bool operator ==(WorkflowName a, WorkflowName b)
Parameters | |
---|---|
Name | Description |
a | WorkflowName |
b | WorkflowName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(WorkflowName, WorkflowName)
public static bool operator !=(WorkflowName a, WorkflowName b)
Parameters | |
---|---|
Name | Description |
a | WorkflowName |
b | WorkflowName |
Returns | |
---|---|
Type | Description |
bool |