AgentRegistryAsyncClient(
*,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
transport: typing.Optional[
typing.Union[
str,
google.cloud.agentregistry_v1.services.agent_registry.transports.base.AgentRegistryTransport,
typing.Callable[
[...],
google.cloud.agentregistry_v1.services.agent_registry.transports.base.AgentRegistryTransport,
],
]
] = "grpc_asyncio",
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)Service for managing Agents, Endpoints, McpServers, Services, and Bindings.
Properties
api_endpoint
Return the API endpoint used by the client instance.
| Returns | |
|---|---|
| Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
AgentRegistryTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
| Returns | |
|---|---|
| Type | Description |
str |
The universe domain used by the client instance. |
Methods
AgentRegistryAsyncClient
AgentRegistryAsyncClient(
*,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
transport: typing.Optional[
typing.Union[
str,
google.cloud.agentregistry_v1.services.agent_registry.transports.base.AgentRegistryTransport,
typing.Callable[
[...],
google.cloud.agentregistry_v1.services.agent_registry.transports.base.AgentRegistryTransport,
],
]
] = "grpc_asyncio",
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)Instantiates the agent registry async client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Optional[Union[str,AgentRegistryTransport,Callable[..., AgentRegistryTransport]]]
The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the AgentRegistryTransport constructor. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTlsChannelError |
If mutual TLS transport creation failed for any reason. |
agent_path
agent_path(project: str, location: str, agent: str) -> strReturns a fully-qualified agent string.
binding_path
binding_path(project: str, location: str, binding: str) -> strReturns a fully-qualified binding string.
cancel_operation
cancel_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> NoneStarts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success
is not guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
create_binding
create_binding(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.CreateBindingRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
binding: typing.Optional[
google.cloud.agentregistry_v1.types.binding.Binding
] = None,
binding_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates a new Binding in a given project and location.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_create_binding():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
binding = agentregistry_v1.Binding()
binding.auth_provider_binding.auth_provider = "auth_provider_value"
binding.name = "name_value"
binding.source.identifier = "identifier_value"
binding.target.identifier = "identifier_value"
request = agentregistry_v1.CreateBindingRequest(
parent="parent_value",
binding_id="binding_id_value",
binding=binding,
)
# Make the request
operation = await client.create_binding(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.CreateBindingRequest, dict]]
The request object. Message for creating a Binding |
parent |
Required. The project and location to create the Binding in. Expected format: |
binding |
Binding
Required. The Binding resource that is being created. This corresponds to the |
binding_id |
Required. 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 |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Binding Represents a user-defined Binding. |
create_service
create_service(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.CreateServiceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
service: typing.Optional[
google.cloud.agentregistry_v1.types.service.Service
] = None,
service_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationCreates a new Service in a given project and location.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_create_service():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
service = agentregistry_v1.Service()
service.agent_spec.type_ = "A2A_AGENT_CARD"
request = agentregistry_v1.CreateServiceRequest(
parent="parent_value",
service_id="service_id_value",
service=service,
)
# Make the request
operation = await client.create_service(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.CreateServiceRequest, dict]]
The request object. Message for creating a Service |
parent |
Required. The project and location to create the Service in. Expected format: |
service |
Service
Required. The Service resource that is being created. Format: |
service_id |
Required. 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 |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Service Represents a user-defined Service. |
delete_binding
delete_binding(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.DeleteBindingRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationDeletes a single Binding.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_delete_binding():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.DeleteBindingRequest(
name="name_value",
)
# Make the request
operation = await client.delete_binding(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.DeleteBindingRequest, dict]]
The request object. Message for deleting a Binding |
name |
Required. The name of the Binding. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_operation
delete_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> NoneDeletes a long-running operation.
This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation.
If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
delete_service
delete_service(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.DeleteServiceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationDeletes a single Service.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_delete_service():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.DeleteServiceRequest(
name="name_value",
)
# Make the request
operation = await client.delete_service(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.DeleteServiceRequest, dict]]
The request object. Message for deleting a Service |
name |
Required. The name of the Service. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
endpoint_path
endpoint_path(project: str, location: str, endpoint: str) -> strReturns a fully-qualified endpoint string.
fetch_available_bindings
fetch_available_bindings(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.FetchAvailableBindingsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.agentregistry_v1.services.agent_registry.pagers.FetchAvailableBindingsAsyncPager
)Fetches available Bindings.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_fetch_available_bindings():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.FetchAvailableBindingsRequest(
source_identifier="source_identifier_value",
target_identifier="target_identifier_value",
parent="parent_value",
)
# Make the request
page_result = client.fetch_available_bindings(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.FetchAvailableBindingsRequest, dict]]
The request object. Message for fetching available Bindings. |
parent |
Required. The parent, in the format |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.services.agent_registry.pagers.FetchAvailableBindingsAsyncPager |
Message for response to fetching available Bindings. Iterating over this object will yield results and resolve additional pages automatically. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryAsyncClient |
The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryAsyncClient |
The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
AgentRegistryAsyncClient |
The constructed client. |
get_agent
get_agent(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.GetAgentRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.agentregistry_v1.types.agent.AgentGets details of a single Agent.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_get_agent():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.GetAgentRequest(
name="name_value",
)
# Make the request
response = await client.get_agent(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.GetAgentRequest, dict]]
The request object. Message for getting a Agent |
name |
Required. Name of the resource This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.types.Agent |
Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol. |
get_binding
get_binding(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.GetBindingRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.agentregistry_v1.types.binding.BindingGets details of a single Binding.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_get_binding():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.GetBindingRequest(
name="name_value",
)
# Make the request
response = await client.get_binding(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.GetBindingRequest, dict]]
The request object. Message for getting a Binding |
name |
Required. The name of the Binding. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.types.Binding |
Represents a user-defined Binding. |
get_endpoint
get_endpoint(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.GetEndpointRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.agentregistry_v1.types.endpoint.EndpointGets details of a single 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_get_endpoint():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.GetEndpointRequest(
name="name_value",
)
# Make the request
response = await client.get_endpoint(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.GetEndpointRequest, dict]]
The request object. Message for getting a Endpoint |
name |
Required. The name of the endpoint to retrieve. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.types.Endpoint |
Represents an Endpoint. |
get_location
get_location(
request: typing.Optional[
typing.Union[google.cloud.location.locations_pb2.GetLocationRequest, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.LocationGets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
|
Location object. |
get_mcp_server
get_mcp_server(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.GetMcpServerRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.agentregistry_v1.types.mcp_server.McpServerGets details of a single McpServer.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_get_mcp_server():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.GetMcpServerRequest(
name="name_value",
)
# Make the request
response = await client.get_mcp_server(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.GetMcpServerRequest, dict]]
The request object. Message for getting a McpServer |
name |
Required. Name of the resource This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.types.McpServer |
Represents an MCP (Model Context Protocol) Server. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
| Returns | |
|---|---|
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
get_operation
get_operation(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.GetOperationRequest, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.OperationGets the latest state of a long-running operation.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
|
An Operation object. |
get_service
get_service(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.GetServiceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.agentregistry_v1.types.service.ServiceGets details of a single Service.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_get_service():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.GetServiceRequest(
name="name_value",
)
# Make the request
response = await client.get_service(request=request)
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.GetServiceRequest, dict]]
The request object. Message for getting a Service |
name |
Required. The name of the Service. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.types.Service |
Represents a user-defined Service. |
get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.agentregistry_v1.services.agent_registry.transports.base.AgentRegistryTransport
]Returns an appropriate transport class.
| Parameter | |
|---|---|
| Name | Description |
label |
typing.Optional[str]
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
list_agents
list_agents(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.ListAgentsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.agentregistry_v1.services.agent_registry.pagers.ListAgentsAsyncPagerLists Agents in a given project and location.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_list_agents():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.ListAgentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_agents(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.ListAgentsRequest, dict]]
The request object. Message for requesting list of Agents |
parent |
Required. Parent value for ListAgentsRequest This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.services.agent_registry.pagers.ListAgentsAsyncPager |
Message for response to listing Agents Iterating over this object will yield results and resolve additional pages automatically. |
list_bindings
list_bindings(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.ListBindingsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.agentregistry_v1.services.agent_registry.pagers.ListBindingsAsyncPager
)Lists Bindings in a given project and location.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_list_bindings():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.ListBindingsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_bindings(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.ListBindingsRequest, dict]]
The request object. Message for requesting a list of Bindings. |
parent |
Required. The project and location to list bindings in. Expected format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.services.agent_registry.pagers.ListBindingsAsyncPager |
Message for response to listing Bindings Iterating over this object will yield results and resolve additional pages automatically. |
list_endpoints
list_endpoints(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.ListEndpointsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.agentregistry_v1.services.agent_registry.pagers.ListEndpointsAsyncPager
)Lists Endpoints in a given project and location.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_list_endpoints():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.ListEndpointsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_endpoints(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.ListEndpointsRequest, dict]]
The request object. Message for requesting list of Endpoints |
parent |
Required. The project and location to list endpoints in. Expected format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.services.agent_registry.pagers.ListEndpointsAsyncPager |
Message for response to listing Endpoints Iterating over this object will yield results and resolve additional pages automatically. |
list_locations
list_locations(
request: typing.Optional[
typing.Union[google.cloud.location.locations_pb2.ListLocationsRequest, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponseLists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
|
Response message for ListLocations method. |
list_mcp_servers
list_mcp_servers(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.ListMcpServersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.agentregistry_v1.services.agent_registry.pagers.ListMcpServersAsyncPager
)Lists McpServers in a given project and location.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_list_mcp_servers():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.ListMcpServersRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_mcp_servers(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.ListMcpServersRequest, dict]]
The request object. Message for requesting list of McpServers |
parent |
Required. Parent value for ListMcpServersRequest. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.services.agent_registry.pagers.ListMcpServersAsyncPager |
Message for response to listing McpServers Iterating over this object will yield results and resolve additional pages automatically. |
list_operations
list_operations(
request: typing.Optional[
typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponseLists operations that match the specified filter in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
|
Response message for ListOperations method. |
list_services
list_services(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.ListServicesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.agentregistry_v1.services.agent_registry.pagers.ListServicesAsyncPager
)Lists Services in a given project and location.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_list_services():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.ListServicesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_services(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.ListServicesRequest, dict]]
The request object. Message for requesting list of Services |
parent |
Required. The project and location to list services in. Expected format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.services.agent_registry.pagers.ListServicesAsyncPager |
Message for response to listing Services Iterating over this object will yield results and resolve additional pages automatically. |
mcp_server_path
mcp_server_path(project: str, location: str, mcp_server: str) -> strReturns a fully-qualified mcp_server string.
parse_agent_path
parse_agent_path(path: str) -> typing.Dict[str, str]Parses a agent path into its component segments.
parse_binding_path
parse_binding_path(path: str) -> typing.Dict[str, str]Parses a binding path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
parse_endpoint_path
parse_endpoint_path(path: str) -> typing.Dict[str, str]Parses a endpoint path into its component segments.
parse_mcp_server_path
parse_mcp_server_path(path: str) -> typing.Dict[str, str]Parses a mcp_server path into its component segments.
parse_service_path
parse_service_path(path: str) -> typing.Dict[str, str]Parses a service path into its component segments.
search_agents
search_agents(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.SearchAgentsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.agentregistry_v1.services.agent_registry.pagers.SearchAgentsAsyncPager
)Searches Agents in a given project and location.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_search_agents():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.SearchAgentsRequest(
parent="parent_value",
)
# Make the request
page_result = client.search_agents(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.SearchAgentsRequest, dict]]
The request object. Message for searching Agents |
parent |
Required. Parent value for SearchAgentsRequest. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.services.agent_registry.pagers.SearchAgentsAsyncPager |
Message for response to searching Agents Iterating over this object will yield results and resolve additional pages automatically. |
search_mcp_servers
search_mcp_servers(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.SearchMcpServersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.agentregistry_v1.services.agent_registry.pagers.SearchMcpServersAsyncPager
)Searches McpServers in a given project and location.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_search_mcp_servers():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
request = agentregistry_v1.SearchMcpServersRequest(
parent="parent_value",
)
# Make the request
page_result = client.search_mcp_servers(request=request)
# Handle the response
async for response in page_result:
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.SearchMcpServersRequest, dict]]
The request object. Message for searching MCP Servers |
parent |
Required. Parent value for SearchMcpServersRequest. Format: |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.cloud.agentregistry_v1.services.agent_registry.pagers.SearchMcpServersAsyncPager |
Message for response to searching MCP Servers Iterating over this object will yield results and resolve additional pages automatically. |
service_path
service_path(project: str, location: str, service: str) -> strReturns a fully-qualified service string.
update_binding
update_binding(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.UpdateBindingRequest,
dict,
]
] = None,
*,
binding: typing.Optional[
google.cloud.agentregistry_v1.types.binding.Binding
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates the parameters of a single Binding.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_update_binding():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
binding = agentregistry_v1.Binding()
binding.auth_provider_binding.auth_provider = "auth_provider_value"
binding.name = "name_value"
binding.source.identifier = "identifier_value"
binding.target.identifier = "identifier_value"
request = agentregistry_v1.UpdateBindingRequest(
binding=binding,
)
# Make the request
operation = await client.update_binding(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.UpdateBindingRequest, dict]]
The request object. Message for updating a Binding |
binding |
Binding
Required. The Binding resource that is being updated. This corresponds to the |
update_mask |
Optional. Field mask is used to specify the fields to be overwritten in the Binding resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Binding Represents a user-defined Binding. |
update_service
update_service(
request: typing.Optional[
typing.Union[
google.cloud.agentregistry_v1.types.agentregistry_service.UpdateServiceRequest,
dict,
]
] = None,
*,
service: typing.Optional[
google.cloud.agentregistry_v1.types.service.Service
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperationUpdates the parameters of a single Service.
# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import agentregistry_v1
async def sample_update_service():
# Create a client
client = agentregistry_v1.AgentRegistryAsyncClient()
# Initialize request argument(s)
service = agentregistry_v1.Service()
service.agent_spec.type_ = "A2A_AGENT_CARD"
request = agentregistry_v1.UpdateServiceRequest(
service=service,
)
# Make the request
operation = await client.update_service(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
| Parameters | |
|---|---|
| Name | Description |
request |
Optional[Union[google.cloud.agentregistry_v1.types.UpdateServiceRequest, dict]]
The request object. Message for updating a Service |
service |
Service
Required. The Service resource that is being updated. Format: |
update_mask |
Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. This corresponds to the |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be Service Represents a user-defined Service. |