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

public sealed class CesToolName : IResourceName, IEquatable<CesToolName>

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

Resource name for the CesTool resource.

Inheritance

object > CesToolName

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Constructors

CesToolName(string, string, string, string)

public CesToolName(string projectId, string locationId, string appId, string toolId)

Constructs a new instance of a CesToolName class from the component parts of pattern projects/{project}/locations/{location}/apps/{app}/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.
appId string

The App ID. Must not be null or empty.
toolId string

The Tool ID. Must not be null or empty.

Properties

AppId

public string AppId { get; }

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

The CesToolName.ResourceNameType of the contained resource name.

Property Value
Type Description
CesToolNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string appId, string toolId)

Formats the IDs into the string representation of this CesToolName with pattern projects/{project}/locations/{location}/apps/{app}/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.
appId string

The App 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 CesToolName with pattern projects/{project}/locations/{location}/apps/{app}/tools/{tool}.

FormatProjectLocationAppTool(string, string, string, string)

public static string FormatProjectLocationAppTool(string projectId, string locationId, string appId, string toolId)

Formats the IDs into the string representation of this CesToolName with pattern projects/{project}/locations/{location}/apps/{app}/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.
appId string

The App 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 CesToolName with pattern projects/{project}/locations/{location}/apps/{app}/tools/{tool}.

FromProjectLocationAppTool(string, string, string, string)

public static CesToolName FromProjectLocationAppTool(string projectId, string locationId, string appId, string toolId)

Creates a CesToolName with the pattern projects/{project}/locations/{location}/apps/{app}/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.
appId string

The App ID. Must not be null or empty.
toolId string

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

A new instance of CesToolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CesToolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CesToolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
cesToolName string

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

The parsed CesToolName if successful.
Remarks

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

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

Parse(string, bool)

public static CesToolName Parse(string cesToolName, bool allowUnparsed)

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

Parameters
Name Description
cesToolName 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
CesToolName

The parsed CesToolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/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 CesToolName)

public static bool TryParse(string cesToolName, out CesToolName result)

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

Parameters
Name Description
cesToolName string

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

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

TryParse(string, bool, out CesToolName)

public static bool TryParse(string cesToolName, bool allowUnparsed, out CesToolName result)

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

Parameters
Name Description
cesToolName 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 CesToolName

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

Operators

operator ==(CesToolName, CesToolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CesToolName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CesToolName

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

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.