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.
Namespace
GoogleCloudGoogle.Cloud.DialogflowGoogle.Cloud.Dialogflow.CxV3Assembly
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 |
locationId | string The |
agentId | string The |
intentId | 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 |
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 |
locationId | string The |
agentId | string The |
intentId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this IntentName with pattern
|
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 |
locationId | string The |
agentId | string The |
intentId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this IntentName with pattern
|
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 |
locationId | string The |
agentId | string The |
intentId | string The |
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 |
Returns | |
---|---|
Type | Description |
IntentName | A new instance of IntentName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
IntentName | The parsed IntentName if successful. |
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 |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
IntentName | The parsed IntentName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/agents/{agent}/intents/{intent}
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 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 |
result | IntentName When this method returns, the parsed IntentName, 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}/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 |
allowUnparsed | bool If |
result | IntentName When this method returns, the parsed IntentName, 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}/intents/{intent}
allowUnparsed
is true
.
Operators
operator ==(IntentName, IntentName)
public static bool operator ==(IntentName a, IntentName b)
Parameters | |
---|---|
Name | Description |
a | IntentName |
b | IntentName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(IntentName, IntentName)
public static bool operator !=(IntentName a, IntentName b)
Parameters | |
---|---|
Name | Description |
a | IntentName |
b | IntentName |
Returns | |
---|---|
Type | Description |
bool |