Dialogflow v3 API - Class ToolVersionName (3.0.0) 

public sealed class ToolVersionName : IResourceName, IEquatable<ToolVersionName>

Reference documentation and code samples for the Dialogflow v3 API class ToolVersionName.

Resource name for the ToolVersion resource.

Inheritance

object > ToolVersionName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

ToolVersionName(string, string, string, string, string)

public ToolVersionName(string projectId, string locationId, string agentId, string toolId, string versionId)

Constructs a new instance of a ToolVersionName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/tools/{tool}/versions/{version}

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.
toolId string

The Tool ID. Must not be null or empty.
versionId string

The Version 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

ToolId

public string ToolId { get; }

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

Property Value
Type Description
string

Type

public ToolVersionName.ResourceNameType Type { get; }

The ToolVersionName.ResourceNameType of the contained resource name.

Property Value
Type Description
ToolVersionNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

VersionId

public string VersionId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string agentId, string toolId, string versionId)

Formats the IDs into the string representation of this ToolVersionName with pattern projects/{project}/locations/{location}/agents/{agent}/tools/{tool}/versions/{version}.

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.
toolId string

The Tool ID. Must not be null or empty.
versionId string

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

The string representation of this ToolVersionName with pattern projects/{project}/locations/{location}/agents/{agent}/tools/{tool}/versions/{version}.

FormatProjectLocationAgentToolVersion(string, string, string, string, string)

public static string FormatProjectLocationAgentToolVersion(string projectId, string locationId, string agentId, string toolId, string versionId)

Formats the IDs into the string representation of this ToolVersionName with pattern projects/{project}/locations/{location}/agents/{agent}/tools/{tool}/versions/{version}.

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.
toolId string

The Tool ID. Must not be null or empty.
versionId string

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

The string representation of this ToolVersionName with pattern projects/{project}/locations/{location}/agents/{agent}/tools/{tool}/versions/{version}.

FromProjectLocationAgentToolVersion(string, string, string, string, string)

public static ToolVersionName FromProjectLocationAgentToolVersion(string projectId, string locationId, string agentId, string toolId, string versionId)

Creates a ToolVersionName with the pattern projects/{project}/locations/{location}/agents/{agent}/tools/{tool}/versions/{version}.

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.
toolId string

The Tool ID. Must not be null or empty.
versionId string

The Version ID. Must not be null or empty.
Returns
Type Description
ToolVersionName

A new instance of ToolVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ToolVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ToolVersionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ToolVersionName 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 ToolVersionName Parse(string toolVersionName)

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

Parameter
Name Description
toolVersionName string

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

The parsed ToolVersionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/tools/{tool}/versions/{version}

Parse(string, bool)

public static ToolVersionName Parse(string toolVersionName, bool allowUnparsed)

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

Parameters
Name Description
toolVersionName 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
ToolVersionName

The parsed ToolVersionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/tools/{tool}/versions/{version}
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 ToolVersionName)

public static bool TryParse(string toolVersionName, out ToolVersionName result)

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

Parameters
Name Description
toolVersionName string

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

When this method returns, the parsed ToolVersionName, 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}/tools/{tool}/versions/{version}

TryParse(string, bool, out ToolVersionName)

public static bool TryParse(string toolVersionName, bool allowUnparsed, out ToolVersionName result)

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

Parameters
Name Description
toolVersionName 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 ToolVersionName

When this method returns, the parsed ToolVersionName, 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}/tools/{tool}/versions/{version}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ToolVersionName, ToolVersionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ToolVersionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ToolVersionName

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

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.