Service for managing Agents, Endpoints, McpServers, Services, and Bindings.
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
AgentRegistryClient(AgentRegistryClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AgentRegistryClient const &
|
AgentRegistryClient(AgentRegistryClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AgentRegistryClient &&
|
AgentRegistryClient(std::shared_ptr< AgentRegistryConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< AgentRegistryConnection >
|
opts |
Options
|
Operators
operator=(AgentRegistryClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AgentRegistryClient const &
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient & |
|
operator=(AgentRegistryClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AgentRegistryClient &&
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient & |
|
Functions
ListAgents(std::string const &, Options)
Lists Agents in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Parent value for ListAgentsRequest |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Agent > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAgents(google::cloud::agentregistry::v1::ListAgentsRequest, Options)
Lists Agents in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::ListAgentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Agent > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchAgents(std::string const &, Options)
Searches Agents in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Parent value for SearchAgentsRequest. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Agent > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchAgents(google::cloud::agentregistry::v1::SearchAgentsRequest, Options)
Searches Agents in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::SearchAgentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Agent > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetAgent(std::string const &, Options)
Gets details of a single Agent.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::Agent > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAgent(google::cloud::agentregistry::v1::GetAgentRequest const &, Options)
Gets details of a single Agent.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::GetAgentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::Agent > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListEndpoints(std::string const &, Options)
Lists Endpoints in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The project and location to list endpoints in. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Endpoint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListEndpoints(google::cloud::agentregistry::v1::ListEndpointsRequest, Options)
Lists Endpoints in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::ListEndpointsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Endpoint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetEndpoint(std::string const &, Options)
Gets details of a single Endpoint.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the endpoint to retrieve. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::Endpoint > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.Endpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetEndpoint(google::cloud::agentregistry::v1::GetEndpointRequest const &, Options)
Gets details of a single Endpoint.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::GetEndpointRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::Endpoint > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.Endpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListMcpServers(std::string const &, Options)
Lists McpServers in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Parent value for ListMcpServersRequest. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::McpServer > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListMcpServers(google::cloud::agentregistry::v1::ListMcpServersRequest, Options)
Lists McpServers in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::ListMcpServersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::McpServer > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchMcpServers(std::string const &, Options)
Searches McpServers in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Parent value for SearchMcpServersRequest. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::McpServer > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchMcpServers(google::cloud::agentregistry::v1::SearchMcpServersRequest, Options)
Searches McpServers in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::SearchMcpServersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::McpServer > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetMcpServer(std::string const &, Options)
Gets details of a single McpServer.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::McpServer > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.McpServer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetMcpServer(google::cloud::agentregistry::v1::GetMcpServerRequest const &, Options)
Gets details of a single McpServer.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::GetMcpServerRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::McpServer > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.McpServer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListServices(std::string const &, Options)
Lists Services in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The project and location to list services in. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Service > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListServices(google::cloud::agentregistry::v1::ListServicesRequest, Options)
Lists Services in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::ListServicesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Service > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetService(std::string const &, Options)
Gets details of a single Service.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the Service. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::Service > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetService(google::cloud::agentregistry::v1::GetServiceRequest const &, Options)
Gets details of a single Service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::GetServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::Service > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.Service) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateService(std::string const &, google::cloud::agentregistry::v1::Service const &, std::string const &, Options)
Creates a new Service in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The project and location to create the Service in. Expected format: |
service |
google::cloud::agentregistry::v1::Service const &
Required. The Service resource that is being created. Format: |
service_id |
std::string const &
Required. The ID to use for the service, which will become the final component of the service's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Service > > |
A |
CreateService(NoAwaitTag, std::string const &, google::cloud::agentregistry::v1::Service const &, std::string const &, Options)
Creates a new Service in a given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
service |
google::cloud::agentregistry::v1::Service const &
|
service_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateService(google::cloud::agentregistry::v1::CreateServiceRequest const &, Options)
Creates a new Service in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::CreateServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Service > > |
A |
CreateService(NoAwaitTag, google::cloud::agentregistry::v1::CreateServiceRequest const &, Options)
Creates a new Service in a given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::agentregistry::v1::CreateServiceRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateService(google::longrunning::Operation const &, Options)
Creates a new Service in a given project and location.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Service > > |
|
UpdateService(google::cloud::agentregistry::v1::Service const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Service.
| Parameters | |
|---|---|
| Name | Description |
service |
google::cloud::agentregistry::v1::Service const &
Required. The Service resource that is being updated. Format: |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Service > > |
A |
UpdateService(NoAwaitTag, google::cloud::agentregistry::v1::Service const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Service.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
service |
google::cloud::agentregistry::v1::Service const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateService(google::cloud::agentregistry::v1::UpdateServiceRequest const &, Options)
Updates the parameters of a single Service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::UpdateServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Service > > |
A |
UpdateService(NoAwaitTag, google::cloud::agentregistry::v1::UpdateServiceRequest const &, Options)
Updates the parameters of a single Service.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::agentregistry::v1::UpdateServiceRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateService(google::longrunning::Operation const &, Options)
Updates the parameters of a single Service.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Service > > |
|
DeleteService(std::string const &, Options)
Deletes a single Service.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the Service. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::OperationMetadata > > |
A |
DeleteService(NoAwaitTag, std::string const &, Options)
Deletes a single Service.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteService(google::cloud::agentregistry::v1::DeleteServiceRequest const &, Options)
Deletes a single Service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::DeleteServiceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::OperationMetadata > > |
A |
DeleteService(NoAwaitTag, google::cloud::agentregistry::v1::DeleteServiceRequest const &, Options)
Deletes a single Service.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::agentregistry::v1::DeleteServiceRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteService(google::longrunning::Operation const &, Options)
Deletes a single Service.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::OperationMetadata > > |
|
ListBindings(std::string const &, Options)
Lists Bindings in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The project and location to list bindings in. Expected format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Binding > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBindings(google::cloud::agentregistry::v1::ListBindingsRequest, Options)
Lists Bindings in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::ListBindingsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Binding > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetBinding(std::string const &, Options)
Gets details of a single Binding.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the Binding. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::Binding > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.Binding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBinding(google::cloud::agentregistry::v1::GetBindingRequest const &, Options)
Gets details of a single Binding.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::GetBindingRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::agentregistry::v1::Binding > |
the result of the RPC. The response message type (google.cloud.agentregistry.v1.Binding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateBinding(std::string const &, google::cloud::agentregistry::v1::Binding const &, std::string const &, Options)
Creates a new Binding in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The project and location to create the Binding in. Expected format: |
binding |
google::cloud::agentregistry::v1::Binding const &
Required. The Binding resource that is being created. |
binding_id |
std::string const &
Required. The ID to use for the binding, which will become the final component of the binding's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Binding > > |
A |
CreateBinding(NoAwaitTag, std::string const &, google::cloud::agentregistry::v1::Binding const &, std::string const &, Options)
Creates a new Binding in a given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
binding |
google::cloud::agentregistry::v1::Binding const &
|
binding_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateBinding(google::cloud::agentregistry::v1::CreateBindingRequest const &, Options)
Creates a new Binding in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::CreateBindingRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Binding > > |
A |
CreateBinding(NoAwaitTag, google::cloud::agentregistry::v1::CreateBindingRequest const &, Options)
Creates a new Binding in a given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::agentregistry::v1::CreateBindingRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateBinding(google::longrunning::Operation const &, Options)
Creates a new Binding in a given project and location.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Binding > > |
|
UpdateBinding(google::cloud::agentregistry::v1::Binding const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Binding.
| Parameters | |
|---|---|
| Name | Description |
binding |
google::cloud::agentregistry::v1::Binding const &
Required. The Binding resource that is being updated. |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask is used to specify the fields to be overwritten in the Binding resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Binding > > |
A |
UpdateBinding(NoAwaitTag, google::cloud::agentregistry::v1::Binding const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Binding.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
binding |
google::cloud::agentregistry::v1::Binding const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateBinding(google::cloud::agentregistry::v1::UpdateBindingRequest const &, Options)
Updates the parameters of a single Binding.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::UpdateBindingRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Binding > > |
A |
UpdateBinding(NoAwaitTag, google::cloud::agentregistry::v1::UpdateBindingRequest const &, Options)
Updates the parameters of a single Binding.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::agentregistry::v1::UpdateBindingRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateBinding(google::longrunning::Operation const &, Options)
Updates the parameters of a single Binding.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::Binding > > |
|
DeleteBinding(std::string const &, Options)
Deletes a single Binding.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the Binding. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::OperationMetadata > > |
A |
DeleteBinding(NoAwaitTag, std::string const &, Options)
Deletes a single Binding.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteBinding(google::cloud::agentregistry::v1::DeleteBindingRequest const &, Options)
Deletes a single Binding.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::DeleteBindingRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::OperationMetadata > > |
A |
DeleteBinding(NoAwaitTag, google::cloud::agentregistry::v1::DeleteBindingRequest const &, Options)
Deletes a single Binding.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::agentregistry::v1::DeleteBindingRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteBinding(google::longrunning::Operation const &, Options)
Deletes a single Binding.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::agentregistry::v1::OperationMetadata > > |
|
FetchAvailableBindings(std::string const &, Options)
Fetches available Bindings.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Binding > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
FetchAvailableBindings(google::cloud::agentregistry::v1::FetchAvailableBindingsRequest, Options)
Fetches available Bindings.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::agentregistry::v1::FetchAvailableBindingsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::agentregistry::v1::Binding > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
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 |
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 |
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 |
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 |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::DeleteOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::CancelOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |