Class FlowName

public sealed class FlowName : IResourceName, IEquatable<FlowName>

Resource name for the Flow resource.

Inheritance

Object > FlowName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

flowIdString

The Flow ID. Must not be null or empty.

Properties

AgentId

public string AgentId { get; }

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

Property Value
TypeDescription
String

FlowId

public string FlowId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

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

The FlowName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
FlowName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

flowIdString

The Flow ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this FlowName with pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

flowIdString

The Flow ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this FlowName with pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

flowIdString

The Flow ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
FlowName

A new instance of FlowName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static FlowName Parse(string flowName)

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

Parameter
NameDescription
flowNameString

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

Returns
TypeDescription
FlowName

The parsed FlowName if successful.

Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/flows/{flow}

Parse(String, Boolean)

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

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

allowUnparsedBoolean

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
FlowName

The parsed FlowName if successful.

Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/flows/{flow}
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 FlowName)

public static bool TryParse(string flowName, out FlowName result)

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

Parameters
NameDescription
flowNameString

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

resultFlowName

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

Returns
TypeDescription
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}/agents/{agent}/flows/{flow}

TryParse(String, Boolean, 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
NameDescription
flowNameString

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

allowUnparsedBoolean

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.

resultFlowName

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

Returns
TypeDescription
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}/agents/{agent}/flows/{flow}
Or may be in any format if allowUnparsed is true.

Operators

Equality(FlowName, FlowName)

public static bool operator ==(FlowName a, FlowName b)
Parameters
NameDescription
aFlowName
bFlowName
Returns
TypeDescription
Boolean

Inequality(FlowName, FlowName)

public static bool operator !=(FlowName a, FlowName b)
Parameters
NameDescription
aFlowName
bFlowName
Returns
TypeDescription
Boolean