Class AgentName (1.0.0)

public sealed class AgentName : IResourceName, IEquatable<AgentName>

Resource name for the Agent resource.

Inheritance

System.Object > AgentName

Implements

Google.Api.Gax.IResourceName, System.IEquatable<AgentName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

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`	`System.String` The `Project` ID. Must not be `null` or empty.
`locationId`	`System.String` The `Location` ID. Must not be `null` or empty.
`agentId`	`System.String` The `Agent` 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
`System.String`

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`System.Boolean`

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`System.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
`System.String`

Type

public AgentName.ResourceNameType Type { get; }

The AgentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AgentName.ResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained Google.Api.Gax.UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`Google.Api.Gax.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`	`System.String` The `Project` ID. Must not be `null` or empty.
`locationId`	`System.String` The `Location` ID. Must not be `null` or empty.
`agentId`	`System.String` The `Agent` ID. Must not be `null` or empty.

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

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`	`System.String` The `Project` ID. Must not be `null` or empty.
`locationId`	`System.String` The `Location` ID. Must not be `null` or empty.
`agentId`	`System.String` The `Agent` ID. Must not be `null` or empty.

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

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`	`System.String` The `Project` ID. Must not be `null` or empty.
`locationId`	`System.String` The `Location` ID. Must not be `null` or empty.
`agentId`	`System.String` The `Agent` 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`	`Google.Api.Gax.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
`System.Int32`

Overrides

System.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`	`System.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}/locations/{location}/agents/{agent}

Parse(String, Boolean)

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`	`System.String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`System.Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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}/locations/{location}/agents/{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
`System.String`	The string representation of the resource name.

Overrides

System.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`	`System.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
`System.Boolean`	`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}

TryParse(String, Boolean, 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`	`System.String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`System.Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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
`System.Boolean`	`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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(AgentName, AgentName)

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

Parameters
Name	Description
`a`	`AgentName`
`b`	`AgentName`

Returns
Type	Description
`System.Boolean`

Inequality(AgentName, AgentName)

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

Parameters
Name	Description
`a`	`AgentName`
`b`	`AgentName`

Returns
Type	Description
`System.Boolean`