Dialogflow v3 API - Class TransitionRouteGroupName (2.20.0)

public sealed class TransitionRouteGroupName : IResourceName, IEquatable<TransitionRouteGroupName>

Reference documentation and code samples for the Dialogflow v3 API class TransitionRouteGroupName.

Resource name for the TransitionRouteGroup resource.

Inheritance

object > TransitionRouteGroupName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

TransitionRouteGroupName(string, string, string, string, string)

public TransitionRouteGroupName(string projectId, string locationId, string agentId, string flowId, string transitionRouteGroupId)

Constructs a new instance of a TransitionRouteGroupName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/transitionRouteGroups/{transition_route_group}

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.

agentId string

The Agent ID. Must not be null or empty.

flowId string

The Flow ID. Must not be null or empty.

transitionRouteGroupId string

The TransitionRouteGroup ID. Must not be null or empty.

Properties

AgentId

public string AgentId { get; }

The Agent ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

FlowId

public string FlowId { get; }

The Flow ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

TransitionRouteGroupId

public string TransitionRouteGroupId { get; }

The TransitionRouteGroup ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public TransitionRouteGroupName.ResourceNameType Type { get; }

The TransitionRouteGroupName.ResourceNameType of the contained resource name.

Property Value
Type Description
TransitionRouteGroupNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string agentId, string flowId, string transitionRouteGroupId)

Formats the IDs into the string representation of this TransitionRouteGroupName with pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/transitionRouteGroups/{transition_route_group} .

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.

agentId string

The Agent ID. Must not be null or empty.

flowId string

The Flow ID. Must not be null or empty.

transitionRouteGroupId string

The TransitionRouteGroup ID. Must not be null or empty.

Returns
Type Description
string

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

FormatProjectLocationAgentFlowTransitionRouteGroup(string, string, string, string, string)

public static string FormatProjectLocationAgentFlowTransitionRouteGroup(string projectId, string locationId, string agentId, string flowId, string transitionRouteGroupId)

Formats the IDs into the string representation of this TransitionRouteGroupName with pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/transitionRouteGroups/{transition_route_group} .

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.

agentId string

The Agent ID. Must not be null or empty.

flowId string

The Flow ID. Must not be null or empty.

transitionRouteGroupId string

The TransitionRouteGroup ID. Must not be null or empty.

Returns
Type Description
string

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

FormatProjectLocationAgentTransitionRouteGroup(string, string, string, string)

public static string FormatProjectLocationAgentTransitionRouteGroup(string projectId, string locationId, string agentId, string transitionRouteGroupId)

Formats the IDs into the string representation of this TransitionRouteGroupName with pattern projects/{project}/locations/{location}/agents/{agent}/transitionRouteGroups/{transition_route_group} .

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.

agentId string

The Agent ID. Must not be null or empty.

transitionRouteGroupId string

The TransitionRouteGroup ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TransitionRouteGroupName with pattern projects/{project}/locations/{location}/agents/{agent}/transitionRouteGroups/{transition_route_group} .

FromProjectLocationAgentFlowTransitionRouteGroup(string, string, string, string, string)

public static TransitionRouteGroupName FromProjectLocationAgentFlowTransitionRouteGroup(string projectId, string locationId, string agentId, string flowId, string transitionRouteGroupId)

Creates a TransitionRouteGroupName with the pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/transitionRouteGroups/{transition_route_group} .

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.

agentId string

The Agent ID. Must not be null or empty.

flowId string

The Flow ID. Must not be null or empty.

transitionRouteGroupId string

The TransitionRouteGroup ID. Must not be null or empty.

Returns
Type Description
TransitionRouteGroupName

A new instance of TransitionRouteGroupName constructed from the provided ids.

FromProjectLocationAgentTransitionRouteGroup(string, string, string, string)

public static TransitionRouteGroupName FromProjectLocationAgentTransitionRouteGroup(string projectId, string locationId, string agentId, string transitionRouteGroupId)

Creates a TransitionRouteGroupName with the pattern projects/{project}/locations/{location}/agents/{agent}/transitionRouteGroups/{transition_route_group} .

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.

agentId string

The Agent ID. Must not be null or empty.

transitionRouteGroupId string

The TransitionRouteGroup ID. Must not be null or empty.

Returns
Type Description
TransitionRouteGroupName

A new instance of TransitionRouteGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TransitionRouteGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TransitionRouteGroupName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
TransitionRouteGroupName

A new instance of TransitionRouteGroupName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static TransitionRouteGroupName Parse(string transitionRouteGroupName)

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

Parameter
Name Description
transitionRouteGroupName string

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

Returns
Type Description
TransitionRouteGroupName

The parsed TransitionRouteGroupName 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}/transitionRouteGroups/{transition_route_group}
  • projects/{project}/locations/{location}/agents/{agent}/transitionRouteGroups/{transition_route_group}

Parse(string, bool)

public static TransitionRouteGroupName Parse(string transitionRouteGroupName, bool allowUnparsed)

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

Parameters
Name Description
transitionRouteGroupName string

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

allowUnparsed bool

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
TransitionRouteGroupName

The parsed TransitionRouteGroupName 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}/transitionRouteGroups/{transition_route_group}
  • projects/{project}/locations/{location}/agents/{agent}/transitionRouteGroups/{transition_route_group}
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

TryParse(string, out TransitionRouteGroupName)

public static bool TryParse(string transitionRouteGroupName, out TransitionRouteGroupName result)

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

Parameters
Name Description
transitionRouteGroupName string

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

result TransitionRouteGroupName

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

Returns
Type Description
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}/agents/{agent}/flows/{flow}/transitionRouteGroups/{transition_route_group}
  • projects/{project}/locations/{location}/agents/{agent}/transitionRouteGroups/{transition_route_group}

TryParse(string, bool, out TransitionRouteGroupName)

public static bool TryParse(string transitionRouteGroupName, bool allowUnparsed, out TransitionRouteGroupName result)

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

Parameters
Name Description
transitionRouteGroupName string

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

allowUnparsed bool

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 TransitionRouteGroupName

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

Returns
Type Description
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}/agents/{agent}/flows/{flow}/transitionRouteGroups/{transition_route_group}
  • projects/{project}/locations/{location}/agents/{agent}/transitionRouteGroups/{transition_route_group}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TransitionRouteGroupName, TransitionRouteGroupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TransitionRouteGroupName

The first resource name to compare, or null.

b TransitionRouteGroupName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(TransitionRouteGroupName, TransitionRouteGroupName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TransitionRouteGroupName

The first resource name to compare, or null.

b TransitionRouteGroupName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.