| GitHub Repository | Product Reference |
Service Description: Service for managing Agents, Endpoints, McpServers, Services, and Bindings.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
AgentName name = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
Agent response = agentRegistryClient.getAgent(name);
}
Note: close() needs to be called on the AgentRegistryClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
ListAgents |
Lists Agents in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SearchAgents |
Searches Agents in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetAgent |
Gets details of a single Agent. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListEndpoints |
Lists Endpoints in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetEndpoint |
Gets details of a single Endpoint. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListMcpServers |
Lists McpServers in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SearchMcpServers |
Searches McpServers in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetMcpServer |
Gets details of a single McpServer. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListServices |
Lists Services in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetService |
Gets details of a single Service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateService |
Creates a new Service in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateService |
Updates the parameters of a single Service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteService |
Deletes a single Service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListBindings |
Lists Bindings in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetBinding |
Gets details of a single Binding. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateBinding |
Creates a new Binding in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateBinding |
Updates the parameters of a single Binding. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteBinding |
Deletes a single Binding. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
FetchAvailableBindings |
Fetches available Bindings. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If For gRPC and client library implementations, the resource name ispassed as the |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AgentRegistrySettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AgentRegistrySettings agentRegistrySettings =
AgentRegistrySettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AgentRegistryClient agentRegistryClient = AgentRegistryClient.create(agentRegistrySettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AgentRegistrySettings agentRegistrySettings =
AgentRegistrySettings.newBuilder().setEndpoint(myEndpoint).build();
AgentRegistryClient agentRegistryClient = AgentRegistryClient.create(agentRegistrySettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AgentRegistrySettings agentRegistrySettings =
AgentRegistrySettings.newHttpJsonBuilder().build();
AgentRegistryClient agentRegistryClient = AgentRegistryClient.create(agentRegistrySettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final AgentRegistryClient create()Constructs an instance of AgentRegistryClient with default settings.
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(AgentRegistrySettings settings)
public static final AgentRegistryClient create(AgentRegistrySettings settings)Constructs an instance of AgentRegistryClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Parameter | |
|---|---|
| Name | Description |
settings |
AgentRegistrySettings |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(AgentRegistryStub stub)
public static final AgentRegistryClient create(AgentRegistryStub stub)Constructs an instance of AgentRegistryClient, using the given stub for making calls. This is for advanced usage - prefer using create(AgentRegistrySettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
AgentRegistryStub |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient |
|
Constructors
AgentRegistryClient(AgentRegistrySettings settings)
protected AgentRegistryClient(AgentRegistrySettings settings)Constructs an instance of AgentRegistryClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Parameter | |
|---|---|
| Name | Description |
settings |
AgentRegistrySettings |
AgentRegistryClient(AgentRegistryStub stub)
protected AgentRegistryClient(AgentRegistryStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
AgentRegistryStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
public final void close()createBindingAsync(@Nullable LocationName parent, Binding binding, String bindingId)
public final OperationFuture<Binding,OperationMetadata> createBindingAsync(@Nullable LocationName parent, Binding binding, String bindingId)Creates a new Binding in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Binding binding = Binding.newBuilder().build();
String bindingId = "bindingId-920966528";
Binding response = agentRegistryClient.createBindingAsync(parent, binding, bindingId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. The project and location to create the Binding in. Expected format:
|
binding |
BindingRequired. The Binding resource that is being created. |
bindingId |
StringRequired. The ID to use for the binding, which will become the final component of the binding's resource name. This value should be 4-63 characters, and must conform to RFC-1034. Specifically, it
must match the regular expression |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Binding,OperationMetadata> |
|
createBindingAsync(CreateBindingRequest request)
public final OperationFuture<Binding,OperationMetadata> createBindingAsync(CreateBindingRequest request)Creates a new Binding in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
CreateBindingRequest request =
CreateBindingRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBindingId("bindingId-920966528")
.setBinding(Binding.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Binding response = agentRegistryClient.createBindingAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateBindingRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Binding,OperationMetadata> |
|
createBindingAsync(String parent, Binding binding, String bindingId)
public final OperationFuture<Binding,OperationMetadata> createBindingAsync(String parent, Binding binding, String bindingId)Creates a new Binding in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Binding binding = Binding.newBuilder().build();
String bindingId = "bindingId-920966528";
Binding response = agentRegistryClient.createBindingAsync(parent, binding, bindingId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The project and location to create the Binding in. Expected format:
|
binding |
BindingRequired. The Binding resource that is being created. |
bindingId |
StringRequired. The ID to use for the binding, which will become the final component of the binding's resource name. This value should be 4-63 characters, and must conform to RFC-1034. Specifically, it
must match the regular expression |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Binding,OperationMetadata> |
|
createBindingCallable()
public final UnaryCallable<CreateBindingRequest,Operation> createBindingCallable()Creates a new Binding in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
CreateBindingRequest request =
CreateBindingRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBindingId("bindingId-920966528")
.setBinding(Binding.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = agentRegistryClient.createBindingCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateBindingRequest,Operation> |
|
createBindingOperationCallable()
public final OperationCallable<CreateBindingRequest,Binding,OperationMetadata> createBindingOperationCallable()Creates a new Binding in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
CreateBindingRequest request =
CreateBindingRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setBindingId("bindingId-920966528")
.setBinding(Binding.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Binding, OperationMetadata> future =
agentRegistryClient.createBindingOperationCallable().futureCall(request);
// Do something.
Binding response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<CreateBindingRequest,Binding,OperationMetadata> |
|
createServiceAsync(@Nullable LocationName parent, Service service, String serviceId)
public final OperationFuture<Service,OperationMetadata> createServiceAsync(@Nullable LocationName parent, Service service, String serviceId)Creates a new Service in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Service service = Service.newBuilder().build();
String serviceId = "serviceId-194185552";
Service response = agentRegistryClient.createServiceAsync(parent, service, serviceId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. The project and location to create the Service in. Expected format:
|
service |
ServiceRequired. The Service resource that is being created. Format:
|
serviceId |
StringRequired. The ID to use for the service, which will become the final component of the service's resource name. This value should be 4-63 characters, and valid characters are |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Service,OperationMetadata> |
|
createServiceAsync(CreateServiceRequest request)
public final OperationFuture<Service,OperationMetadata> createServiceAsync(CreateServiceRequest request)Creates a new Service in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setServiceId("serviceId-194185552")
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Service response = agentRegistryClient.createServiceAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateServiceRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Service,OperationMetadata> |
|
createServiceAsync(String parent, Service service, String serviceId)
public final OperationFuture<Service,OperationMetadata> createServiceAsync(String parent, Service service, String serviceId)Creates a new Service in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Service service = Service.newBuilder().build();
String serviceId = "serviceId-194185552";
Service response = agentRegistryClient.createServiceAsync(parent, service, serviceId).get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The project and location to create the Service in. Expected format:
|
service |
ServiceRequired. The Service resource that is being created. Format:
|
serviceId |
StringRequired. The ID to use for the service, which will become the final component of the service's resource name. This value should be 4-63 characters, and valid characters are |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Service,OperationMetadata> |
|
createServiceCallable()
public final UnaryCallable<CreateServiceRequest,Operation> createServiceCallable()Creates a new Service in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setServiceId("serviceId-194185552")
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = agentRegistryClient.createServiceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateServiceRequest,Operation> |
|
createServiceOperationCallable()
public final OperationCallable<CreateServiceRequest,Service,OperationMetadata> createServiceOperationCallable()Creates a new Service in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setServiceId("serviceId-194185552")
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Service, OperationMetadata> future =
agentRegistryClient.createServiceOperationCallable().futureCall(request);
// Do something.
Service response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<CreateServiceRequest,Service,OperationMetadata> |
|
deleteBindingAsync(@Nullable BindingName name)
public final OperationFuture<Empty,OperationMetadata> deleteBindingAsync(@Nullable BindingName name)Deletes a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
BindingName name = BindingName.of("[PROJECT]", "[LOCATION]", "[BINDING]");
agentRegistryClient.deleteBindingAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.BindingNameRequired. The name of the Binding. Format:
|
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteBindingAsync(DeleteBindingRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteBindingAsync(DeleteBindingRequest request)Deletes a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
DeleteBindingRequest request =
DeleteBindingRequest.newBuilder()
.setName(BindingName.of("[PROJECT]", "[LOCATION]", "[BINDING]").toString())
.setRequestId("requestId693933066")
.build();
agentRegistryClient.deleteBindingAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteBindingRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteBindingAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteBindingAsync(String name)Deletes a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String name = BindingName.of("[PROJECT]", "[LOCATION]", "[BINDING]").toString();
agentRegistryClient.deleteBindingAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the Binding. Format:
|
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteBindingCallable()
public final UnaryCallable<DeleteBindingRequest,Operation> deleteBindingCallable()Deletes a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
DeleteBindingRequest request =
DeleteBindingRequest.newBuilder()
.setName(BindingName.of("[PROJECT]", "[LOCATION]", "[BINDING]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = agentRegistryClient.deleteBindingCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteBindingRequest,Operation> |
|
deleteBindingOperationCallable()
public final OperationCallable<DeleteBindingRequest,Empty,OperationMetadata> deleteBindingOperationCallable()Deletes a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
DeleteBindingRequest request =
DeleteBindingRequest.newBuilder()
.setName(BindingName.of("[PROJECT]", "[LOCATION]", "[BINDING]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
agentRegistryClient.deleteBindingOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteBindingRequest,Empty,OperationMetadata> |
|
deleteServiceAsync(@Nullable ServiceName name)
public final OperationFuture<Empty,OperationMetadata> deleteServiceAsync(@Nullable ServiceName name)Deletes a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
agentRegistryClient.deleteServiceAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.ServiceNameRequired. The name of the Service. Format:
|
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteServiceAsync(DeleteServiceRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteServiceAsync(DeleteServiceRequest request)Deletes a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
DeleteServiceRequest request =
DeleteServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setRequestId("requestId693933066")
.build();
agentRegistryClient.deleteServiceAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteServiceRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteServiceAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteServiceAsync(String name)Deletes a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
agentRegistryClient.deleteServiceAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the Service. Format:
|
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteServiceCallable()
public final UnaryCallable<DeleteServiceRequest,Operation> deleteServiceCallable()Deletes a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
DeleteServiceRequest request =
DeleteServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = agentRegistryClient.deleteServiceCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteServiceRequest,Operation> |
|
deleteServiceOperationCallable()
public final OperationCallable<DeleteServiceRequest,Empty,OperationMetadata> deleteServiceOperationCallable()Deletes a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
DeleteServiceRequest request =
DeleteServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
agentRegistryClient.deleteServiceOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteServiceRequest,Empty,OperationMetadata> |
|
fetchAvailableBindings(@Nullable LocationName parent)
public final AgentRegistryClient.FetchAvailableBindingsPagedResponse fetchAvailableBindings(@Nullable LocationName parent)Fetches available Bindings.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Binding element : agentRegistryClient.fetchAvailableBindings(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. The parent, in the format |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.FetchAvailableBindingsPagedResponse |
|
fetchAvailableBindings(FetchAvailableBindingsRequest request)
public final AgentRegistryClient.FetchAvailableBindingsPagedResponse fetchAvailableBindings(FetchAvailableBindingsRequest request)Fetches available Bindings.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
FetchAvailableBindingsRequest request =
FetchAvailableBindingsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Binding element : agentRegistryClient.fetchAvailableBindings(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
FetchAvailableBindingsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.FetchAvailableBindingsPagedResponse |
|
fetchAvailableBindings(String parent)
public final AgentRegistryClient.FetchAvailableBindingsPagedResponse fetchAvailableBindings(String parent)Fetches available Bindings.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Binding element : agentRegistryClient.fetchAvailableBindings(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent, in the format |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.FetchAvailableBindingsPagedResponse |
|
fetchAvailableBindingsCallable()
public final UnaryCallable<FetchAvailableBindingsRequest,FetchAvailableBindingsResponse> fetchAvailableBindingsCallable()Fetches available Bindings.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
FetchAvailableBindingsRequest request =
FetchAvailableBindingsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
FetchAvailableBindingsResponse response =
agentRegistryClient.fetchAvailableBindingsCallable().call(request);
for (Binding element : response.getBindingsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<FetchAvailableBindingsRequest,FetchAvailableBindingsResponse> |
|
fetchAvailableBindingsPagedCallable()
public final UnaryCallable<FetchAvailableBindingsRequest,AgentRegistryClient.FetchAvailableBindingsPagedResponse> fetchAvailableBindingsPagedCallable()Fetches available Bindings.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
FetchAvailableBindingsRequest request =
FetchAvailableBindingsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Binding> future =
agentRegistryClient.fetchAvailableBindingsPagedCallable().futureCall(request);
// Do something.
for (Binding element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<FetchAvailableBindingsRequest,FetchAvailableBindingsPagedResponse> |
|
getAgent(@Nullable AgentName name)
public final Agent getAgent(@Nullable AgentName name)Gets details of a single Agent.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
AgentName name = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
Agent response = agentRegistryClient.getAgent(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.AgentNameRequired. Name of the resource |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
getAgent(GetAgentRequest request)
public final Agent getAgent(GetAgentRequest request)Gets details of a single Agent.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetAgentRequest request =
GetAgentRequest.newBuilder()
.setName(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.build();
Agent response = agentRegistryClient.getAgent(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetAgentRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
getAgent(String name)
public final Agent getAgent(String name)Gets details of a single Agent.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String name = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
Agent response = agentRegistryClient.getAgent(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource |
| Returns | |
|---|---|
| Type | Description |
Agent |
|
getAgentCallable()
public final UnaryCallable<GetAgentRequest,Agent> getAgentCallable()Gets details of a single Agent.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetAgentRequest request =
GetAgentRequest.newBuilder()
.setName(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
.build();
ApiFuture<Agent> future = agentRegistryClient.getAgentCallable().futureCall(request);
// Do something.
Agent response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetAgentRequest,Agent> |
|
getBinding(@Nullable BindingName name)
public final Binding getBinding(@Nullable BindingName name)Gets details of a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
BindingName name = BindingName.of("[PROJECT]", "[LOCATION]", "[BINDING]");
Binding response = agentRegistryClient.getBinding(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.BindingNameRequired. The name of the Binding. Format:
|
| Returns | |
|---|---|
| Type | Description |
Binding |
|
getBinding(GetBindingRequest request)
public final Binding getBinding(GetBindingRequest request)Gets details of a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetBindingRequest request =
GetBindingRequest.newBuilder()
.setName(BindingName.of("[PROJECT]", "[LOCATION]", "[BINDING]").toString())
.build();
Binding response = agentRegistryClient.getBinding(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetBindingRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Binding |
|
getBinding(String name)
public final Binding getBinding(String name)Gets details of a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String name = BindingName.of("[PROJECT]", "[LOCATION]", "[BINDING]").toString();
Binding response = agentRegistryClient.getBinding(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the Binding. Format:
|
| Returns | |
|---|---|
| Type | Description |
Binding |
|
getBindingCallable()
public final UnaryCallable<GetBindingRequest,Binding> getBindingCallable()Gets details of a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetBindingRequest request =
GetBindingRequest.newBuilder()
.setName(BindingName.of("[PROJECT]", "[LOCATION]", "[BINDING]").toString())
.build();
ApiFuture<Binding> future = agentRegistryClient.getBindingCallable().futureCall(request);
// Do something.
Binding response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetBindingRequest,Binding> |
|
getEndpoint(@Nullable EndpointName name)
public final Endpoint getEndpoint(@Nullable EndpointName name)Gets details of a single Endpoint.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
EndpointName name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
Endpoint response = agentRegistryClient.getEndpoint(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.EndpointNameRequired. The name of the endpoint to retrieve. Format:
|
| Returns | |
|---|---|
| Type | Description |
Endpoint |
|
getEndpoint(GetEndpointRequest request)
public final Endpoint getEndpoint(GetEndpointRequest request)Gets details of a single Endpoint.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetEndpointRequest request =
GetEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.build();
Endpoint response = agentRegistryClient.getEndpoint(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetEndpointRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Endpoint |
|
getEndpoint(String name)
public final Endpoint getEndpoint(String name)Gets details of a single Endpoint.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString();
Endpoint response = agentRegistryClient.getEndpoint(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the endpoint to retrieve. Format:
|
| Returns | |
|---|---|
| Type | Description |
Endpoint |
|
getEndpointCallable()
public final UnaryCallable<GetEndpointRequest,Endpoint> getEndpointCallable()Gets details of a single Endpoint.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetEndpointRequest request =
GetEndpointRequest.newBuilder()
.setName(EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]").toString())
.build();
ApiFuture<Endpoint> future = agentRegistryClient.getEndpointCallable().futureCall(request);
// Do something.
Endpoint response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetEndpointRequest,Endpoint> |
|
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = agentRegistryClient.getLocation(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.GetLocationRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.cloud.location.Location |
|
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = agentRegistryClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getMcpServer(@Nullable McpServerName name)
public final McpServer getMcpServer(@Nullable McpServerName name)Gets details of a single McpServer.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
McpServerName name = McpServerName.of("[PROJECT]", "[LOCATION]", "[MCP_SERVER]");
McpServer response = agentRegistryClient.getMcpServer(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.McpServerNameRequired. Name of the resource |
| Returns | |
|---|---|
| Type | Description |
McpServer |
|
getMcpServer(GetMcpServerRequest request)
public final McpServer getMcpServer(GetMcpServerRequest request)Gets details of a single McpServer.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetMcpServerRequest request =
GetMcpServerRequest.newBuilder()
.setName(McpServerName.of("[PROJECT]", "[LOCATION]", "[MCP_SERVER]").toString())
.build();
McpServer response = agentRegistryClient.getMcpServer(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetMcpServerRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
McpServer |
|
getMcpServer(String name)
public final McpServer getMcpServer(String name)Gets details of a single McpServer.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String name = McpServerName.of("[PROJECT]", "[LOCATION]", "[MCP_SERVER]").toString();
McpServer response = agentRegistryClient.getMcpServer(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource |
| Returns | |
|---|---|
| Type | Description |
McpServer |
|
getMcpServerCallable()
public final UnaryCallable<GetMcpServerRequest,McpServer> getMcpServerCallable()Gets details of a single McpServer.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetMcpServerRequest request =
GetMcpServerRequest.newBuilder()
.setName(McpServerName.of("[PROJECT]", "[LOCATION]", "[MCP_SERVER]").toString())
.build();
ApiFuture<McpServer> future = agentRegistryClient.getMcpServerCallable().futureCall(request);
// Do something.
McpServer response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetMcpServerRequest,McpServer> |
|
getOperationsClient()
public final OperationsClient getOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getService(@Nullable ServiceName name)
public final Service getService(@Nullable ServiceName name)Gets details of a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
Service response = agentRegistryClient.getService(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.ServiceNameRequired. The name of the Service. Format:
|
| Returns | |
|---|---|
| Type | Description |
Service |
|
getService(GetServiceRequest request)
public final Service getService(GetServiceRequest request)Gets details of a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetServiceRequest request =
GetServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.build();
Service response = agentRegistryClient.getService(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetServiceRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Service |
|
getService(String name)
public final Service getService(String name)Gets details of a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
Service response = agentRegistryClient.getService(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the Service. Format:
|
| Returns | |
|---|---|
| Type | Description |
Service |
|
getServiceCallable()
public final UnaryCallable<GetServiceRequest,Service> getServiceCallable()Gets details of a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
GetServiceRequest request =
GetServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.build();
ApiFuture<Service> future = agentRegistryClient.getServiceCallable().futureCall(request);
// Do something.
Service response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetServiceRequest,Service> |
|
getSettings()
public final @Nullable AgentRegistrySettings getSettings()| Returns | |
|---|---|
| Type | Description |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.AgentRegistrySettings |
|
getStub()
public AgentRegistryStub getStub()| Returns | |
|---|---|
| Type | Description |
AgentRegistryStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listAgents(@Nullable LocationName parent)
public final AgentRegistryClient.ListAgentsPagedResponse listAgents(@Nullable LocationName parent)Lists Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Agent element : agentRegistryClient.listAgents(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. Parent value for ListAgentsRequest |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListAgentsPagedResponse |
|
listAgents(ListAgentsRequest request)
public final AgentRegistryClient.ListAgentsPagedResponse listAgents(ListAgentsRequest request)Lists Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListAgentsRequest request =
ListAgentsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Agent element : agentRegistryClient.listAgents(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListAgentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListAgentsPagedResponse |
|
listAgents(String parent)
public final AgentRegistryClient.ListAgentsPagedResponse listAgents(String parent)Lists Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Agent element : agentRegistryClient.listAgents(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Parent value for ListAgentsRequest |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListAgentsPagedResponse |
|
listAgentsCallable()
public final UnaryCallable<ListAgentsRequest,ListAgentsResponse> listAgentsCallable()Lists Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListAgentsRequest request =
ListAgentsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListAgentsResponse response = agentRegistryClient.listAgentsCallable().call(request);
for (Agent element : response.getAgentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAgentsRequest,ListAgentsResponse> |
|
listAgentsPagedCallable()
public final UnaryCallable<ListAgentsRequest,AgentRegistryClient.ListAgentsPagedResponse> listAgentsPagedCallable()Lists Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListAgentsRequest request =
ListAgentsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Agent> future = agentRegistryClient.listAgentsPagedCallable().futureCall(request);
// Do something.
for (Agent element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListAgentsRequest,ListAgentsPagedResponse> |
|
listBindings(@Nullable LocationName parent)
public final AgentRegistryClient.ListBindingsPagedResponse listBindings(@Nullable LocationName parent)Lists Bindings in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Binding element : agentRegistryClient.listBindings(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. The project and location to list bindings in. Expected format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListBindingsPagedResponse |
|
listBindings(ListBindingsRequest request)
public final AgentRegistryClient.ListBindingsPagedResponse listBindings(ListBindingsRequest request)Lists Bindings in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListBindingsRequest request =
ListBindingsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Binding element : agentRegistryClient.listBindings(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListBindingsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListBindingsPagedResponse |
|
listBindings(String parent)
public final AgentRegistryClient.ListBindingsPagedResponse listBindings(String parent)Lists Bindings in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Binding element : agentRegistryClient.listBindings(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The project and location to list bindings in. Expected format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListBindingsPagedResponse |
|
listBindingsCallable()
public final UnaryCallable<ListBindingsRequest,ListBindingsResponse> listBindingsCallable()Lists Bindings in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListBindingsRequest request =
ListBindingsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListBindingsResponse response = agentRegistryClient.listBindingsCallable().call(request);
for (Binding element : response.getBindingsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListBindingsRequest,ListBindingsResponse> |
|
listBindingsPagedCallable()
public final UnaryCallable<ListBindingsRequest,AgentRegistryClient.ListBindingsPagedResponse> listBindingsPagedCallable()Lists Bindings in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListBindingsRequest request =
ListBindingsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Binding> future =
agentRegistryClient.listBindingsPagedCallable().futureCall(request);
// Do something.
for (Binding element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListBindingsRequest,ListBindingsPagedResponse> |
|
listEndpoints(@Nullable LocationName parent)
public final AgentRegistryClient.ListEndpointsPagedResponse listEndpoints(@Nullable LocationName parent)Lists Endpoints in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Endpoint element : agentRegistryClient.listEndpoints(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. The project and location to list endpoints in. Expected format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListEndpointsPagedResponse |
|
listEndpoints(ListEndpointsRequest request)
public final AgentRegistryClient.ListEndpointsPagedResponse listEndpoints(ListEndpointsRequest request)Lists Endpoints in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (Endpoint element : agentRegistryClient.listEndpoints(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListEndpointsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListEndpointsPagedResponse |
|
listEndpoints(String parent)
public final AgentRegistryClient.ListEndpointsPagedResponse listEndpoints(String parent)Lists Endpoints in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Endpoint element : agentRegistryClient.listEndpoints(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The project and location to list endpoints in. Expected format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListEndpointsPagedResponse |
|
listEndpointsCallable()
public final UnaryCallable<ListEndpointsRequest,ListEndpointsResponse> listEndpointsCallable()Lists Endpoints in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListEndpointsResponse response = agentRegistryClient.listEndpointsCallable().call(request);
for (Endpoint element : response.getEndpointsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListEndpointsRequest,ListEndpointsResponse> |
|
listEndpointsPagedCallable()
public final UnaryCallable<ListEndpointsRequest,AgentRegistryClient.ListEndpointsPagedResponse> listEndpointsPagedCallable()Lists Endpoints in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListEndpointsRequest request =
ListEndpointsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<Endpoint> future =
agentRegistryClient.listEndpointsPagedCallable().futureCall(request);
// Do something.
for (Endpoint element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListEndpointsRequest,ListEndpointsPagedResponse> |
|
listLocations(ListLocationsRequest request)
public final AgentRegistryClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)Lists information about the supported locations for this service.
This method lists locations based on the resource scope provided inthe
ListLocationsRequest.name field:
***Global locations**: If name is empty, the method lists thepublic
locations available to all projects. * **Project-specificlocations**: If
name follows the formatprojects/{project}, the method lists locations visible to
thatspecific project. This includes public, private, or otherproject-specific locations enabled
for the project.
For gRPC and client library implementations, the resource name ispassed as the name field.
For direct service calls, the resourcename isincorporated into the request path based on the
specific serviceimplementation and version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : agentRegistryClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.ListLocationsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListLocationsPagedResponse |
|
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()Lists information about the supported locations for this service.
This method lists locations based on the resource scope provided inthe
ListLocationsRequest.name field:
***Global locations**: If name is empty, the method lists thepublic
locations available to all projects. * **Project-specificlocations**: If
name follows the formatprojects/{project}, the method lists locations visible to
thatspecific project. This includes public, private, or otherproject-specific locations enabled
for the project.
For gRPC and client library implementations, the resource name ispassed as the name field.
For direct service calls, the resourcename isincorporated into the request path based on the
specific serviceimplementation and version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = agentRegistryClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
|
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,AgentRegistryClient.ListLocationsPagedResponse> listLocationsPagedCallable()Lists information about the supported locations for this service.
This method lists locations based on the resource scope provided inthe
ListLocationsRequest.name field:
***Global locations**: If name is empty, the method lists thepublic
locations available to all projects. * **Project-specificlocations**: If
name follows the formatprojects/{project}, the method lists locations visible to
thatspecific project. This includes public, private, or otherproject-specific locations enabled
for the project.
For gRPC and client library implementations, the resource name ispassed as the name field.
For direct service calls, the resourcename isincorporated into the request path based on the
specific serviceimplementation and version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
agentRegistryClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
|
listMcpServers(@Nullable LocationName parent)
public final AgentRegistryClient.ListMcpServersPagedResponse listMcpServers(@Nullable LocationName parent)Lists McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (McpServer element : agentRegistryClient.listMcpServers(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. Parent value for ListMcpServersRequest. Format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListMcpServersPagedResponse |
|
listMcpServers(ListMcpServersRequest request)
public final AgentRegistryClient.ListMcpServersPagedResponse listMcpServers(ListMcpServersRequest request)Lists McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListMcpServersRequest request =
ListMcpServersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (McpServer element : agentRegistryClient.listMcpServers(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListMcpServersRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListMcpServersPagedResponse |
|
listMcpServers(String parent)
public final AgentRegistryClient.ListMcpServersPagedResponse listMcpServers(String parent)Lists McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (McpServer element : agentRegistryClient.listMcpServers(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Parent value for ListMcpServersRequest. Format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListMcpServersPagedResponse |
|
listMcpServersCallable()
public final UnaryCallable<ListMcpServersRequest,ListMcpServersResponse> listMcpServersCallable()Lists McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListMcpServersRequest request =
ListMcpServersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListMcpServersResponse response =
agentRegistryClient.listMcpServersCallable().call(request);
for (McpServer element : response.getMcpServersList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListMcpServersRequest,ListMcpServersResponse> |
|
listMcpServersPagedCallable()
public final UnaryCallable<ListMcpServersRequest,AgentRegistryClient.ListMcpServersPagedResponse> listMcpServersPagedCallable()Lists McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListMcpServersRequest request =
ListMcpServersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<McpServer> future =
agentRegistryClient.listMcpServersPagedCallable().futureCall(request);
// Do something.
for (McpServer element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListMcpServersRequest,ListMcpServersPagedResponse> |
|
listServices(@Nullable LocationName parent)
public final AgentRegistryClient.ListServicesPagedResponse listServices(@Nullable LocationName parent)Lists Services in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Service element : agentRegistryClient.listServices(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. The project and location to list services in. Expected format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListServicesPagedResponse |
|
listServices(ListServicesRequest request)
public final AgentRegistryClient.ListServicesPagedResponse listServices(ListServicesRequest request)Lists Services in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
for (Service element : agentRegistryClient.listServices(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListServicesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListServicesPagedResponse |
|
listServices(String parent)
public final AgentRegistryClient.ListServicesPagedResponse listServices(String parent)Lists Services in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Service element : agentRegistryClient.listServices(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The project and location to list services in. Expected format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.ListServicesPagedResponse |
|
listServicesCallable()
public final UnaryCallable<ListServicesRequest,ListServicesResponse> listServicesCallable()Lists Services in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
while (true) {
ListServicesResponse response = agentRegistryClient.listServicesCallable().call(request);
for (Service element : response.getServicesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListServicesRequest,ListServicesResponse> |
|
listServicesPagedCallable()
public final UnaryCallable<ListServicesRequest,AgentRegistryClient.ListServicesPagedResponse> listServicesPagedCallable()Lists Services in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.build();
ApiFuture<Service> future =
agentRegistryClient.listServicesPagedCallable().futureCall(request);
// Do something.
for (Service element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListServicesRequest,ListServicesPagedResponse> |
|
searchAgents(@Nullable LocationName parent)
public final AgentRegistryClient.SearchAgentsPagedResponse searchAgents(@Nullable LocationName parent)Searches Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Agent element : agentRegistryClient.searchAgents(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. Parent value for SearchAgentsRequest. Format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.SearchAgentsPagedResponse |
|
searchAgents(SearchAgentsRequest request)
public final AgentRegistryClient.SearchAgentsPagedResponse searchAgents(SearchAgentsRequest request)Searches Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
SearchAgentsRequest request =
SearchAgentsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSearchString("searchString120312793")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Agent element : agentRegistryClient.searchAgents(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
SearchAgentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.SearchAgentsPagedResponse |
|
searchAgents(String parent)
public final AgentRegistryClient.SearchAgentsPagedResponse searchAgents(String parent)Searches Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Agent element : agentRegistryClient.searchAgents(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Parent value for SearchAgentsRequest. Format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.SearchAgentsPagedResponse |
|
searchAgentsCallable()
public final UnaryCallable<SearchAgentsRequest,SearchAgentsResponse> searchAgentsCallable()Searches Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
SearchAgentsRequest request =
SearchAgentsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSearchString("searchString120312793")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
SearchAgentsResponse response = agentRegistryClient.searchAgentsCallable().call(request);
for (Agent element : response.getAgentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<SearchAgentsRequest,SearchAgentsResponse> |
|
searchAgentsPagedCallable()
public final UnaryCallable<SearchAgentsRequest,AgentRegistryClient.SearchAgentsPagedResponse> searchAgentsPagedCallable()Searches Agents in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
SearchAgentsRequest request =
SearchAgentsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSearchString("searchString120312793")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Agent> future = agentRegistryClient.searchAgentsPagedCallable().futureCall(request);
// Do something.
for (Agent element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<SearchAgentsRequest,SearchAgentsPagedResponse> |
|
searchMcpServers(@Nullable LocationName parent)
public final AgentRegistryClient.SearchMcpServersPagedResponse searchMcpServers(@Nullable LocationName parent)Searches McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (McpServer element : agentRegistryClient.searchMcpServers(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.agentregistry.v1.LocationNameRequired. Parent value for SearchMcpServersRequest. Format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.SearchMcpServersPagedResponse |
|
searchMcpServers(SearchMcpServersRequest request)
public final AgentRegistryClient.SearchMcpServersPagedResponse searchMcpServers(SearchMcpServersRequest request)Searches McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
SearchMcpServersRequest request =
SearchMcpServersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSearchString("searchString120312793")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (McpServer element : agentRegistryClient.searchMcpServers(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
SearchMcpServersRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.SearchMcpServersPagedResponse |
|
searchMcpServers(String parent)
public final AgentRegistryClient.SearchMcpServersPagedResponse searchMcpServers(String parent)Searches McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (McpServer element : agentRegistryClient.searchMcpServers(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Parent value for SearchMcpServersRequest. Format:
|
| Returns | |
|---|---|
| Type | Description |
AgentRegistryClient.SearchMcpServersPagedResponse |
|
searchMcpServersCallable()
public final UnaryCallable<SearchMcpServersRequest,SearchMcpServersResponse> searchMcpServersCallable()Searches McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
SearchMcpServersRequest request =
SearchMcpServersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSearchString("searchString120312793")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
SearchMcpServersResponse response =
agentRegistryClient.searchMcpServersCallable().call(request);
for (McpServer element : response.getMcpServersList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<SearchMcpServersRequest,SearchMcpServersResponse> |
|
searchMcpServersPagedCallable()
public final UnaryCallable<SearchMcpServersRequest,AgentRegistryClient.SearchMcpServersPagedResponse> searchMcpServersPagedCallable()Searches McpServers in a given project and location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
SearchMcpServersRequest request =
SearchMcpServersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSearchString("searchString120312793")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<McpServer> future =
agentRegistryClient.searchMcpServersPagedCallable().futureCall(request);
// Do something.
for (McpServer element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<SearchMcpServersRequest,SearchMcpServersPagedResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()updateBindingAsync(Binding binding, FieldMask updateMask)
public final OperationFuture<Binding,OperationMetadata> updateBindingAsync(Binding binding, FieldMask updateMask)Updates the parameters of a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
Binding binding = Binding.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Binding response = agentRegistryClient.updateBindingAsync(binding, updateMask).get();
}
| Parameters | |
|---|---|
| Name | Description |
binding |
BindingRequired. The Binding resource that is being updated. |
updateMask |
FieldMaskOptional. 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. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Binding,OperationMetadata> |
|
updateBindingAsync(UpdateBindingRequest request)
public final OperationFuture<Binding,OperationMetadata> updateBindingAsync(UpdateBindingRequest request)Updates the parameters of a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
UpdateBindingRequest request =
UpdateBindingRequest.newBuilder()
.setBinding(Binding.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Binding response = agentRegistryClient.updateBindingAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateBindingRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Binding,OperationMetadata> |
|
updateBindingCallable()
public final UnaryCallable<UpdateBindingRequest,Operation> updateBindingCallable()Updates the parameters of a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
UpdateBindingRequest request =
UpdateBindingRequest.newBuilder()
.setBinding(Binding.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = agentRegistryClient.updateBindingCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateBindingRequest,Operation> |
|
updateBindingOperationCallable()
public final OperationCallable<UpdateBindingRequest,Binding,OperationMetadata> updateBindingOperationCallable()Updates the parameters of a single Binding.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
UpdateBindingRequest request =
UpdateBindingRequest.newBuilder()
.setBinding(Binding.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Binding, OperationMetadata> future =
agentRegistryClient.updateBindingOperationCallable().futureCall(request);
// Do something.
Binding response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<UpdateBindingRequest,Binding,OperationMetadata> |
|
updateServiceAsync(Service service, FieldMask updateMask)
public final OperationFuture<Service,OperationMetadata> updateServiceAsync(Service service, FieldMask updateMask)Updates the parameters of a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
Service service = Service.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Service response = agentRegistryClient.updateServiceAsync(service, updateMask).get();
}
| Parameters | |
|---|---|
| Name | Description |
service |
ServiceRequired. The Service resource that is being updated. Format:
|
updateMask |
FieldMaskOptional. 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. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Service,OperationMetadata> |
|
updateServiceAsync(UpdateServiceRequest request)
public final OperationFuture<Service,OperationMetadata> updateServiceAsync(UpdateServiceRequest request)Updates the parameters of a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
UpdateServiceRequest request =
UpdateServiceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Service response = agentRegistryClient.updateServiceAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateServiceRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Service,OperationMetadata> |
|
updateServiceCallable()
public final UnaryCallable<UpdateServiceRequest,Operation> updateServiceCallable()Updates the parameters of a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
UpdateServiceRequest request =
UpdateServiceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = agentRegistryClient.updateServiceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateServiceRequest,Operation> |
|
updateServiceOperationCallable()
public final OperationCallable<UpdateServiceRequest,Service,OperationMetadata> updateServiceOperationCallable()Updates the parameters of a single Service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AgentRegistryClient agentRegistryClient = AgentRegistryClient.create()) {
UpdateServiceRequest request =
UpdateServiceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Service, OperationMetadata> future =
agentRegistryClient.updateServiceOperationCallable().futureCall(request);
// Do something.
Service response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<UpdateServiceRequest,Service,OperationMetadata> |
|