Google Cloud Dialogflow v2beta1 API - Class ToolName (1.0.0-beta24) 

public sealed class ToolName : IResourceName, IEquatable<ToolName>

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class ToolName.

Resource name for the Tool resource.

Inheritance

object > ToolName

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Constructors

ToolName(string, string, string)

public ToolName(string projectId, string locationId, string toolId)

Constructs a new instance of a ToolName class from the component parts of pattern projects/{project}/locations/{location}/tools/{tool}

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

The Tool 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. 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 ToolName.ResourceNameType Type { get; }

The ToolName.ResourceNameType of the contained resource name.

Property Value
Type Description
ToolNameResourceNameType

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

Formats the IDs into the string representation of this ToolName with pattern projects/{project}/locations/{location}/tools/{tool}.

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

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

The string representation of this ToolName with pattern projects/{project}/locations/{location}/tools/{tool}.

FormatProjectLocationTool(string, string, string)

public static string FormatProjectLocationTool(string projectId, string locationId, string toolId)

Formats the IDs into the string representation of this ToolName with pattern projects/{project}/locations/{location}/tools/{tool}.

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

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

The string representation of this ToolName with pattern projects/{project}/locations/{location}/tools/{tool}.

FromProjectLocationTool(string, string, string)

public static ToolName FromProjectLocationTool(string projectId, string locationId, string toolId)

Creates a ToolName with the pattern projects/{project}/locations/{location}/tools/{tool} .

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

The Tool ID. Must not be null or empty.
Returns
Type Description
ToolName

A new instance of ToolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ToolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ToolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
toolName string

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

The parsed ToolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/tools/{tool}

Parse(string, bool)

public static ToolName Parse(string toolName, bool allowUnparsed)

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

Parameters
Name Description
toolName 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
ToolName

The parsed ToolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/tools/{tool}
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 ToolName)

public static bool TryParse(string toolName, out ToolName result)

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

Parameters
Name Description
toolName string

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

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

TryParse(string, bool, out ToolName)

public static bool TryParse(string toolName, bool allowUnparsed, out ToolName result)

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

Parameters
Name Description
toolName 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 ToolName

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

Operators

operator ==(ToolName, ToolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ToolName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ToolName

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

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.