Cloud API Registry v1beta API - Class McpToolName (1.0.0-beta01)

public sealed class McpToolName : IResourceName, IEquatable<McpToolName>

Reference documentation and code samples for the Cloud API Registry v1beta API class McpToolName.

Resource name for the McpTool resource.

Inheritance

object > McpToolName

Namespace

Google.Cloud.ApiRegistry.V1Beta

Assembly

Google.Cloud.ApiRegistry.V1Beta.dll

Constructors

McpToolName(string, string, string, string, string)

public McpToolName(string projectId, string locationId, string apiNamespaceId, string mcpServerId, string mcpToolId)

Constructs a new instance of a McpToolName class from the component parts of pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_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.

apiNamespaceId string

The ApiNamespace ID. Must not be null or empty.

mcpServerId string

The McpServer ID. Must not be null or empty.

mcpToolId string

The McpTool ID. Must not be null or empty.

Properties

ApiNamespaceId

public string ApiNamespaceId { get; }

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

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

McpServerId

public string McpServerId { get; }

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

Property Value
Type Description
string

McpToolId

public string McpToolId { get; }

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

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

Type

public McpToolName.ResourceNameType Type { get; }

The McpToolName.ResourceNameType of the contained resource name.

Property Value
Type Description
McpToolNameResourceNameType

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

public static string Format(string projectId, string locationId, string apiNamespaceId, string mcpServerId, string mcpToolId)

Formats the IDs into the string representation of this McpToolName with pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_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.

apiNamespaceId string

The ApiNamespace ID. Must not be null or empty.

mcpServerId string

The McpServer ID. Must not be null or empty.

mcpToolId string

The McpTool ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this McpToolName with pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_tool} .

FormatProjectLocationApiNamespaceMcpServerMcpTool(string, string, string, string, string)

public static string FormatProjectLocationApiNamespaceMcpServerMcpTool(string projectId, string locationId, string apiNamespaceId, string mcpServerId, string mcpToolId)

Formats the IDs into the string representation of this McpToolName with pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_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.

apiNamespaceId string

The ApiNamespace ID. Must not be null or empty.

mcpServerId string

The McpServer ID. Must not be null or empty.

mcpToolId string

The McpTool ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this McpToolName with pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_tool} .

FormatProjectLocationMcpServerMcpTool(string, string, string, string)

public static string FormatProjectLocationMcpServerMcpTool(string projectId, string locationId, string mcpServerId, string mcpToolId)

Formats the IDs into the string representation of this McpToolName with pattern projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_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.

mcpServerId string

The McpServer ID. Must not be null or empty.

mcpToolId string

The McpTool ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this McpToolName with pattern projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}.

FromProjectLocationApiNamespaceMcpServerMcpTool(string, string, string, string, string)

public static McpToolName FromProjectLocationApiNamespaceMcpServerMcpTool(string projectId, string locationId, string apiNamespaceId, string mcpServerId, string mcpToolId)

Creates a McpToolName with the pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_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.

apiNamespaceId string

The ApiNamespace ID. Must not be null or empty.

mcpServerId string

The McpServer ID. Must not be null or empty.

mcpToolId string

The McpTool ID. Must not be null or empty.

Returns
Type Description
McpToolName

A new instance of McpToolName constructed from the provided ids.

FromProjectLocationMcpServerMcpTool(string, string, string, string)

public static McpToolName FromProjectLocationMcpServerMcpTool(string projectId, string locationId, string mcpServerId, string mcpToolId)

Creates a McpToolName with the pattern projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_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.

mcpServerId string

The McpServer ID. Must not be null or empty.

mcpToolId string

The McpTool ID. Must not be null or empty.

Returns
Type Description
McpToolName

A new instance of McpToolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static McpToolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a McpToolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
McpToolName

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

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

Parameter
Name Description
mcpToolName string

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

Returns
Type Description
McpToolName

The parsed McpToolName if successful.

Remarks

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

  • projects/{project}/locations/{location}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}
  • projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}

Parse(string, bool)

public static McpToolName Parse(string mcpToolName, bool allowUnparsed)

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

Parameters
Name Description
mcpToolName 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
McpToolName

The parsed McpToolName if successful.

Remarks

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

  • projects/{project}/locations/{location}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}
  • projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_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 McpToolName)

public static bool TryParse(string mcpToolName, out McpToolName result)

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

Parameters
Name Description
mcpToolName string

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

result McpToolName

When this method returns, the parsed McpToolName, 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}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}
  • projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}

TryParse(string, bool, out McpToolName)

public static bool TryParse(string mcpToolName, bool allowUnparsed, out McpToolName result)

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

Parameters
Name Description
mcpToolName 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 McpToolName

When this method returns, the parsed McpToolName, 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}/apiNamespaces/{api_namespace}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}
  • projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(McpToolName, McpToolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a McpToolName

The first resource name to compare, or null.

b McpToolName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a McpToolName

The first resource name to compare, or null.

b McpToolName

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.