Gemini Enterprise for Customer Experience v1 API - Class DialogflowAgentName (1.0.0-beta01) 

public sealed class DialogflowAgentName : IResourceName, IEquatable<DialogflowAgentName>

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class DialogflowAgentName.

Resource name for the DialogflowAgent resource.

Inheritance

object > DialogflowAgentName

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Constructors

DialogflowAgentName(string, string, string)

public DialogflowAgentName(string projectId, string locationId, string agentId)

Constructs a new instance of a DialogflowAgentName class from the component parts of pattern projects/{project}/locations/{location}/agents/{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.
agentId 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
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 DialogflowAgentName.ResourceNameType Type { get; }

The DialogflowAgentName.ResourceNameType of the contained resource name.

Property Value
Type Description
DialogflowAgentNameResourceNameType

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 DialogflowAgentName with pattern projects/{project}/locations/{location}/agents/{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.
agentId string

The Agent ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DialogflowAgentName 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 DialogflowAgentName with pattern projects/{project}/locations/{location}/agents/{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.
agentId string

The Agent ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DialogflowAgentName with pattern projects/{project}/locations/{location}/agents/{agent}.

FromProjectLocationAgent(string, string, string)

public static DialogflowAgentName FromProjectLocationAgent(string projectId, string locationId, string agentId)

Creates a DialogflowAgentName with the pattern projects/{project}/locations/{location}/agents/{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.
agentId string

The Agent ID. Must not be null or empty.
Returns
Type Description
DialogflowAgentName

A new instance of DialogflowAgentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DialogflowAgentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DialogflowAgentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DialogflowAgentName

A new instance of DialogflowAgentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static DialogflowAgentName Parse(string dialogflowAgentName)

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

Parameter
Name Description
dialogflowAgentName string

The resource name in string form. Must not be null.
Returns
Type Description
DialogflowAgentName

The parsed DialogflowAgentName 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, bool)

public static DialogflowAgentName Parse(string dialogflowAgentName, bool allowUnparsed)

Parses the given resource name string into a new DialogflowAgentName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
dialogflowAgentName 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
DialogflowAgentName

The parsed DialogflowAgentName 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
string

The string representation of the resource name.
Overrides

TryParse(string, out DialogflowAgentName)

public static bool TryParse(string dialogflowAgentName, out DialogflowAgentName result)

Tries to parse the given resource name string into a new DialogflowAgentName instance.

Parameters
Name Description
dialogflowAgentName string

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

When this method returns, the parsed DialogflowAgentName, 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}/locations/{location}/agents/{agent}

TryParse(string, bool, out DialogflowAgentName)

public static bool TryParse(string dialogflowAgentName, bool allowUnparsed, out DialogflowAgentName result)

Tries to parse the given resource name string into a new DialogflowAgentName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
dialogflowAgentName 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 DialogflowAgentName

When this method returns, the parsed DialogflowAgentName, 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}/locations/{location}/agents/{agent}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DialogflowAgentName, DialogflowAgentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DialogflowAgentName

The first resource name to compare, or null.
b DialogflowAgentName

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 !=(DialogflowAgentName, DialogflowAgentName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DialogflowAgentName

The first resource name to compare, or null.
b DialogflowAgentName

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.