Google Cloud Dialogflow v2 API - Class IntentName (4.25.0) 

public sealed class IntentName : IResourceName, IEquatable<IntentName>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class IntentName.

Resource name for the Intent resource.

Inheritance

object > IntentName

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

IntentName(string, string)

public IntentName(string projectId, string intentId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
intentId string

The Intent ID. Must not be null or empty.

Properties

IntentId

public string IntentId { get; }

The Intent 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

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)

public static string Format(string projectId, string intentId)

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

Parameters
Name Description
projectId string

The Project 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}/agent/intents/{intent}.

FormatProjectIntent(string, string)

public static string FormatProjectIntent(string projectId, string intentId)

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

Parameters
Name Description
projectId string

The Project 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}/agent/intents/{intent}.

FormatProjectLocationIntent(string, string, string)

public static string FormatProjectLocationIntent(string projectId, string locationId, string intentId)

Formats the IDs into the string representation of this IntentName with pattern projects/{project}/locations/{location}/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.
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}/agent/intents/{intent}.

FromProjectIntent(string, string)

public static IntentName FromProjectIntent(string projectId, string intentId)

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

Parameters
Name Description
projectId string

The Project 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.

FromProjectLocationIntent(string, string, string)

public static IntentName FromProjectLocationIntent(string projectId, string locationId, string intentId)

Creates a IntentName with the pattern projects/{project}/locations/{location}/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.
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

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}/agent/intents/{intent}
  • projects/{project}/locations/{location}/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}/agent/intents/{intent}
  • projects/{project}/locations/{location}/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

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}/agent/intents/{intent}
  • projects/{project}/locations/{location}/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}/agent/intents/{intent}
  • projects/{project}/locations/{location}/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.