public sealed class AgentName : IResourceName, IEquatable<AgentName>
Reference documentation and code samples for the Dialogflow v3 API class AgentName.
Resource name for the Agent
resource.
Namespace
GoogleCloudGoogle.Cloud.DialogflowGoogle.Cloud.Dialogflow.CxV3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
AgentName(string, string, string)
public AgentName(string projectId, string locationId, string agentId)
Constructs a new instance of a AgentName class from the component parts of pattern
projects/{project}/locations/{location}/agents/{agent}
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
agentId | 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 |
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 AgentName.ResourceNameType Type { get; }
The AgentName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
AgentNameResourceNameType |
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)
public static string Format(string projectId, string locationId, string agentId)
Formats the IDs into the string representation of this AgentName with pattern
projects/{project}/locations/{location}/agents/{agent}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
agentId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this AgentName with pattern
|
FormatProjectLocationAgent(string, string, string)
public static string FormatProjectLocationAgent(string projectId, string locationId, string agentId)
Formats the IDs into the string representation of this AgentName with pattern
projects/{project}/locations/{location}/agents/{agent}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
agentId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this AgentName with pattern
|
FromProjectLocationAgent(string, string, string)
public static AgentName FromProjectLocationAgent(string projectId, string locationId, string agentId)
Creates a AgentName with the pattern projects/{project}/locations/{location}/agents/{agent}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
agentId | string The |
Returns | |
---|---|
Type | Description |
AgentName | A new instance of AgentName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static AgentName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a AgentName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
AgentName | A new instance of AgentName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static AgentName Parse(string agentName)
Parses the given resource name string into a new AgentName instance.
Parameter | |
---|---|
Name | Description |
agentName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
AgentName | The parsed AgentName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/agents/{agent}
Parse(string, bool)
public static AgentName Parse(string agentName, bool allowUnparsed)
Parses the given resource name string into a new AgentName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
agentName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
AgentName | The parsed AgentName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/agents/{agent}
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 AgentName)
public static bool TryParse(string agentName, out AgentName result)
Tries to parse the given resource name string into a new AgentName instance.
Parameters | |
---|---|
Name | Description |
agentName | string The resource name in string form. Must not be |
result | AgentName When this method returns, the parsed AgentName, 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}
TryParse(string, bool, out AgentName)
public static bool TryParse(string agentName, bool allowUnparsed, out AgentName result)
Tries to parse the given resource name string into a new AgentName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
agentName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | AgentName When this method returns, the parsed AgentName, 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}
allowUnparsed
is true
.
Operators
operator ==(AgentName, AgentName)
public static bool operator ==(AgentName a, AgentName b)
Parameters | |
---|---|
Name | Description |
a | AgentName |
b | AgentName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(AgentName, AgentName)
public static bool operator !=(AgentName a, AgentName b)
Parameters | |
---|---|
Name | Description |
a | AgentName |
b | AgentName |
Returns | |
---|---|
Type | Description |
bool |