Class AgentName (4.0.0)

public sealed class AgentName : IResourceName, IEquatable<AgentName>

Resource name for the Agent resource.

Inheritance

Object > AgentName

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
NameDescription
projectIdString

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
TypeDescription
Boolean

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

Type

public AgentName.ResourceNameType Type { get; }

The AgentName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AgentName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AgentName

A new instance of AgentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static AgentName Parse(string agentName)

Parses the given resource name string into a new AgentName instance.

Parameter
NameDescription
agentNameString

The resource name in string form. Must not be null.

Returns
TypeDescription
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, 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
NameDescription
agentNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
agentNameString

The resource name in string form. Must not be null.

resultAgentName

When this method returns, the parsed AgentName, or null if parsing failed.

Returns
TypeDescription
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}/agent
  • projects/{project}/locations/{location}/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
NameDescription
agentNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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.

resultAgentName

When this method returns, the parsed AgentName, or null if parsing failed.

Returns
TypeDescription
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}/agent
  • projects/{project}/locations/{location}/agent
Or may be in any format if allowUnparsed is true.

Operators

Equality(AgentName, AgentName)

public static bool operator ==(AgentName a, AgentName b)
Parameters
NameDescription
aAgentName
bAgentName
Returns
TypeDescription
Boolean

Inequality(AgentName, AgentName)

public static bool operator !=(AgentName a, AgentName b)
Parameters
NameDescription
aAgentName
bAgentName
Returns
TypeDescription
Boolean