Dialogflow v3 API - Class IntentName (2.15.0)

Version 2.15.0

• 2.21.0 (latest)
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class IntentName : IResourceName, IEquatable<IntentName>

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

Resource name for the Intent resource.

Inheritance

object > IntentName

Implements

IResourceName, IEquatableIntentName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

IntentName(string, string, string, string)

public IntentName(string projectId, string locationId, string agentId, string intentId)

Constructs a new instance of a IntentName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/intents/{intent}

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.
intentId	string The Intent 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
Type	Description
string

IntentId

public string IntentId { get; }

The Intent 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 IntentName.ResourceNameType Type { get; }

The IntentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
IntentNameResourceNameType

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 intentId)

Formats the IDs into the string representation of this IntentName with pattern projects/{project}/locations/{location}/agents/{agent}/intents/{intent}.

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.
intentId	string The Intent ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this IntentName with pattern projects/{project}/locations/{location}/agents/{agent}/intents/{intent}.

FormatProjectLocationAgentIntent(string, string, string, string)

public static string FormatProjectLocationAgentIntent(string projectId, string locationId, string agentId, string intentId)

Formats the IDs into the string representation of this IntentName with pattern projects/{project}/locations/{location}/agents/{agent}/intents/{intent}.

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.
intentId	string The Intent ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this IntentName with pattern projects/{project}/locations/{location}/agents/{agent}/intents/{intent}.

FromProjectLocationAgentIntent(string, string, string, string)

public static IntentName FromProjectLocationAgentIntent(string projectId, string locationId, string agentId, string intentId)

Creates a IntentName with the pattern projects/{project}/locations/{location}/agents/{agent}/intents/{intent}.

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.
intentId	string The Intent ID. Must not be null or empty.

Returns
Type	Description
IntentName	A new instance of IntentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static IntentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a IntentName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
IntentName	A new instance of IntentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static IntentName Parse(string intentName)

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

Parameter
Name	Description
intentName	string The resource name in string form. Must not be null.

Returns
Type	Description
IntentName	The parsed IntentName if successful.

Remarks

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

• projects/{project}/locations/{location}/agents/{agent}/intents/{intent}

Parse(string, bool)

public static IntentName Parse(string intentName, bool allowUnparsed)

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

Parameters
Name	Description
intentName	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
IntentName	The parsed IntentName if successful.

Remarks

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

• projects/{project}/locations/{location}/agents/{agent}/intents/{intent}

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

object.ToString()

TryParse(string, out IntentName)

public static bool TryParse(string intentName, out IntentName result)

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

Parameters
Name	Description
intentName	string The resource name in string form. Must not be null.
result	IntentName When this method returns, the parsed IntentName, 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}/intents/{intent}

TryParse(string, bool, out IntentName)

public static bool TryParse(string intentName, bool allowUnparsed, out IntentName result)

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

Parameters
Name	Description
intentName	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	IntentName When this method returns, the parsed IntentName, 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}/intents/{intent}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(IntentName, IntentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	IntentName The first resource name to compare, or null.
b	IntentName 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 !=(IntentName, IntentName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	IntentName The first resource name to compare, or null.
b	IntentName 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.