public sealed class FlowName : IResourceName, IEquatable<FlowName>
Reference documentation and code samples for the Dialogflow v3 API class FlowName.
Resource name for the Flow
resource.
Namespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
FlowName(string, string, string, string)
public FlowName(string projectId, string locationId, string agentId, string flowId)
Constructs a new instance of a FlowName class from the component parts of pattern
projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
agentId |
string The |
flowId |
string The |
Properties
AgentId
public string AgentId { get; }
The Agent
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
FlowId
public string FlowId { get; }
The Flow
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 FlowName.ResourceNameType Type { get; }
The FlowName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
FlowNameResourceNameType |
UnparsedResource
public UnparsedResourceName UnparsedResource { get; }
The contained UnparsedResourceName. Only non-null
if this instance contains an
unparsed resource name.
Property Value | |
---|---|
Type | Description |
UnparsedResourceName |
Methods
Format(string, string, string, string)
public static string Format(string projectId, string locationId, string agentId, string flowId)
Formats the IDs into the string representation of this FlowName with pattern
projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
agentId |
string The |
flowId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this FlowName with pattern
|
FormatProjectLocationAgentFlow(string, string, string, string)
public static string FormatProjectLocationAgentFlow(string projectId, string locationId, string agentId, string flowId)
Formats the IDs into the string representation of this FlowName with pattern
projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
agentId |
string The |
flowId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this FlowName with pattern
|
FromProjectLocationAgentFlow(string, string, string, string)
public static FlowName FromProjectLocationAgentFlow(string projectId, string locationId, string agentId, string flowId)
Creates a FlowName with the pattern
projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
agentId |
string The |
flowId |
string The |
Returns | |
---|---|
Type | Description |
FlowName |
A new instance of FlowName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static FlowName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a FlowName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
FlowName |
A new instance of FlowName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static FlowName Parse(string flowName)
Parses the given resource name string into a new FlowName instance.
Parameter | |
---|---|
Name | Description |
flowName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
FlowName |
The parsed FlowName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
Parse(string, bool)
public static FlowName Parse(string flowName, bool allowUnparsed)
Parses the given resource name string into a new FlowName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
flowName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
FlowName |
The parsed FlowName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
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 FlowName)
public static bool TryParse(string flowName, out FlowName result)
Tries to parse the given resource name string into a new FlowName instance.
Parameters | |
---|---|
Name | Description |
flowName |
string The resource name in string form. Must not be |
result |
FlowName When this method returns, the parsed FlowName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
TryParse(string, bool, out FlowName)
public static bool TryParse(string flowName, bool allowUnparsed, out FlowName result)
Tries to parse the given resource name string into a new FlowName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
flowName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
FlowName When this method returns, the parsed FlowName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
allowUnparsed
is true
.
Operators
operator ==(FlowName, FlowName)
public static bool operator ==(FlowName a, FlowName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
FlowName The first resource name to compare, or null. |
b |
FlowName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(FlowName, FlowName)
public static bool operator !=(FlowName a, FlowName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
FlowName The first resource name to compare, or null. |
b |
FlowName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |