Class CloudApiRegistryClient (3.2.0-rc)

The Cloud API Registry service provides a central registry for managing API Data.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

CloudApiRegistryClient(CloudApiRegistryClient const &)

Copy and move support

Parameter
Name Description
CloudApiRegistryClient const &

CloudApiRegistryClient(CloudApiRegistryClient &&)

Copy and move support

Parameter
Name Description
CloudApiRegistryClient &&

CloudApiRegistryClient(std::shared_ptr< CloudApiRegistryConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< CloudApiRegistryConnection >
opts Options

Operators

operator=(CloudApiRegistryClient const &)

Copy and move support

Parameter
Name Description
CloudApiRegistryClient const &
Returns
Type Description
CloudApiRegistryClient &

operator=(CloudApiRegistryClient &&)

Copy and move support

Parameter
Name Description
CloudApiRegistryClient &&
Returns
Type Description
CloudApiRegistryClient &

Functions

GetMcpServer(std::string const &, Options)

Gets a single McpServer.

Parameters
Name Description
name std::string const &

Required. Name of the resource Format: projects/{project}/locations/{location}/mcpServers/{mcp_server}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::apiregistry::v1::McpServer >

the result of the RPC. The response message type (google.cloud.apiregistry.v1.McpServer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMcpServer(google::cloud::apiregistry::v1::GetMcpServerRequest const &, Options)

Gets a single McpServer.

Parameters
Name Description
request google::cloud::apiregistry::v1::GetMcpServerRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.apiregistry.v1.GetMcpServerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::apiregistry::v1::McpServer >

the result of the RPC. The response message type (google.cloud.apiregistry.v1.McpServer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListMcpServers(std::string const &, Options)

Lists McpServers in a given Project.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListMcpServersRequest

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::apiregistry::v1::McpServer >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.apiregistry.v1.McpServer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMcpServers(google::cloud::apiregistry::v1::ListMcpServersRequest, Options)

Lists McpServers in a given Project.

Parameters
Name Description
request google::cloud::apiregistry::v1::ListMcpServersRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.apiregistry.v1.ListMcpServersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::apiregistry::v1::McpServer >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.apiregistry.v1.McpServer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetMcpTool(std::string const &, Options)

Gets a single McpTool.

Parameters
Name Description
name std::string const &

Required. Name of the resource Format: projects/{project}/locations/{location}/mcpServers/{mcp_server}/mcpTools/{mcp_tool}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::apiregistry::v1::McpTool >

the result of the RPC. The response message type (google.cloud.apiregistry.v1.McpTool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMcpTool(google::cloud::apiregistry::v1::GetMcpToolRequest const &, Options)

Gets a single McpTool.

Parameters
Name Description
request google::cloud::apiregistry::v1::GetMcpToolRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.apiregistry.v1.GetMcpToolRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::apiregistry::v1::McpTool >

the result of the RPC. The response message type (google.cloud.apiregistry.v1.McpTool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListMcpTools(std::string const &, Options)

Lists McpTools in a given McpServer.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListMcpToolsRequest

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::apiregistry::v1::McpTool >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.apiregistry.v1.McpTool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMcpTools(google::cloud::apiregistry::v1::ListMcpToolsRequest, Options)

Lists McpTools in a given McpServer.

Parameters
Name Description
request google::cloud::apiregistry::v1::ListMcpToolsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.apiregistry.v1.ListMcpToolsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::apiregistry::v1::McpTool >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.apiregistry.v1.McpTool, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name Description
request google::cloud::location::ListLocationsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::location::Location >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name Description
request google::cloud::location::GetLocationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::location::Location >

the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.