Google Cloud Dialogflow v2 API - Class AgentName (4.23.0)

public sealed class AgentName : IResourceName, IEquatable<AgentName>

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

Resource name for the Agent resource.

Inheritance

object > AgentName

Implements

IResourceName, IEquatable AgentName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

AgentName(string)

public AgentName(string projectId)

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

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Properties

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

public static string Format(string projectId)

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

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AgentName with pattern `projects/{project}/agent`.

FormatProject(string)

public static string FormatProject(string projectId)

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

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AgentName with pattern `projects/{project}/agent`.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this AgentName with pattern projects/{project}/locations/{location}/agent.

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.

Returns
Type	Description
`string`	The string representation of this AgentName with pattern `projects/{project}/locations/{location}/agent`.

FromProject(string)

public static AgentName FromProject(string projectId)

Creates a AgentName with the pattern projects/{project}/agent.

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

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

FromProjectLocation(string, string)

public static AgentName FromProjectLocation(string projectId, string locationId)

Creates a AgentName with the pattern projects/{project}/locations/{location}/agent.

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.

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 `null`.

Returns
Type	Description
`AgentName`	A new instance of AgentName 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 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 `null`.

Returns
Type	Description
`AgentName`	The parsed AgentName if successful.

Remarks

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

projects/{project}/agent
projects/{project}/locations/{location}/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 `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
`AgentName`	The parsed AgentName if successful.

Remarks

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

projects/{project}/agent
projects/{project}/locations/{location}/agent

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 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 `null`.
`result`	`AgentName` When this method returns, the parsed AgentName, 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
projects/{project}/locations/{location}/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 `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`	`AgentName` When this method returns, the parsed AgentName, 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
projects/{project}/locations/{location}/agent

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AgentName, AgentName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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