@google-cloud/agentregistry 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +108 -0
- package/build/protos/google/cloud/agentregistry/v1/agent.proto +168 -0
- package/build/protos/google/cloud/agentregistry/v1/agentregistry_service.proto +934 -0
- package/build/protos/google/cloud/agentregistry/v1/binding.proto +120 -0
- package/build/protos/google/cloud/agentregistry/v1/endpoint.proto +75 -0
- package/build/protos/google/cloud/agentregistry/v1/mcp_server.proto +120 -0
- package/build/protos/google/cloud/agentregistry/v1/properties.proto +51 -0
- package/build/protos/google/cloud/agentregistry/v1/service.proto +154 -0
- package/build/protos/protos.d.ts +14481 -0
- package/build/protos/protos.js +1 -0
- package/build/protos/protos.json +1 -0
- package/build/src/index.d.ts +11 -0
- package/build/src/index.js +28 -0
- package/build/src/index.js.map +1 -0
- package/build/src/v1/agent_registry_client.d.ts +2041 -0
- package/build/src/v1/agent_registry_client.js +2672 -0
- package/build/src/v1/agent_registry_client.js.map +1 -0
- package/build/src/v1/agent_registry_client_config.json +133 -0
- package/build/src/v1/agent_registry_proto_list.json +9 -0
- package/build/src/v1/gapic_metadata.json +245 -0
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +23 -0
- package/build/src/v1/index.js.map +1 -0
- package/package.json +64 -0
|
@@ -0,0 +1,2041 @@
|
|
|
1
|
+
import type * as gax from 'google-gax';
|
|
2
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
|
|
3
|
+
import { Transform } from 'stream';
|
|
4
|
+
import * as protos from '../../protos/protos';
|
|
5
|
+
/**
|
|
6
|
+
* Service for managing Agents, Endpoints, McpServers, Services, and Bindings.
|
|
7
|
+
* @class
|
|
8
|
+
* @memberof v1
|
|
9
|
+
*/
|
|
10
|
+
export declare class AgentRegistryClient {
|
|
11
|
+
private _terminated;
|
|
12
|
+
private _opts;
|
|
13
|
+
private _providedCustomServicePath;
|
|
14
|
+
private _gaxModule;
|
|
15
|
+
private _gaxGrpc;
|
|
16
|
+
private _protos;
|
|
17
|
+
private _defaults;
|
|
18
|
+
private _universeDomain;
|
|
19
|
+
private _servicePath;
|
|
20
|
+
private _log;
|
|
21
|
+
auth: gax.GoogleAuth;
|
|
22
|
+
descriptors: Descriptors;
|
|
23
|
+
warn: (code: string, message: string, warnType?: string) => void;
|
|
24
|
+
innerApiCalls: {
|
|
25
|
+
[name: string]: Function;
|
|
26
|
+
};
|
|
27
|
+
locationsClient: LocationsClient;
|
|
28
|
+
pathTemplates: {
|
|
29
|
+
[name: string]: gax.PathTemplate;
|
|
30
|
+
};
|
|
31
|
+
operationsClient: gax.OperationsClient;
|
|
32
|
+
agentRegistryStub?: Promise<{
|
|
33
|
+
[name: string]: Function;
|
|
34
|
+
}>;
|
|
35
|
+
/**
|
|
36
|
+
* Construct an instance of AgentRegistryClient.
|
|
37
|
+
*
|
|
38
|
+
* @param {object} [options] - The configuration object.
|
|
39
|
+
* The options accepted by the constructor are described in detail
|
|
40
|
+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
|
|
41
|
+
* The common options are:
|
|
42
|
+
* @param {object} [options.credentials] - Credentials object.
|
|
43
|
+
* @param {string} [options.credentials.client_email]
|
|
44
|
+
* @param {string} [options.credentials.private_key]
|
|
45
|
+
* @param {string} [options.email] - Account email address. Required when
|
|
46
|
+
* using a .pem or .p12 keyFilename.
|
|
47
|
+
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
|
|
48
|
+
* .p12 key downloaded from the Google Developers Console. If you provide
|
|
49
|
+
* a path to a JSON file, the projectId option below is not necessary.
|
|
50
|
+
* NOTE: .pem and .p12 require you to specify options.email as well.
|
|
51
|
+
* @param {number} [options.port] - The port on which to connect to
|
|
52
|
+
* the remote host.
|
|
53
|
+
* @param {string} [options.projectId] - The project ID from the Google
|
|
54
|
+
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
|
55
|
+
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
|
56
|
+
* app is running in an environment which supports
|
|
57
|
+
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
|
|
58
|
+
* your project ID will be detected automatically.
|
|
59
|
+
* @param {string} [options.apiEndpoint] - The domain name of the
|
|
60
|
+
* API remote host.
|
|
61
|
+
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
|
62
|
+
* Follows the structure of {@link gapicConfig}.
|
|
63
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
|
64
|
+
* For more information, please check the
|
|
65
|
+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
|
66
|
+
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
|
67
|
+
* need to avoid loading the default gRPC version and want to use the fallback
|
|
68
|
+
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
|
69
|
+
* ```
|
|
70
|
+
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
|
71
|
+
* const client = new AgentRegistryClient({fallback: true}, gax);
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
|
75
|
+
/**
|
|
76
|
+
* Initialize the client.
|
|
77
|
+
* Performs asynchronous operations (such as authentication) and prepares the client.
|
|
78
|
+
* This function will be called automatically when any class method is called for the
|
|
79
|
+
* first time, but if you need to initialize it before calling an actual method,
|
|
80
|
+
* feel free to call initialize() directly.
|
|
81
|
+
*
|
|
82
|
+
* You can await on this method if you want to make sure the client is initialized.
|
|
83
|
+
*
|
|
84
|
+
* @returns {Promise} A promise that resolves to an authenticated service stub.
|
|
85
|
+
*/
|
|
86
|
+
initialize(): Promise<{
|
|
87
|
+
[name: string]: Function;
|
|
88
|
+
}>;
|
|
89
|
+
/**
|
|
90
|
+
* The DNS address for this API service.
|
|
91
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
|
92
|
+
* @returns {string} The DNS address for this service.
|
|
93
|
+
*/
|
|
94
|
+
static get servicePath(): string;
|
|
95
|
+
/**
|
|
96
|
+
* The DNS address for this API service - same as servicePath.
|
|
97
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
|
98
|
+
* @returns {string} The DNS address for this service.
|
|
99
|
+
*/
|
|
100
|
+
static get apiEndpoint(): string;
|
|
101
|
+
/**
|
|
102
|
+
* The DNS address for this API service.
|
|
103
|
+
* @returns {string} The DNS address for this service.
|
|
104
|
+
*/
|
|
105
|
+
get apiEndpoint(): string;
|
|
106
|
+
get universeDomain(): string;
|
|
107
|
+
/**
|
|
108
|
+
* The port for this API service.
|
|
109
|
+
* @returns {number} The default port for this service.
|
|
110
|
+
*/
|
|
111
|
+
static get port(): number;
|
|
112
|
+
/**
|
|
113
|
+
* The scopes needed to make gRPC calls for every method defined
|
|
114
|
+
* in this service.
|
|
115
|
+
* @returns {string[]} List of default scopes.
|
|
116
|
+
*/
|
|
117
|
+
static get scopes(): string[];
|
|
118
|
+
getProjectId(): Promise<string>;
|
|
119
|
+
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
|
120
|
+
/**
|
|
121
|
+
* Gets details of a single Agent.
|
|
122
|
+
*
|
|
123
|
+
* @param {Object} request
|
|
124
|
+
* The request object that will be sent.
|
|
125
|
+
* @param {string} request.name
|
|
126
|
+
* Required. Name of the resource
|
|
127
|
+
* @param {object} [options]
|
|
128
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
129
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
130
|
+
* The first element of the array is an object representing {@link protos.google.cloud.agentregistry.v1.Agent|Agent}.
|
|
131
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
132
|
+
* for more details and examples.
|
|
133
|
+
* @example <caption>include:samples/generated/v1/agent_registry.get_agent.js</caption>
|
|
134
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_GetAgent_async
|
|
135
|
+
*/
|
|
136
|
+
getAgent(request?: protos.google.cloud.agentregistry.v1.IGetAgentRequest, options?: CallOptions): Promise<[
|
|
137
|
+
protos.google.cloud.agentregistry.v1.IAgent,
|
|
138
|
+
protos.google.cloud.agentregistry.v1.IGetAgentRequest | undefined,
|
|
139
|
+
{} | undefined
|
|
140
|
+
]>;
|
|
141
|
+
getAgent(request: protos.google.cloud.agentregistry.v1.IGetAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.agentregistry.v1.IAgent, protos.google.cloud.agentregistry.v1.IGetAgentRequest | null | undefined, {} | null | undefined>): void;
|
|
142
|
+
getAgent(request: protos.google.cloud.agentregistry.v1.IGetAgentRequest, callback: Callback<protos.google.cloud.agentregistry.v1.IAgent, protos.google.cloud.agentregistry.v1.IGetAgentRequest | null | undefined, {} | null | undefined>): void;
|
|
143
|
+
/**
|
|
144
|
+
* Gets details of a single Endpoint.
|
|
145
|
+
*
|
|
146
|
+
* @param {Object} request
|
|
147
|
+
* The request object that will be sent.
|
|
148
|
+
* @param {string} request.name
|
|
149
|
+
* Required. The name of the endpoint to retrieve.
|
|
150
|
+
* Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
|
|
151
|
+
* @param {object} [options]
|
|
152
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
153
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
154
|
+
* The first element of the array is an object representing {@link protos.google.cloud.agentregistry.v1.Endpoint|Endpoint}.
|
|
155
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
156
|
+
* for more details and examples.
|
|
157
|
+
* @example <caption>include:samples/generated/v1/agent_registry.get_endpoint.js</caption>
|
|
158
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_GetEndpoint_async
|
|
159
|
+
*/
|
|
160
|
+
getEndpoint(request?: protos.google.cloud.agentregistry.v1.IGetEndpointRequest, options?: CallOptions): Promise<[
|
|
161
|
+
protos.google.cloud.agentregistry.v1.IEndpoint,
|
|
162
|
+
protos.google.cloud.agentregistry.v1.IGetEndpointRequest | undefined,
|
|
163
|
+
{} | undefined
|
|
164
|
+
]>;
|
|
165
|
+
getEndpoint(request: protos.google.cloud.agentregistry.v1.IGetEndpointRequest, options: CallOptions, callback: Callback<protos.google.cloud.agentregistry.v1.IEndpoint, protos.google.cloud.agentregistry.v1.IGetEndpointRequest | null | undefined, {} | null | undefined>): void;
|
|
166
|
+
getEndpoint(request: protos.google.cloud.agentregistry.v1.IGetEndpointRequest, callback: Callback<protos.google.cloud.agentregistry.v1.IEndpoint, protos.google.cloud.agentregistry.v1.IGetEndpointRequest | null | undefined, {} | null | undefined>): void;
|
|
167
|
+
/**
|
|
168
|
+
* Gets details of a single McpServer.
|
|
169
|
+
*
|
|
170
|
+
* @param {Object} request
|
|
171
|
+
* The request object that will be sent.
|
|
172
|
+
* @param {string} request.name
|
|
173
|
+
* Required. Name of the resource
|
|
174
|
+
* @param {object} [options]
|
|
175
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
176
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
177
|
+
* The first element of the array is an object representing {@link protos.google.cloud.agentregistry.v1.McpServer|McpServer}.
|
|
178
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
179
|
+
* for more details and examples.
|
|
180
|
+
* @example <caption>include:samples/generated/v1/agent_registry.get_mcp_server.js</caption>
|
|
181
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_GetMcpServer_async
|
|
182
|
+
*/
|
|
183
|
+
getMcpServer(request?: protos.google.cloud.agentregistry.v1.IGetMcpServerRequest, options?: CallOptions): Promise<[
|
|
184
|
+
protos.google.cloud.agentregistry.v1.IMcpServer,
|
|
185
|
+
protos.google.cloud.agentregistry.v1.IGetMcpServerRequest | undefined,
|
|
186
|
+
{} | undefined
|
|
187
|
+
]>;
|
|
188
|
+
getMcpServer(request: protos.google.cloud.agentregistry.v1.IGetMcpServerRequest, options: CallOptions, callback: Callback<protos.google.cloud.agentregistry.v1.IMcpServer, protos.google.cloud.agentregistry.v1.IGetMcpServerRequest | null | undefined, {} | null | undefined>): void;
|
|
189
|
+
getMcpServer(request: protos.google.cloud.agentregistry.v1.IGetMcpServerRequest, callback: Callback<protos.google.cloud.agentregistry.v1.IMcpServer, protos.google.cloud.agentregistry.v1.IGetMcpServerRequest | null | undefined, {} | null | undefined>): void;
|
|
190
|
+
/**
|
|
191
|
+
* Gets details of a single Service.
|
|
192
|
+
*
|
|
193
|
+
* @param {Object} request
|
|
194
|
+
* The request object that will be sent.
|
|
195
|
+
* @param {string} request.name
|
|
196
|
+
* Required. The name of the Service.
|
|
197
|
+
* Format: `projects/{project}/locations/{location}/services/{service}`.
|
|
198
|
+
* @param {object} [options]
|
|
199
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
200
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
201
|
+
* The first element of the array is an object representing {@link protos.google.cloud.agentregistry.v1.Service|Service}.
|
|
202
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
203
|
+
* for more details and examples.
|
|
204
|
+
* @example <caption>include:samples/generated/v1/agent_registry.get_service.js</caption>
|
|
205
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_GetService_async
|
|
206
|
+
*/
|
|
207
|
+
getService(request?: protos.google.cloud.agentregistry.v1.IGetServiceRequest, options?: CallOptions): Promise<[
|
|
208
|
+
protos.google.cloud.agentregistry.v1.IService,
|
|
209
|
+
protos.google.cloud.agentregistry.v1.IGetServiceRequest | undefined,
|
|
210
|
+
{} | undefined
|
|
211
|
+
]>;
|
|
212
|
+
getService(request: protos.google.cloud.agentregistry.v1.IGetServiceRequest, options: CallOptions, callback: Callback<protos.google.cloud.agentregistry.v1.IService, protos.google.cloud.agentregistry.v1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
|
|
213
|
+
getService(request: protos.google.cloud.agentregistry.v1.IGetServiceRequest, callback: Callback<protos.google.cloud.agentregistry.v1.IService, protos.google.cloud.agentregistry.v1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;
|
|
214
|
+
/**
|
|
215
|
+
* Gets details of a single Binding.
|
|
216
|
+
*
|
|
217
|
+
* @param {Object} request
|
|
218
|
+
* The request object that will be sent.
|
|
219
|
+
* @param {string} request.name
|
|
220
|
+
* Required. The name of the Binding.
|
|
221
|
+
* Format: `projects/{project}/locations/{location}/bindings/{binding}`.
|
|
222
|
+
* @param {object} [options]
|
|
223
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
224
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
225
|
+
* The first element of the array is an object representing {@link protos.google.cloud.agentregistry.v1.Binding|Binding}.
|
|
226
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
227
|
+
* for more details and examples.
|
|
228
|
+
* @example <caption>include:samples/generated/v1/agent_registry.get_binding.js</caption>
|
|
229
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_GetBinding_async
|
|
230
|
+
*/
|
|
231
|
+
getBinding(request?: protos.google.cloud.agentregistry.v1.IGetBindingRequest, options?: CallOptions): Promise<[
|
|
232
|
+
protos.google.cloud.agentregistry.v1.IBinding,
|
|
233
|
+
protos.google.cloud.agentregistry.v1.IGetBindingRequest | undefined,
|
|
234
|
+
{} | undefined
|
|
235
|
+
]>;
|
|
236
|
+
getBinding(request: protos.google.cloud.agentregistry.v1.IGetBindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.agentregistry.v1.IBinding, protos.google.cloud.agentregistry.v1.IGetBindingRequest | null | undefined, {} | null | undefined>): void;
|
|
237
|
+
getBinding(request: protos.google.cloud.agentregistry.v1.IGetBindingRequest, callback: Callback<protos.google.cloud.agentregistry.v1.IBinding, protos.google.cloud.agentregistry.v1.IGetBindingRequest | null | undefined, {} | null | undefined>): void;
|
|
238
|
+
/**
|
|
239
|
+
* Creates a new Service in a given project and location.
|
|
240
|
+
*
|
|
241
|
+
* @param {Object} request
|
|
242
|
+
* The request object that will be sent.
|
|
243
|
+
* @param {string} request.parent
|
|
244
|
+
* Required. The project and location to create the Service in.
|
|
245
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
246
|
+
* @param {string} request.serviceId
|
|
247
|
+
* Required. The ID to use for the service, which will become the final
|
|
248
|
+
* component of the service's resource name.
|
|
249
|
+
*
|
|
250
|
+
* This value should be 4-63 characters, and valid characters
|
|
251
|
+
* are `/{@link protos.0-9|a-z}-/`.
|
|
252
|
+
* @param {google.cloud.agentregistry.v1.Service} request.service
|
|
253
|
+
* Required. The Service resource that is being created.
|
|
254
|
+
* Format: `projects/{project}/locations/{location}/services/{service}`.
|
|
255
|
+
* @param {string} [request.requestId]
|
|
256
|
+
* Optional. An optional request ID to identify requests. Specify a unique
|
|
257
|
+
* request ID so that if you must retry your request, the server will know to
|
|
258
|
+
* ignore the request if it has already been completed. The server will
|
|
259
|
+
* guarantee that for at least 60 minutes since the first request.
|
|
260
|
+
*
|
|
261
|
+
* For example, consider a situation where you make an initial request and the
|
|
262
|
+
* request times out. If you make the request again with the same request
|
|
263
|
+
* ID, the server can check if original operation with the same request ID
|
|
264
|
+
* was received, and if so, will ignore the second request. This prevents
|
|
265
|
+
* clients from accidentally creating duplicate commitments.
|
|
266
|
+
*
|
|
267
|
+
* The request ID must be a valid UUID with the exception that zero UUID is
|
|
268
|
+
* not supported (00000000-0000-0000-0000-000000000000).
|
|
269
|
+
* @param {object} [options]
|
|
270
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
271
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
272
|
+
* The first element of the array is an object representing
|
|
273
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
274
|
+
* you can `await` for.
|
|
275
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
276
|
+
* for more details and examples.
|
|
277
|
+
* @example <caption>include:samples/generated/v1/agent_registry.create_service.js</caption>
|
|
278
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_CreateService_async
|
|
279
|
+
*/
|
|
280
|
+
createService(request?: protos.google.cloud.agentregistry.v1.ICreateServiceRequest, options?: CallOptions): Promise<[
|
|
281
|
+
LROperation<protos.google.cloud.agentregistry.v1.IService, protos.google.cloud.agentregistry.v1.IOperationMetadata>,
|
|
282
|
+
protos.google.longrunning.IOperation | undefined,
|
|
283
|
+
{} | undefined
|
|
284
|
+
]>;
|
|
285
|
+
createService(request: protos.google.cloud.agentregistry.v1.ICreateServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.agentregistry.v1.IService, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
286
|
+
createService(request: protos.google.cloud.agentregistry.v1.ICreateServiceRequest, callback: Callback<LROperation<protos.google.cloud.agentregistry.v1.IService, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
287
|
+
/**
|
|
288
|
+
* Check the status of the long running operation returned by `createService()`.
|
|
289
|
+
* @param {String} name
|
|
290
|
+
* The operation name that will be passed.
|
|
291
|
+
* @returns {Promise} - The promise which resolves to an object.
|
|
292
|
+
* The decoded operation object has result and metadata field to get information from.
|
|
293
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
294
|
+
* for more details and examples.
|
|
295
|
+
* @example <caption>include:samples/generated/v1/agent_registry.create_service.js</caption>
|
|
296
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_CreateService_async
|
|
297
|
+
*/
|
|
298
|
+
checkCreateServiceProgress(name: string): Promise<LROperation<protos.google.cloud.agentregistry.v1.Service, protos.google.cloud.agentregistry.v1.OperationMetadata>>;
|
|
299
|
+
/**
|
|
300
|
+
* Updates the parameters of a single Service.
|
|
301
|
+
*
|
|
302
|
+
* @param {Object} request
|
|
303
|
+
* The request object that will be sent.
|
|
304
|
+
* @param {google.protobuf.FieldMask} [request.updateMask]
|
|
305
|
+
* Optional. Field mask is used to specify the fields to be overwritten in the
|
|
306
|
+
* Service resource by the update.
|
|
307
|
+
* The fields specified in the update_mask are relative to the resource, not
|
|
308
|
+
* the full request. A field will be overwritten if it is in the mask. If the
|
|
309
|
+
* user does not provide a mask then all fields present in the request will be
|
|
310
|
+
* overwritten.
|
|
311
|
+
* @param {google.cloud.agentregistry.v1.Service} request.service
|
|
312
|
+
* Required. The Service resource that is being updated.
|
|
313
|
+
* Format: `projects/{project}/locations/{location}/services/{service}`.
|
|
314
|
+
* @param {string} [request.requestId]
|
|
315
|
+
* Optional. An optional request ID to identify requests. Specify a unique
|
|
316
|
+
* request ID so that if you must retry your request, the server will know to
|
|
317
|
+
* ignore the request if it has already been completed. The server will
|
|
318
|
+
* guarantee that for at least 60 minutes since the first request.
|
|
319
|
+
*
|
|
320
|
+
* For example, consider a situation where you make an initial request and the
|
|
321
|
+
* request times out. If you make the request again with the same request
|
|
322
|
+
* ID, the server can check if original operation with the same request ID
|
|
323
|
+
* was received, and if so, will ignore the second request. This prevents
|
|
324
|
+
* clients from accidentally creating duplicate commitments.
|
|
325
|
+
*
|
|
326
|
+
* The request ID must be a valid UUID with the exception that zero UUID is
|
|
327
|
+
* not supported (00000000-0000-0000-0000-000000000000).
|
|
328
|
+
* @param {object} [options]
|
|
329
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
330
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
331
|
+
* The first element of the array is an object representing
|
|
332
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
333
|
+
* you can `await` for.
|
|
334
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
335
|
+
* for more details and examples.
|
|
336
|
+
* @example <caption>include:samples/generated/v1/agent_registry.update_service.js</caption>
|
|
337
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_UpdateService_async
|
|
338
|
+
*/
|
|
339
|
+
updateService(request?: protos.google.cloud.agentregistry.v1.IUpdateServiceRequest, options?: CallOptions): Promise<[
|
|
340
|
+
LROperation<protos.google.cloud.agentregistry.v1.IService, protos.google.cloud.agentregistry.v1.IOperationMetadata>,
|
|
341
|
+
protos.google.longrunning.IOperation | undefined,
|
|
342
|
+
{} | undefined
|
|
343
|
+
]>;
|
|
344
|
+
updateService(request: protos.google.cloud.agentregistry.v1.IUpdateServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.agentregistry.v1.IService, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
345
|
+
updateService(request: protos.google.cloud.agentregistry.v1.IUpdateServiceRequest, callback: Callback<LROperation<protos.google.cloud.agentregistry.v1.IService, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
346
|
+
/**
|
|
347
|
+
* Check the status of the long running operation returned by `updateService()`.
|
|
348
|
+
* @param {String} name
|
|
349
|
+
* The operation name that will be passed.
|
|
350
|
+
* @returns {Promise} - The promise which resolves to an object.
|
|
351
|
+
* The decoded operation object has result and metadata field to get information from.
|
|
352
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
353
|
+
* for more details and examples.
|
|
354
|
+
* @example <caption>include:samples/generated/v1/agent_registry.update_service.js</caption>
|
|
355
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_UpdateService_async
|
|
356
|
+
*/
|
|
357
|
+
checkUpdateServiceProgress(name: string): Promise<LROperation<protos.google.cloud.agentregistry.v1.Service, protos.google.cloud.agentregistry.v1.OperationMetadata>>;
|
|
358
|
+
/**
|
|
359
|
+
* Deletes a single Service.
|
|
360
|
+
*
|
|
361
|
+
* @param {Object} request
|
|
362
|
+
* The request object that will be sent.
|
|
363
|
+
* @param {string} request.name
|
|
364
|
+
* Required. The name of the Service.
|
|
365
|
+
* Format: `projects/{project}/locations/{location}/services/{service}`.
|
|
366
|
+
* @param {string} [request.requestId]
|
|
367
|
+
* Optional. An optional request ID to identify requests. Specify a unique
|
|
368
|
+
* request ID so that if you must retry your request, the server will know to
|
|
369
|
+
* ignore the request if it has already been completed. The server will
|
|
370
|
+
* guarantee that for at least 60 minutes after the first request.
|
|
371
|
+
*
|
|
372
|
+
* For example, consider a situation where you make an initial request and the
|
|
373
|
+
* request times out. If you make the request again with the same request
|
|
374
|
+
* ID, the server can check if original operation with the same request ID
|
|
375
|
+
* was received, and if so, will ignore the second request. This prevents
|
|
376
|
+
* clients from accidentally creating duplicate commitments.
|
|
377
|
+
*
|
|
378
|
+
* The request ID must be a valid UUID with the exception that zero UUID is
|
|
379
|
+
* not supported (00000000-0000-0000-0000-000000000000).
|
|
380
|
+
* @param {object} [options]
|
|
381
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
382
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
383
|
+
* The first element of the array is an object representing
|
|
384
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
385
|
+
* you can `await` for.
|
|
386
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
387
|
+
* for more details and examples.
|
|
388
|
+
* @example <caption>include:samples/generated/v1/agent_registry.delete_service.js</caption>
|
|
389
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_DeleteService_async
|
|
390
|
+
*/
|
|
391
|
+
deleteService(request?: protos.google.cloud.agentregistry.v1.IDeleteServiceRequest, options?: CallOptions): Promise<[
|
|
392
|
+
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.agentregistry.v1.IOperationMetadata>,
|
|
393
|
+
protos.google.longrunning.IOperation | undefined,
|
|
394
|
+
{} | undefined
|
|
395
|
+
]>;
|
|
396
|
+
deleteService(request: protos.google.cloud.agentregistry.v1.IDeleteServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
397
|
+
deleteService(request: protos.google.cloud.agentregistry.v1.IDeleteServiceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
398
|
+
/**
|
|
399
|
+
* Check the status of the long running operation returned by `deleteService()`.
|
|
400
|
+
* @param {String} name
|
|
401
|
+
* The operation name that will be passed.
|
|
402
|
+
* @returns {Promise} - The promise which resolves to an object.
|
|
403
|
+
* The decoded operation object has result and metadata field to get information from.
|
|
404
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
405
|
+
* for more details and examples.
|
|
406
|
+
* @example <caption>include:samples/generated/v1/agent_registry.delete_service.js</caption>
|
|
407
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_DeleteService_async
|
|
408
|
+
*/
|
|
409
|
+
checkDeleteServiceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.agentregistry.v1.OperationMetadata>>;
|
|
410
|
+
/**
|
|
411
|
+
* Creates a new Binding in a given project and location.
|
|
412
|
+
*
|
|
413
|
+
* @param {Object} request
|
|
414
|
+
* The request object that will be sent.
|
|
415
|
+
* @param {string} request.parent
|
|
416
|
+
* Required. The project and location to create the Binding in.
|
|
417
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
418
|
+
* @param {string} request.bindingId
|
|
419
|
+
* Required. The ID to use for the binding, which will become the final
|
|
420
|
+
* component of the binding's resource name.
|
|
421
|
+
*
|
|
422
|
+
* This value should be 4-63 characters, and must conform to RFC-1034.
|
|
423
|
+
* Specifically, it must match the regular expression
|
|
424
|
+
* `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
|
|
425
|
+
* @param {google.cloud.agentregistry.v1.Binding} request.binding
|
|
426
|
+
* Required. The Binding resource that is being created.
|
|
427
|
+
* @param {string} [request.requestId]
|
|
428
|
+
* Optional. An optional request ID to identify requests. Specify a unique
|
|
429
|
+
* request ID so that if you must retry your request, the server will know to
|
|
430
|
+
* ignore the request if it has already been completed. The server will
|
|
431
|
+
* guarantee that for at least 60 minutes since the first request.
|
|
432
|
+
*
|
|
433
|
+
* For example, consider a situation where you make an initial request and the
|
|
434
|
+
* request times out. If you make the request again with the same request
|
|
435
|
+
* ID, the server can check if original operation with the same request ID
|
|
436
|
+
* was received, and if so, will ignore the second request. This prevents
|
|
437
|
+
* clients from accidentally creating duplicate commitments.
|
|
438
|
+
*
|
|
439
|
+
* The request ID must be a valid UUID with the exception that zero UUID is
|
|
440
|
+
* not supported (00000000-0000-0000-0000-000000000000).
|
|
441
|
+
* @param {object} [options]
|
|
442
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
443
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
444
|
+
* The first element of the array is an object representing
|
|
445
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
446
|
+
* you can `await` for.
|
|
447
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
448
|
+
* for more details and examples.
|
|
449
|
+
* @example <caption>include:samples/generated/v1/agent_registry.create_binding.js</caption>
|
|
450
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_CreateBinding_async
|
|
451
|
+
*/
|
|
452
|
+
createBinding(request?: protos.google.cloud.agentregistry.v1.ICreateBindingRequest, options?: CallOptions): Promise<[
|
|
453
|
+
LROperation<protos.google.cloud.agentregistry.v1.IBinding, protos.google.cloud.agentregistry.v1.IOperationMetadata>,
|
|
454
|
+
protos.google.longrunning.IOperation | undefined,
|
|
455
|
+
{} | undefined
|
|
456
|
+
]>;
|
|
457
|
+
createBinding(request: protos.google.cloud.agentregistry.v1.ICreateBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.agentregistry.v1.IBinding, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
458
|
+
createBinding(request: protos.google.cloud.agentregistry.v1.ICreateBindingRequest, callback: Callback<LROperation<protos.google.cloud.agentregistry.v1.IBinding, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
459
|
+
/**
|
|
460
|
+
* Check the status of the long running operation returned by `createBinding()`.
|
|
461
|
+
* @param {String} name
|
|
462
|
+
* The operation name that will be passed.
|
|
463
|
+
* @returns {Promise} - The promise which resolves to an object.
|
|
464
|
+
* The decoded operation object has result and metadata field to get information from.
|
|
465
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
466
|
+
* for more details and examples.
|
|
467
|
+
* @example <caption>include:samples/generated/v1/agent_registry.create_binding.js</caption>
|
|
468
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_CreateBinding_async
|
|
469
|
+
*/
|
|
470
|
+
checkCreateBindingProgress(name: string): Promise<LROperation<protos.google.cloud.agentregistry.v1.Binding, protos.google.cloud.agentregistry.v1.OperationMetadata>>;
|
|
471
|
+
/**
|
|
472
|
+
* Updates the parameters of a single Binding.
|
|
473
|
+
*
|
|
474
|
+
* @param {Object} request
|
|
475
|
+
* The request object that will be sent.
|
|
476
|
+
* @param {google.cloud.agentregistry.v1.Binding} request.binding
|
|
477
|
+
* Required. The Binding resource that is being updated.
|
|
478
|
+
* @param {google.protobuf.FieldMask} [request.updateMask]
|
|
479
|
+
* Optional. Field mask is used to specify the fields to be overwritten in the
|
|
480
|
+
* Binding resource by the update.
|
|
481
|
+
* The fields specified in the update_mask are relative to the resource, not
|
|
482
|
+
* the full request. A field will be overwritten if it is in the mask. If the
|
|
483
|
+
* user does not provide a mask then all fields present in the request will be
|
|
484
|
+
* overwritten.
|
|
485
|
+
* @param {string} [request.requestId]
|
|
486
|
+
* Optional. An optional request ID to identify requests. Specify a unique
|
|
487
|
+
* request ID so that if you must retry your request, the server will know to
|
|
488
|
+
* ignore the request if it has already been completed. The server will
|
|
489
|
+
* guarantee that for at least 60 minutes since the first request.
|
|
490
|
+
*
|
|
491
|
+
* For example, consider a situation where you make an initial request and the
|
|
492
|
+
* request times out. If you make the request again with the same request
|
|
493
|
+
* ID, the server can check if original operation with the same request ID
|
|
494
|
+
* was received, and if so, will ignore the second request. This prevents
|
|
495
|
+
* clients from accidentally creating duplicate commitments.
|
|
496
|
+
*
|
|
497
|
+
* The request ID must be a valid UUID with the exception that zero UUID is
|
|
498
|
+
* not supported (00000000-0000-0000-0000-000000000000).
|
|
499
|
+
* @param {object} [options]
|
|
500
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
501
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
502
|
+
* The first element of the array is an object representing
|
|
503
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
504
|
+
* you can `await` for.
|
|
505
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
506
|
+
* for more details and examples.
|
|
507
|
+
* @example <caption>include:samples/generated/v1/agent_registry.update_binding.js</caption>
|
|
508
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_UpdateBinding_async
|
|
509
|
+
*/
|
|
510
|
+
updateBinding(request?: protos.google.cloud.agentregistry.v1.IUpdateBindingRequest, options?: CallOptions): Promise<[
|
|
511
|
+
LROperation<protos.google.cloud.agentregistry.v1.IBinding, protos.google.cloud.agentregistry.v1.IOperationMetadata>,
|
|
512
|
+
protos.google.longrunning.IOperation | undefined,
|
|
513
|
+
{} | undefined
|
|
514
|
+
]>;
|
|
515
|
+
updateBinding(request: protos.google.cloud.agentregistry.v1.IUpdateBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.agentregistry.v1.IBinding, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
516
|
+
updateBinding(request: protos.google.cloud.agentregistry.v1.IUpdateBindingRequest, callback: Callback<LROperation<protos.google.cloud.agentregistry.v1.IBinding, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
517
|
+
/**
|
|
518
|
+
* Check the status of the long running operation returned by `updateBinding()`.
|
|
519
|
+
* @param {String} name
|
|
520
|
+
* The operation name that will be passed.
|
|
521
|
+
* @returns {Promise} - The promise which resolves to an object.
|
|
522
|
+
* The decoded operation object has result and metadata field to get information from.
|
|
523
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
524
|
+
* for more details and examples.
|
|
525
|
+
* @example <caption>include:samples/generated/v1/agent_registry.update_binding.js</caption>
|
|
526
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_UpdateBinding_async
|
|
527
|
+
*/
|
|
528
|
+
checkUpdateBindingProgress(name: string): Promise<LROperation<protos.google.cloud.agentregistry.v1.Binding, protos.google.cloud.agentregistry.v1.OperationMetadata>>;
|
|
529
|
+
/**
|
|
530
|
+
* Deletes a single Binding.
|
|
531
|
+
*
|
|
532
|
+
* @param {Object} request
|
|
533
|
+
* The request object that will be sent.
|
|
534
|
+
* @param {string} request.name
|
|
535
|
+
* Required. The name of the Binding.
|
|
536
|
+
* Format: `projects/{project}/locations/{location}/bindings/{binding}`.
|
|
537
|
+
* @param {string} [request.requestId]
|
|
538
|
+
* Optional. An optional request ID to identify requests. Specify a unique
|
|
539
|
+
* request ID so that if you must retry your request, the server will know to
|
|
540
|
+
* ignore the request if it has already been completed. The server will
|
|
541
|
+
* guarantee that for at least 60 minutes after the first request.
|
|
542
|
+
*
|
|
543
|
+
* For example, consider a situation where you make an initial request and the
|
|
544
|
+
* request times out. If you make the request again with the same request
|
|
545
|
+
* ID, the server can check if original operation with the same request ID
|
|
546
|
+
* was received, and if so, will ignore the second request. This prevents
|
|
547
|
+
* clients from accidentally creating duplicate commitments.
|
|
548
|
+
*
|
|
549
|
+
* The request ID must be a valid UUID with the exception that zero UUID is
|
|
550
|
+
* not supported (00000000-0000-0000-0000-000000000000).
|
|
551
|
+
* @param {object} [options]
|
|
552
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
553
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
554
|
+
* The first element of the array is an object representing
|
|
555
|
+
* a long running operation. Its `promise()` method returns a promise
|
|
556
|
+
* you can `await` for.
|
|
557
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
558
|
+
* for more details and examples.
|
|
559
|
+
* @example <caption>include:samples/generated/v1/agent_registry.delete_binding.js</caption>
|
|
560
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_DeleteBinding_async
|
|
561
|
+
*/
|
|
562
|
+
deleteBinding(request?: protos.google.cloud.agentregistry.v1.IDeleteBindingRequest, options?: CallOptions): Promise<[
|
|
563
|
+
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.agentregistry.v1.IOperationMetadata>,
|
|
564
|
+
protos.google.longrunning.IOperation | undefined,
|
|
565
|
+
{} | undefined
|
|
566
|
+
]>;
|
|
567
|
+
deleteBinding(request: protos.google.cloud.agentregistry.v1.IDeleteBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
568
|
+
deleteBinding(request: protos.google.cloud.agentregistry.v1.IDeleteBindingRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.agentregistry.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
|
569
|
+
/**
|
|
570
|
+
* Check the status of the long running operation returned by `deleteBinding()`.
|
|
571
|
+
* @param {String} name
|
|
572
|
+
* The operation name that will be passed.
|
|
573
|
+
* @returns {Promise} - The promise which resolves to an object.
|
|
574
|
+
* The decoded operation object has result and metadata field to get information from.
|
|
575
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
|
576
|
+
* for more details and examples.
|
|
577
|
+
* @example <caption>include:samples/generated/v1/agent_registry.delete_binding.js</caption>
|
|
578
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_DeleteBinding_async
|
|
579
|
+
*/
|
|
580
|
+
checkDeleteBindingProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.agentregistry.v1.OperationMetadata>>;
|
|
581
|
+
/**
|
|
582
|
+
* Lists Agents in a given project and location.
|
|
583
|
+
*
|
|
584
|
+
* @param {Object} request
|
|
585
|
+
* The request object that will be sent.
|
|
586
|
+
* @param {string} request.parent
|
|
587
|
+
* Required. Parent value for ListAgentsRequest
|
|
588
|
+
* @param {number} [request.pageSize]
|
|
589
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
590
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
591
|
+
* @param {string} [request.pageToken]
|
|
592
|
+
* Optional. A token identifying a page of results the server should return.
|
|
593
|
+
* @param {string} [request.filter]
|
|
594
|
+
* Optional. Filtering results
|
|
595
|
+
* @param {string} [request.orderBy]
|
|
596
|
+
* Optional. Hint for how to order the results
|
|
597
|
+
* @param {object} [options]
|
|
598
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
599
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
600
|
+
* The first element of the array is Array of {@link protos.google.cloud.agentregistry.v1.Agent|Agent}.
|
|
601
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
602
|
+
* times as needed and will merge results from all the pages into this array.
|
|
603
|
+
* Note that it can affect your quota.
|
|
604
|
+
* We recommend using `listAgentsAsync()`
|
|
605
|
+
* method described below for async iteration which you can stop as needed.
|
|
606
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
607
|
+
* for more details and examples.
|
|
608
|
+
*/
|
|
609
|
+
listAgents(request?: protos.google.cloud.agentregistry.v1.IListAgentsRequest, options?: CallOptions): Promise<[
|
|
610
|
+
protos.google.cloud.agentregistry.v1.IAgent[],
|
|
611
|
+
protos.google.cloud.agentregistry.v1.IListAgentsRequest | null,
|
|
612
|
+
protos.google.cloud.agentregistry.v1.IListAgentsResponse
|
|
613
|
+
]>;
|
|
614
|
+
listAgents(request: protos.google.cloud.agentregistry.v1.IListAgentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListAgentsRequest, protos.google.cloud.agentregistry.v1.IListAgentsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IAgent>): void;
|
|
615
|
+
listAgents(request: protos.google.cloud.agentregistry.v1.IListAgentsRequest, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListAgentsRequest, protos.google.cloud.agentregistry.v1.IListAgentsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IAgent>): void;
|
|
616
|
+
/**
|
|
617
|
+
* Equivalent to `listAgents`, but returns a NodeJS Stream object.
|
|
618
|
+
* @param {Object} request
|
|
619
|
+
* The request object that will be sent.
|
|
620
|
+
* @param {string} request.parent
|
|
621
|
+
* Required. Parent value for ListAgentsRequest
|
|
622
|
+
* @param {number} [request.pageSize]
|
|
623
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
624
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
625
|
+
* @param {string} [request.pageToken]
|
|
626
|
+
* Optional. A token identifying a page of results the server should return.
|
|
627
|
+
* @param {string} [request.filter]
|
|
628
|
+
* Optional. Filtering results
|
|
629
|
+
* @param {string} [request.orderBy]
|
|
630
|
+
* Optional. Hint for how to order the results
|
|
631
|
+
* @param {object} [options]
|
|
632
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
633
|
+
* @returns {Stream}
|
|
634
|
+
* An object stream which emits an object representing {@link protos.google.cloud.agentregistry.v1.Agent|Agent} on 'data' event.
|
|
635
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
636
|
+
* times as needed. Note that it can affect your quota.
|
|
637
|
+
* We recommend using `listAgentsAsync()`
|
|
638
|
+
* method described below for async iteration which you can stop as needed.
|
|
639
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
640
|
+
* for more details and examples.
|
|
641
|
+
*/
|
|
642
|
+
listAgentsStream(request?: protos.google.cloud.agentregistry.v1.IListAgentsRequest, options?: CallOptions): Transform;
|
|
643
|
+
/**
|
|
644
|
+
* Equivalent to `listAgents`, but returns an iterable object.
|
|
645
|
+
*
|
|
646
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
647
|
+
* @param {Object} request
|
|
648
|
+
* The request object that will be sent.
|
|
649
|
+
* @param {string} request.parent
|
|
650
|
+
* Required. Parent value for ListAgentsRequest
|
|
651
|
+
* @param {number} [request.pageSize]
|
|
652
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
653
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
654
|
+
* @param {string} [request.pageToken]
|
|
655
|
+
* Optional. A token identifying a page of results the server should return.
|
|
656
|
+
* @param {string} [request.filter]
|
|
657
|
+
* Optional. Filtering results
|
|
658
|
+
* @param {string} [request.orderBy]
|
|
659
|
+
* Optional. Hint for how to order the results
|
|
660
|
+
* @param {object} [options]
|
|
661
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
662
|
+
* @returns {Object}
|
|
663
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
664
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
665
|
+
* {@link protos.google.cloud.agentregistry.v1.Agent|Agent}. The API will be called under the hood as needed, once per the page,
|
|
666
|
+
* so you can stop the iteration when you don't need more results.
|
|
667
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
668
|
+
* for more details and examples.
|
|
669
|
+
* @example <caption>include:samples/generated/v1/agent_registry.list_agents.js</caption>
|
|
670
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_ListAgents_async
|
|
671
|
+
*/
|
|
672
|
+
listAgentsAsync(request?: protos.google.cloud.agentregistry.v1.IListAgentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.agentregistry.v1.IAgent>;
|
|
673
|
+
/**
|
|
674
|
+
* Searches Agents in a given project and location.
|
|
675
|
+
*
|
|
676
|
+
* @param {Object} request
|
|
677
|
+
* The request object that will be sent.
|
|
678
|
+
* @param {string} request.parent
|
|
679
|
+
* Required. Parent value for SearchAgentsRequest. Format:
|
|
680
|
+
* `projects/{project}/locations/{location}`.
|
|
681
|
+
* @param {string} [request.searchString]
|
|
682
|
+
* Optional. Search criteria used to select the Agents to return. If no search
|
|
683
|
+
* criteria is specified then all accessible Agents will be returned.
|
|
684
|
+
*
|
|
685
|
+
* Search expressions can be used to restrict results based upon searchable
|
|
686
|
+
* fields, where the operators can be used along with the suffix wildcard
|
|
687
|
+
* symbol `*`. See
|
|
688
|
+
* [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools)
|
|
689
|
+
* for more details.
|
|
690
|
+
*
|
|
691
|
+
* Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`.
|
|
692
|
+
*
|
|
693
|
+
* Searchable fields:
|
|
694
|
+
*
|
|
695
|
+
* | Field | `=` | `:` | `*` | Keyword Search |
|
|
696
|
+
* |--------------------|-----|-----|-----|----------------|
|
|
697
|
+
* | agentId | Yes | Yes | Yes | Included |
|
|
698
|
+
* | name | No | Yes | Yes | Included |
|
|
699
|
+
* | displayName | No | Yes | Yes | Included |
|
|
700
|
+
* | description | No | Yes | No | Included |
|
|
701
|
+
* | skills | No | Yes | No | Included |
|
|
702
|
+
* | skills.id | No | Yes | No | Included |
|
|
703
|
+
* | skills.name | No | Yes | No | Included |
|
|
704
|
+
* | skills.description | No | Yes | No | Included |
|
|
705
|
+
* | skills.tags | No | Yes | No | Included |
|
|
706
|
+
* | skills.examples | No | Yes | No | Included |
|
|
707
|
+
*
|
|
708
|
+
* Examples:
|
|
709
|
+
*
|
|
710
|
+
* * `agentId="urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234"`
|
|
711
|
+
* to find the agent with the specified agent ID.
|
|
712
|
+
* * `name:important` to find agents whose name contains `important` as a
|
|
713
|
+
* word.
|
|
714
|
+
* * `displayName:works*` to find agents whose display name contains words
|
|
715
|
+
* that start with `works`.
|
|
716
|
+
* * `skills.tags:test` to find agents whose skills tags contain `test`.
|
|
717
|
+
* * `planner OR booking` to find agents whose metadata contains the words
|
|
718
|
+
* `planner` or `booking`.
|
|
719
|
+
* @param {number} [request.pageSize]
|
|
720
|
+
* Optional. The maximum number of search results to return per page. The page
|
|
721
|
+
* size is capped at `100`, even if a larger value is specified. A negative
|
|
722
|
+
* value will result in an `INVALID_ARGUMENT` error. If unspecified or set to
|
|
723
|
+
* `0`, a default value of `20` will be used. The server may return fewer
|
|
724
|
+
* results than requested.
|
|
725
|
+
* @param {string} [request.pageToken]
|
|
726
|
+
* Optional. If present, retrieve the next batch of results from the preceding
|
|
727
|
+
* call to this method. `page_token` must be the value of `next_page_token`
|
|
728
|
+
* from the previous response. The values of all other method parameters, must
|
|
729
|
+
* be identical to those in the previous call.
|
|
730
|
+
* @param {object} [options]
|
|
731
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
732
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
733
|
+
* The first element of the array is Array of {@link protos.google.cloud.agentregistry.v1.Agent|Agent}.
|
|
734
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
735
|
+
* times as needed and will merge results from all the pages into this array.
|
|
736
|
+
* Note that it can affect your quota.
|
|
737
|
+
* We recommend using `searchAgentsAsync()`
|
|
738
|
+
* method described below for async iteration which you can stop as needed.
|
|
739
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
740
|
+
* for more details and examples.
|
|
741
|
+
*/
|
|
742
|
+
searchAgents(request?: protos.google.cloud.agentregistry.v1.ISearchAgentsRequest, options?: CallOptions): Promise<[
|
|
743
|
+
protos.google.cloud.agentregistry.v1.IAgent[],
|
|
744
|
+
protos.google.cloud.agentregistry.v1.ISearchAgentsRequest | null,
|
|
745
|
+
protos.google.cloud.agentregistry.v1.ISearchAgentsResponse
|
|
746
|
+
]>;
|
|
747
|
+
searchAgents(request: protos.google.cloud.agentregistry.v1.ISearchAgentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.ISearchAgentsRequest, protos.google.cloud.agentregistry.v1.ISearchAgentsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IAgent>): void;
|
|
748
|
+
searchAgents(request: protos.google.cloud.agentregistry.v1.ISearchAgentsRequest, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.ISearchAgentsRequest, protos.google.cloud.agentregistry.v1.ISearchAgentsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IAgent>): void;
|
|
749
|
+
/**
|
|
750
|
+
* Equivalent to `searchAgents`, but returns a NodeJS Stream object.
|
|
751
|
+
* @param {Object} request
|
|
752
|
+
* The request object that will be sent.
|
|
753
|
+
* @param {string} request.parent
|
|
754
|
+
* Required. Parent value for SearchAgentsRequest. Format:
|
|
755
|
+
* `projects/{project}/locations/{location}`.
|
|
756
|
+
* @param {string} [request.searchString]
|
|
757
|
+
* Optional. Search criteria used to select the Agents to return. If no search
|
|
758
|
+
* criteria is specified then all accessible Agents will be returned.
|
|
759
|
+
*
|
|
760
|
+
* Search expressions can be used to restrict results based upon searchable
|
|
761
|
+
* fields, where the operators can be used along with the suffix wildcard
|
|
762
|
+
* symbol `*`. See
|
|
763
|
+
* [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools)
|
|
764
|
+
* for more details.
|
|
765
|
+
*
|
|
766
|
+
* Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`.
|
|
767
|
+
*
|
|
768
|
+
* Searchable fields:
|
|
769
|
+
*
|
|
770
|
+
* | Field | `=` | `:` | `*` | Keyword Search |
|
|
771
|
+
* |--------------------|-----|-----|-----|----------------|
|
|
772
|
+
* | agentId | Yes | Yes | Yes | Included |
|
|
773
|
+
* | name | No | Yes | Yes | Included |
|
|
774
|
+
* | displayName | No | Yes | Yes | Included |
|
|
775
|
+
* | description | No | Yes | No | Included |
|
|
776
|
+
* | skills | No | Yes | No | Included |
|
|
777
|
+
* | skills.id | No | Yes | No | Included |
|
|
778
|
+
* | skills.name | No | Yes | No | Included |
|
|
779
|
+
* | skills.description | No | Yes | No | Included |
|
|
780
|
+
* | skills.tags | No | Yes | No | Included |
|
|
781
|
+
* | skills.examples | No | Yes | No | Included |
|
|
782
|
+
*
|
|
783
|
+
* Examples:
|
|
784
|
+
*
|
|
785
|
+
* * `agentId="urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234"`
|
|
786
|
+
* to find the agent with the specified agent ID.
|
|
787
|
+
* * `name:important` to find agents whose name contains `important` as a
|
|
788
|
+
* word.
|
|
789
|
+
* * `displayName:works*` to find agents whose display name contains words
|
|
790
|
+
* that start with `works`.
|
|
791
|
+
* * `skills.tags:test` to find agents whose skills tags contain `test`.
|
|
792
|
+
* * `planner OR booking` to find agents whose metadata contains the words
|
|
793
|
+
* `planner` or `booking`.
|
|
794
|
+
* @param {number} [request.pageSize]
|
|
795
|
+
* Optional. The maximum number of search results to return per page. The page
|
|
796
|
+
* size is capped at `100`, even if a larger value is specified. A negative
|
|
797
|
+
* value will result in an `INVALID_ARGUMENT` error. If unspecified or set to
|
|
798
|
+
* `0`, a default value of `20` will be used. The server may return fewer
|
|
799
|
+
* results than requested.
|
|
800
|
+
* @param {string} [request.pageToken]
|
|
801
|
+
* Optional. If present, retrieve the next batch of results from the preceding
|
|
802
|
+
* call to this method. `page_token` must be the value of `next_page_token`
|
|
803
|
+
* from the previous response. The values of all other method parameters, must
|
|
804
|
+
* be identical to those in the previous call.
|
|
805
|
+
* @param {object} [options]
|
|
806
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
807
|
+
* @returns {Stream}
|
|
808
|
+
* An object stream which emits an object representing {@link protos.google.cloud.agentregistry.v1.Agent|Agent} on 'data' event.
|
|
809
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
810
|
+
* times as needed. Note that it can affect your quota.
|
|
811
|
+
* We recommend using `searchAgentsAsync()`
|
|
812
|
+
* method described below for async iteration which you can stop as needed.
|
|
813
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
814
|
+
* for more details and examples.
|
|
815
|
+
*/
|
|
816
|
+
searchAgentsStream(request?: protos.google.cloud.agentregistry.v1.ISearchAgentsRequest, options?: CallOptions): Transform;
|
|
817
|
+
/**
|
|
818
|
+
* Equivalent to `searchAgents`, but returns an iterable object.
|
|
819
|
+
*
|
|
820
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
821
|
+
* @param {Object} request
|
|
822
|
+
* The request object that will be sent.
|
|
823
|
+
* @param {string} request.parent
|
|
824
|
+
* Required. Parent value for SearchAgentsRequest. Format:
|
|
825
|
+
* `projects/{project}/locations/{location}`.
|
|
826
|
+
* @param {string} [request.searchString]
|
|
827
|
+
* Optional. Search criteria used to select the Agents to return. If no search
|
|
828
|
+
* criteria is specified then all accessible Agents will be returned.
|
|
829
|
+
*
|
|
830
|
+
* Search expressions can be used to restrict results based upon searchable
|
|
831
|
+
* fields, where the operators can be used along with the suffix wildcard
|
|
832
|
+
* symbol `*`. See
|
|
833
|
+
* [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools)
|
|
834
|
+
* for more details.
|
|
835
|
+
*
|
|
836
|
+
* Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`.
|
|
837
|
+
*
|
|
838
|
+
* Searchable fields:
|
|
839
|
+
*
|
|
840
|
+
* | Field | `=` | `:` | `*` | Keyword Search |
|
|
841
|
+
* |--------------------|-----|-----|-----|----------------|
|
|
842
|
+
* | agentId | Yes | Yes | Yes | Included |
|
|
843
|
+
* | name | No | Yes | Yes | Included |
|
|
844
|
+
* | displayName | No | Yes | Yes | Included |
|
|
845
|
+
* | description | No | Yes | No | Included |
|
|
846
|
+
* | skills | No | Yes | No | Included |
|
|
847
|
+
* | skills.id | No | Yes | No | Included |
|
|
848
|
+
* | skills.name | No | Yes | No | Included |
|
|
849
|
+
* | skills.description | No | Yes | No | Included |
|
|
850
|
+
* | skills.tags | No | Yes | No | Included |
|
|
851
|
+
* | skills.examples | No | Yes | No | Included |
|
|
852
|
+
*
|
|
853
|
+
* Examples:
|
|
854
|
+
*
|
|
855
|
+
* * `agentId="urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234"`
|
|
856
|
+
* to find the agent with the specified agent ID.
|
|
857
|
+
* * `name:important` to find agents whose name contains `important` as a
|
|
858
|
+
* word.
|
|
859
|
+
* * `displayName:works*` to find agents whose display name contains words
|
|
860
|
+
* that start with `works`.
|
|
861
|
+
* * `skills.tags:test` to find agents whose skills tags contain `test`.
|
|
862
|
+
* * `planner OR booking` to find agents whose metadata contains the words
|
|
863
|
+
* `planner` or `booking`.
|
|
864
|
+
* @param {number} [request.pageSize]
|
|
865
|
+
* Optional. The maximum number of search results to return per page. The page
|
|
866
|
+
* size is capped at `100`, even if a larger value is specified. A negative
|
|
867
|
+
* value will result in an `INVALID_ARGUMENT` error. If unspecified or set to
|
|
868
|
+
* `0`, a default value of `20` will be used. The server may return fewer
|
|
869
|
+
* results than requested.
|
|
870
|
+
* @param {string} [request.pageToken]
|
|
871
|
+
* Optional. If present, retrieve the next batch of results from the preceding
|
|
872
|
+
* call to this method. `page_token` must be the value of `next_page_token`
|
|
873
|
+
* from the previous response. The values of all other method parameters, must
|
|
874
|
+
* be identical to those in the previous call.
|
|
875
|
+
* @param {object} [options]
|
|
876
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
877
|
+
* @returns {Object}
|
|
878
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
879
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
880
|
+
* {@link protos.google.cloud.agentregistry.v1.Agent|Agent}. The API will be called under the hood as needed, once per the page,
|
|
881
|
+
* so you can stop the iteration when you don't need more results.
|
|
882
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
883
|
+
* for more details and examples.
|
|
884
|
+
* @example <caption>include:samples/generated/v1/agent_registry.search_agents.js</caption>
|
|
885
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_SearchAgents_async
|
|
886
|
+
*/
|
|
887
|
+
searchAgentsAsync(request?: protos.google.cloud.agentregistry.v1.ISearchAgentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.agentregistry.v1.IAgent>;
|
|
888
|
+
/**
|
|
889
|
+
* Lists Endpoints in a given project and location.
|
|
890
|
+
*
|
|
891
|
+
* @param {Object} request
|
|
892
|
+
* The request object that will be sent.
|
|
893
|
+
* @param {string} request.parent
|
|
894
|
+
* Required. The project and location to list endpoints in.
|
|
895
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
896
|
+
* @param {number} [request.pageSize]
|
|
897
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
898
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
899
|
+
* @param {string} [request.pageToken]
|
|
900
|
+
* Optional. A token identifying a page of results the server should return.
|
|
901
|
+
* @param {string} [request.filter]
|
|
902
|
+
* Optional. A query string used to filter the list of endpoints returned.
|
|
903
|
+
* The filter expression must follow AIP-160 syntax.
|
|
904
|
+
*
|
|
905
|
+
* Filtering is supported on the `name`, `display_name`, `description`,
|
|
906
|
+
* `version`, and `interfaces` fields.
|
|
907
|
+
*
|
|
908
|
+
* Some examples:
|
|
909
|
+
*
|
|
910
|
+
* * `name = "projects/p1/locations/l1/endpoints/e1"`
|
|
911
|
+
* * `display_name = "my-endpoint"`
|
|
912
|
+
* * `description = "my-endpoint-description"`
|
|
913
|
+
* * `version = "v1"`
|
|
914
|
+
* * `interfaces.transport = "HTTP_JSON"`
|
|
915
|
+
* @param {object} [options]
|
|
916
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
917
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
918
|
+
* The first element of the array is Array of {@link protos.google.cloud.agentregistry.v1.Endpoint|Endpoint}.
|
|
919
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
920
|
+
* times as needed and will merge results from all the pages into this array.
|
|
921
|
+
* Note that it can affect your quota.
|
|
922
|
+
* We recommend using `listEndpointsAsync()`
|
|
923
|
+
* method described below for async iteration which you can stop as needed.
|
|
924
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
925
|
+
* for more details and examples.
|
|
926
|
+
*/
|
|
927
|
+
listEndpoints(request?: protos.google.cloud.agentregistry.v1.IListEndpointsRequest, options?: CallOptions): Promise<[
|
|
928
|
+
protos.google.cloud.agentregistry.v1.IEndpoint[],
|
|
929
|
+
protos.google.cloud.agentregistry.v1.IListEndpointsRequest | null,
|
|
930
|
+
protos.google.cloud.agentregistry.v1.IListEndpointsResponse
|
|
931
|
+
]>;
|
|
932
|
+
listEndpoints(request: protos.google.cloud.agentregistry.v1.IListEndpointsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListEndpointsRequest, protos.google.cloud.agentregistry.v1.IListEndpointsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IEndpoint>): void;
|
|
933
|
+
listEndpoints(request: protos.google.cloud.agentregistry.v1.IListEndpointsRequest, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListEndpointsRequest, protos.google.cloud.agentregistry.v1.IListEndpointsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IEndpoint>): void;
|
|
934
|
+
/**
|
|
935
|
+
* Equivalent to `listEndpoints`, but returns a NodeJS Stream object.
|
|
936
|
+
* @param {Object} request
|
|
937
|
+
* The request object that will be sent.
|
|
938
|
+
* @param {string} request.parent
|
|
939
|
+
* Required. The project and location to list endpoints in.
|
|
940
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
941
|
+
* @param {number} [request.pageSize]
|
|
942
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
943
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
944
|
+
* @param {string} [request.pageToken]
|
|
945
|
+
* Optional. A token identifying a page of results the server should return.
|
|
946
|
+
* @param {string} [request.filter]
|
|
947
|
+
* Optional. A query string used to filter the list of endpoints returned.
|
|
948
|
+
* The filter expression must follow AIP-160 syntax.
|
|
949
|
+
*
|
|
950
|
+
* Filtering is supported on the `name`, `display_name`, `description`,
|
|
951
|
+
* `version`, and `interfaces` fields.
|
|
952
|
+
*
|
|
953
|
+
* Some examples:
|
|
954
|
+
*
|
|
955
|
+
* * `name = "projects/p1/locations/l1/endpoints/e1"`
|
|
956
|
+
* * `display_name = "my-endpoint"`
|
|
957
|
+
* * `description = "my-endpoint-description"`
|
|
958
|
+
* * `version = "v1"`
|
|
959
|
+
* * `interfaces.transport = "HTTP_JSON"`
|
|
960
|
+
* @param {object} [options]
|
|
961
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
962
|
+
* @returns {Stream}
|
|
963
|
+
* An object stream which emits an object representing {@link protos.google.cloud.agentregistry.v1.Endpoint|Endpoint} on 'data' event.
|
|
964
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
965
|
+
* times as needed. Note that it can affect your quota.
|
|
966
|
+
* We recommend using `listEndpointsAsync()`
|
|
967
|
+
* method described below for async iteration which you can stop as needed.
|
|
968
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
969
|
+
* for more details and examples.
|
|
970
|
+
*/
|
|
971
|
+
listEndpointsStream(request?: protos.google.cloud.agentregistry.v1.IListEndpointsRequest, options?: CallOptions): Transform;
|
|
972
|
+
/**
|
|
973
|
+
* Equivalent to `listEndpoints`, but returns an iterable object.
|
|
974
|
+
*
|
|
975
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
976
|
+
* @param {Object} request
|
|
977
|
+
* The request object that will be sent.
|
|
978
|
+
* @param {string} request.parent
|
|
979
|
+
* Required. The project and location to list endpoints in.
|
|
980
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
981
|
+
* @param {number} [request.pageSize]
|
|
982
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
983
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
984
|
+
* @param {string} [request.pageToken]
|
|
985
|
+
* Optional. A token identifying a page of results the server should return.
|
|
986
|
+
* @param {string} [request.filter]
|
|
987
|
+
* Optional. A query string used to filter the list of endpoints returned.
|
|
988
|
+
* The filter expression must follow AIP-160 syntax.
|
|
989
|
+
*
|
|
990
|
+
* Filtering is supported on the `name`, `display_name`, `description`,
|
|
991
|
+
* `version`, and `interfaces` fields.
|
|
992
|
+
*
|
|
993
|
+
* Some examples:
|
|
994
|
+
*
|
|
995
|
+
* * `name = "projects/p1/locations/l1/endpoints/e1"`
|
|
996
|
+
* * `display_name = "my-endpoint"`
|
|
997
|
+
* * `description = "my-endpoint-description"`
|
|
998
|
+
* * `version = "v1"`
|
|
999
|
+
* * `interfaces.transport = "HTTP_JSON"`
|
|
1000
|
+
* @param {object} [options]
|
|
1001
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1002
|
+
* @returns {Object}
|
|
1003
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
1004
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
1005
|
+
* {@link protos.google.cloud.agentregistry.v1.Endpoint|Endpoint}. The API will be called under the hood as needed, once per the page,
|
|
1006
|
+
* so you can stop the iteration when you don't need more results.
|
|
1007
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1008
|
+
* for more details and examples.
|
|
1009
|
+
* @example <caption>include:samples/generated/v1/agent_registry.list_endpoints.js</caption>
|
|
1010
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_ListEndpoints_async
|
|
1011
|
+
*/
|
|
1012
|
+
listEndpointsAsync(request?: protos.google.cloud.agentregistry.v1.IListEndpointsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.agentregistry.v1.IEndpoint>;
|
|
1013
|
+
/**
|
|
1014
|
+
* Lists McpServers in a given project and location.
|
|
1015
|
+
*
|
|
1016
|
+
* @param {Object} request
|
|
1017
|
+
* The request object that will be sent.
|
|
1018
|
+
* @param {string} request.parent
|
|
1019
|
+
* Required. Parent value for ListMcpServersRequest. Format:
|
|
1020
|
+
* `projects/{project}/locations/{location}`.
|
|
1021
|
+
* @param {number} [request.pageSize]
|
|
1022
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1023
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
1024
|
+
* @param {string} [request.pageToken]
|
|
1025
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1026
|
+
* @param {string} [request.filter]
|
|
1027
|
+
* Optional. Filtering results
|
|
1028
|
+
* @param {string} [request.orderBy]
|
|
1029
|
+
* Optional. Hint for how to order the results
|
|
1030
|
+
* @param {object} [options]
|
|
1031
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1032
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1033
|
+
* The first element of the array is Array of {@link protos.google.cloud.agentregistry.v1.McpServer|McpServer}.
|
|
1034
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1035
|
+
* times as needed and will merge results from all the pages into this array.
|
|
1036
|
+
* Note that it can affect your quota.
|
|
1037
|
+
* We recommend using `listMcpServersAsync()`
|
|
1038
|
+
* method described below for async iteration which you can stop as needed.
|
|
1039
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1040
|
+
* for more details and examples.
|
|
1041
|
+
*/
|
|
1042
|
+
listMcpServers(request?: protos.google.cloud.agentregistry.v1.IListMcpServersRequest, options?: CallOptions): Promise<[
|
|
1043
|
+
protos.google.cloud.agentregistry.v1.IMcpServer[],
|
|
1044
|
+
protos.google.cloud.agentregistry.v1.IListMcpServersRequest | null,
|
|
1045
|
+
protos.google.cloud.agentregistry.v1.IListMcpServersResponse
|
|
1046
|
+
]>;
|
|
1047
|
+
listMcpServers(request: protos.google.cloud.agentregistry.v1.IListMcpServersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListMcpServersRequest, protos.google.cloud.agentregistry.v1.IListMcpServersResponse | null | undefined, protos.google.cloud.agentregistry.v1.IMcpServer>): void;
|
|
1048
|
+
listMcpServers(request: protos.google.cloud.agentregistry.v1.IListMcpServersRequest, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListMcpServersRequest, protos.google.cloud.agentregistry.v1.IListMcpServersResponse | null | undefined, protos.google.cloud.agentregistry.v1.IMcpServer>): void;
|
|
1049
|
+
/**
|
|
1050
|
+
* Equivalent to `listMcpServers`, but returns a NodeJS Stream object.
|
|
1051
|
+
* @param {Object} request
|
|
1052
|
+
* The request object that will be sent.
|
|
1053
|
+
* @param {string} request.parent
|
|
1054
|
+
* Required. Parent value for ListMcpServersRequest. Format:
|
|
1055
|
+
* `projects/{project}/locations/{location}`.
|
|
1056
|
+
* @param {number} [request.pageSize]
|
|
1057
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1058
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
1059
|
+
* @param {string} [request.pageToken]
|
|
1060
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1061
|
+
* @param {string} [request.filter]
|
|
1062
|
+
* Optional. Filtering results
|
|
1063
|
+
* @param {string} [request.orderBy]
|
|
1064
|
+
* Optional. Hint for how to order the results
|
|
1065
|
+
* @param {object} [options]
|
|
1066
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1067
|
+
* @returns {Stream}
|
|
1068
|
+
* An object stream which emits an object representing {@link protos.google.cloud.agentregistry.v1.McpServer|McpServer} on 'data' event.
|
|
1069
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1070
|
+
* times as needed. Note that it can affect your quota.
|
|
1071
|
+
* We recommend using `listMcpServersAsync()`
|
|
1072
|
+
* method described below for async iteration which you can stop as needed.
|
|
1073
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1074
|
+
* for more details and examples.
|
|
1075
|
+
*/
|
|
1076
|
+
listMcpServersStream(request?: protos.google.cloud.agentregistry.v1.IListMcpServersRequest, options?: CallOptions): Transform;
|
|
1077
|
+
/**
|
|
1078
|
+
* Equivalent to `listMcpServers`, but returns an iterable object.
|
|
1079
|
+
*
|
|
1080
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
1081
|
+
* @param {Object} request
|
|
1082
|
+
* The request object that will be sent.
|
|
1083
|
+
* @param {string} request.parent
|
|
1084
|
+
* Required. Parent value for ListMcpServersRequest. Format:
|
|
1085
|
+
* `projects/{project}/locations/{location}`.
|
|
1086
|
+
* @param {number} [request.pageSize]
|
|
1087
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1088
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
1089
|
+
* @param {string} [request.pageToken]
|
|
1090
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1091
|
+
* @param {string} [request.filter]
|
|
1092
|
+
* Optional. Filtering results
|
|
1093
|
+
* @param {string} [request.orderBy]
|
|
1094
|
+
* Optional. Hint for how to order the results
|
|
1095
|
+
* @param {object} [options]
|
|
1096
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1097
|
+
* @returns {Object}
|
|
1098
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
1099
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
1100
|
+
* {@link protos.google.cloud.agentregistry.v1.McpServer|McpServer}. The API will be called under the hood as needed, once per the page,
|
|
1101
|
+
* so you can stop the iteration when you don't need more results.
|
|
1102
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1103
|
+
* for more details and examples.
|
|
1104
|
+
* @example <caption>include:samples/generated/v1/agent_registry.list_mcp_servers.js</caption>
|
|
1105
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_ListMcpServers_async
|
|
1106
|
+
*/
|
|
1107
|
+
listMcpServersAsync(request?: protos.google.cloud.agentregistry.v1.IListMcpServersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.agentregistry.v1.IMcpServer>;
|
|
1108
|
+
/**
|
|
1109
|
+
* Searches McpServers in a given project and location.
|
|
1110
|
+
*
|
|
1111
|
+
* @param {Object} request
|
|
1112
|
+
* The request object that will be sent.
|
|
1113
|
+
* @param {string} request.parent
|
|
1114
|
+
* Required. Parent value for SearchMcpServersRequest. Format:
|
|
1115
|
+
* `projects/{project}/locations/{location}`.
|
|
1116
|
+
* @param {string} [request.searchString]
|
|
1117
|
+
* Optional. Search criteria used to select the MCP Servers to return. If no
|
|
1118
|
+
* search criteria is specified then all accessible MCP Servers will be
|
|
1119
|
+
* returned.
|
|
1120
|
+
*
|
|
1121
|
+
* Search expressions can be used to restrict results based upon searchable
|
|
1122
|
+
* fields, where the operators can be used along with the suffix wildcard
|
|
1123
|
+
* symbol `*`. See
|
|
1124
|
+
* [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools)
|
|
1125
|
+
* for more details.
|
|
1126
|
+
*
|
|
1127
|
+
* Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`.
|
|
1128
|
+
*
|
|
1129
|
+
* Searchable fields:
|
|
1130
|
+
*
|
|
1131
|
+
* | Field | `=` | `:` | `*` | Keyword Search |
|
|
1132
|
+
* |--------------------|-----|-----|-----|----------------|
|
|
1133
|
+
* | mcpServerId | Yes | Yes | Yes | Included |
|
|
1134
|
+
* | name | No | Yes | Yes | Included |
|
|
1135
|
+
* | displayName | No | Yes | Yes | Included |
|
|
1136
|
+
*
|
|
1137
|
+
* Examples:
|
|
1138
|
+
*
|
|
1139
|
+
* * `mcpServerId="urn:mcp:projects-123:projects:123:locations:us-central1:agentregistry:services:service-id"`
|
|
1140
|
+
* to find the MCP Server with the specified MCP Server ID.
|
|
1141
|
+
* * `name:important` to find MCP Servers whose name contains `important` as a
|
|
1142
|
+
* word.
|
|
1143
|
+
* * `displayName:works*` to find MCP Servers whose display name contains
|
|
1144
|
+
* words that start with `works`.
|
|
1145
|
+
* * `planner OR booking` to find MCP Servers whose metadata contains the
|
|
1146
|
+
* words `planner` or `booking`.
|
|
1147
|
+
* * `mcpServerId:service-id AND (displayName:planner OR
|
|
1148
|
+
* displayName:booking)` to find MCP Servers whose MCP Server ID contains
|
|
1149
|
+
* `service-id` and whose display name contains `planner` or
|
|
1150
|
+
* `booking`.
|
|
1151
|
+
* @param {number} [request.pageSize]
|
|
1152
|
+
* Optional. The maximum number of search results to return per page. The page
|
|
1153
|
+
* size is capped at `100`, even if a larger value is specified. A negative
|
|
1154
|
+
* value will result in an `INVALID_ARGUMENT` error. If unspecified or set to
|
|
1155
|
+
* `0`, a default value of `20` will be used. The server may return fewer
|
|
1156
|
+
* results than requested.
|
|
1157
|
+
* @param {string} [request.pageToken]
|
|
1158
|
+
* Optional. If present, retrieve the next batch of results from the preceding
|
|
1159
|
+
* call to this method. `page_token` must be the value of `next_page_token`
|
|
1160
|
+
* from the previous response. The values of all other method parameters, must
|
|
1161
|
+
* be identical to those in the previous call.
|
|
1162
|
+
* @param {object} [options]
|
|
1163
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1164
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1165
|
+
* The first element of the array is Array of {@link protos.google.cloud.agentregistry.v1.McpServer|McpServer}.
|
|
1166
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1167
|
+
* times as needed and will merge results from all the pages into this array.
|
|
1168
|
+
* Note that it can affect your quota.
|
|
1169
|
+
* We recommend using `searchMcpServersAsync()`
|
|
1170
|
+
* method described below for async iteration which you can stop as needed.
|
|
1171
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1172
|
+
* for more details and examples.
|
|
1173
|
+
*/
|
|
1174
|
+
searchMcpServers(request?: protos.google.cloud.agentregistry.v1.ISearchMcpServersRequest, options?: CallOptions): Promise<[
|
|
1175
|
+
protos.google.cloud.agentregistry.v1.IMcpServer[],
|
|
1176
|
+
protos.google.cloud.agentregistry.v1.ISearchMcpServersRequest | null,
|
|
1177
|
+
protos.google.cloud.agentregistry.v1.ISearchMcpServersResponse
|
|
1178
|
+
]>;
|
|
1179
|
+
searchMcpServers(request: protos.google.cloud.agentregistry.v1.ISearchMcpServersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.ISearchMcpServersRequest, protos.google.cloud.agentregistry.v1.ISearchMcpServersResponse | null | undefined, protos.google.cloud.agentregistry.v1.IMcpServer>): void;
|
|
1180
|
+
searchMcpServers(request: protos.google.cloud.agentregistry.v1.ISearchMcpServersRequest, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.ISearchMcpServersRequest, protos.google.cloud.agentregistry.v1.ISearchMcpServersResponse | null | undefined, protos.google.cloud.agentregistry.v1.IMcpServer>): void;
|
|
1181
|
+
/**
|
|
1182
|
+
* Equivalent to `searchMcpServers`, but returns a NodeJS Stream object.
|
|
1183
|
+
* @param {Object} request
|
|
1184
|
+
* The request object that will be sent.
|
|
1185
|
+
* @param {string} request.parent
|
|
1186
|
+
* Required. Parent value for SearchMcpServersRequest. Format:
|
|
1187
|
+
* `projects/{project}/locations/{location}`.
|
|
1188
|
+
* @param {string} [request.searchString]
|
|
1189
|
+
* Optional. Search criteria used to select the MCP Servers to return. If no
|
|
1190
|
+
* search criteria is specified then all accessible MCP Servers will be
|
|
1191
|
+
* returned.
|
|
1192
|
+
*
|
|
1193
|
+
* Search expressions can be used to restrict results based upon searchable
|
|
1194
|
+
* fields, where the operators can be used along with the suffix wildcard
|
|
1195
|
+
* symbol `*`. See
|
|
1196
|
+
* [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools)
|
|
1197
|
+
* for more details.
|
|
1198
|
+
*
|
|
1199
|
+
* Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`.
|
|
1200
|
+
*
|
|
1201
|
+
* Searchable fields:
|
|
1202
|
+
*
|
|
1203
|
+
* | Field | `=` | `:` | `*` | Keyword Search |
|
|
1204
|
+
* |--------------------|-----|-----|-----|----------------|
|
|
1205
|
+
* | mcpServerId | Yes | Yes | Yes | Included |
|
|
1206
|
+
* | name | No | Yes | Yes | Included |
|
|
1207
|
+
* | displayName | No | Yes | Yes | Included |
|
|
1208
|
+
*
|
|
1209
|
+
* Examples:
|
|
1210
|
+
*
|
|
1211
|
+
* * `mcpServerId="urn:mcp:projects-123:projects:123:locations:us-central1:agentregistry:services:service-id"`
|
|
1212
|
+
* to find the MCP Server with the specified MCP Server ID.
|
|
1213
|
+
* * `name:important` to find MCP Servers whose name contains `important` as a
|
|
1214
|
+
* word.
|
|
1215
|
+
* * `displayName:works*` to find MCP Servers whose display name contains
|
|
1216
|
+
* words that start with `works`.
|
|
1217
|
+
* * `planner OR booking` to find MCP Servers whose metadata contains the
|
|
1218
|
+
* words `planner` or `booking`.
|
|
1219
|
+
* * `mcpServerId:service-id AND (displayName:planner OR
|
|
1220
|
+
* displayName:booking)` to find MCP Servers whose MCP Server ID contains
|
|
1221
|
+
* `service-id` and whose display name contains `planner` or
|
|
1222
|
+
* `booking`.
|
|
1223
|
+
* @param {number} [request.pageSize]
|
|
1224
|
+
* Optional. The maximum number of search results to return per page. The page
|
|
1225
|
+
* size is capped at `100`, even if a larger value is specified. A negative
|
|
1226
|
+
* value will result in an `INVALID_ARGUMENT` error. If unspecified or set to
|
|
1227
|
+
* `0`, a default value of `20` will be used. The server may return fewer
|
|
1228
|
+
* results than requested.
|
|
1229
|
+
* @param {string} [request.pageToken]
|
|
1230
|
+
* Optional. If present, retrieve the next batch of results from the preceding
|
|
1231
|
+
* call to this method. `page_token` must be the value of `next_page_token`
|
|
1232
|
+
* from the previous response. The values of all other method parameters, must
|
|
1233
|
+
* be identical to those in the previous call.
|
|
1234
|
+
* @param {object} [options]
|
|
1235
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1236
|
+
* @returns {Stream}
|
|
1237
|
+
* An object stream which emits an object representing {@link protos.google.cloud.agentregistry.v1.McpServer|McpServer} on 'data' event.
|
|
1238
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1239
|
+
* times as needed. Note that it can affect your quota.
|
|
1240
|
+
* We recommend using `searchMcpServersAsync()`
|
|
1241
|
+
* method described below for async iteration which you can stop as needed.
|
|
1242
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1243
|
+
* for more details and examples.
|
|
1244
|
+
*/
|
|
1245
|
+
searchMcpServersStream(request?: protos.google.cloud.agentregistry.v1.ISearchMcpServersRequest, options?: CallOptions): Transform;
|
|
1246
|
+
/**
|
|
1247
|
+
* Equivalent to `searchMcpServers`, but returns an iterable object.
|
|
1248
|
+
*
|
|
1249
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
1250
|
+
* @param {Object} request
|
|
1251
|
+
* The request object that will be sent.
|
|
1252
|
+
* @param {string} request.parent
|
|
1253
|
+
* Required. Parent value for SearchMcpServersRequest. Format:
|
|
1254
|
+
* `projects/{project}/locations/{location}`.
|
|
1255
|
+
* @param {string} [request.searchString]
|
|
1256
|
+
* Optional. Search criteria used to select the MCP Servers to return. If no
|
|
1257
|
+
* search criteria is specified then all accessible MCP Servers will be
|
|
1258
|
+
* returned.
|
|
1259
|
+
*
|
|
1260
|
+
* Search expressions can be used to restrict results based upon searchable
|
|
1261
|
+
* fields, where the operators can be used along with the suffix wildcard
|
|
1262
|
+
* symbol `*`. See
|
|
1263
|
+
* [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools)
|
|
1264
|
+
* for more details.
|
|
1265
|
+
*
|
|
1266
|
+
* Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`.
|
|
1267
|
+
*
|
|
1268
|
+
* Searchable fields:
|
|
1269
|
+
*
|
|
1270
|
+
* | Field | `=` | `:` | `*` | Keyword Search |
|
|
1271
|
+
* |--------------------|-----|-----|-----|----------------|
|
|
1272
|
+
* | mcpServerId | Yes | Yes | Yes | Included |
|
|
1273
|
+
* | name | No | Yes | Yes | Included |
|
|
1274
|
+
* | displayName | No | Yes | Yes | Included |
|
|
1275
|
+
*
|
|
1276
|
+
* Examples:
|
|
1277
|
+
*
|
|
1278
|
+
* * `mcpServerId="urn:mcp:projects-123:projects:123:locations:us-central1:agentregistry:services:service-id"`
|
|
1279
|
+
* to find the MCP Server with the specified MCP Server ID.
|
|
1280
|
+
* * `name:important` to find MCP Servers whose name contains `important` as a
|
|
1281
|
+
* word.
|
|
1282
|
+
* * `displayName:works*` to find MCP Servers whose display name contains
|
|
1283
|
+
* words that start with `works`.
|
|
1284
|
+
* * `planner OR booking` to find MCP Servers whose metadata contains the
|
|
1285
|
+
* words `planner` or `booking`.
|
|
1286
|
+
* * `mcpServerId:service-id AND (displayName:planner OR
|
|
1287
|
+
* displayName:booking)` to find MCP Servers whose MCP Server ID contains
|
|
1288
|
+
* `service-id` and whose display name contains `planner` or
|
|
1289
|
+
* `booking`.
|
|
1290
|
+
* @param {number} [request.pageSize]
|
|
1291
|
+
* Optional. The maximum number of search results to return per page. The page
|
|
1292
|
+
* size is capped at `100`, even if a larger value is specified. A negative
|
|
1293
|
+
* value will result in an `INVALID_ARGUMENT` error. If unspecified or set to
|
|
1294
|
+
* `0`, a default value of `20` will be used. The server may return fewer
|
|
1295
|
+
* results than requested.
|
|
1296
|
+
* @param {string} [request.pageToken]
|
|
1297
|
+
* Optional. If present, retrieve the next batch of results from the preceding
|
|
1298
|
+
* call to this method. `page_token` must be the value of `next_page_token`
|
|
1299
|
+
* from the previous response. The values of all other method parameters, must
|
|
1300
|
+
* be identical to those in the previous call.
|
|
1301
|
+
* @param {object} [options]
|
|
1302
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1303
|
+
* @returns {Object}
|
|
1304
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
1305
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
1306
|
+
* {@link protos.google.cloud.agentregistry.v1.McpServer|McpServer}. The API will be called under the hood as needed, once per the page,
|
|
1307
|
+
* so you can stop the iteration when you don't need more results.
|
|
1308
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1309
|
+
* for more details and examples.
|
|
1310
|
+
* @example <caption>include:samples/generated/v1/agent_registry.search_mcp_servers.js</caption>
|
|
1311
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_SearchMcpServers_async
|
|
1312
|
+
*/
|
|
1313
|
+
searchMcpServersAsync(request?: protos.google.cloud.agentregistry.v1.ISearchMcpServersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.agentregistry.v1.IMcpServer>;
|
|
1314
|
+
/**
|
|
1315
|
+
* Lists Services in a given project and location.
|
|
1316
|
+
*
|
|
1317
|
+
* @param {Object} request
|
|
1318
|
+
* The request object that will be sent.
|
|
1319
|
+
* @param {string} request.parent
|
|
1320
|
+
* Required. The project and location to list services in.
|
|
1321
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
1322
|
+
* @param {number} [request.pageSize]
|
|
1323
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1324
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
1325
|
+
* @param {string} [request.pageToken]
|
|
1326
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1327
|
+
* @param {string} [request.filter]
|
|
1328
|
+
* Optional. A query string used to filter the list of services returned.
|
|
1329
|
+
* The filter expression must follow AIP-160 syntax.
|
|
1330
|
+
*
|
|
1331
|
+
* Filtering is supported on the `name`, `display_name`, `description`,
|
|
1332
|
+
* and `labels` fields.
|
|
1333
|
+
*
|
|
1334
|
+
* Some examples:
|
|
1335
|
+
*
|
|
1336
|
+
* * `name = "projects/p1/locations/l1/services/s1"`
|
|
1337
|
+
* * `display_name = "my-service"`
|
|
1338
|
+
* * `description : "myservice description"`
|
|
1339
|
+
* * `labels.env = "prod"`
|
|
1340
|
+
* @param {object} [options]
|
|
1341
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1342
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1343
|
+
* The first element of the array is Array of {@link protos.google.cloud.agentregistry.v1.Service|Service}.
|
|
1344
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1345
|
+
* times as needed and will merge results from all the pages into this array.
|
|
1346
|
+
* Note that it can affect your quota.
|
|
1347
|
+
* We recommend using `listServicesAsync()`
|
|
1348
|
+
* method described below for async iteration which you can stop as needed.
|
|
1349
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1350
|
+
* for more details and examples.
|
|
1351
|
+
*/
|
|
1352
|
+
listServices(request?: protos.google.cloud.agentregistry.v1.IListServicesRequest, options?: CallOptions): Promise<[
|
|
1353
|
+
protos.google.cloud.agentregistry.v1.IService[],
|
|
1354
|
+
protos.google.cloud.agentregistry.v1.IListServicesRequest | null,
|
|
1355
|
+
protos.google.cloud.agentregistry.v1.IListServicesResponse
|
|
1356
|
+
]>;
|
|
1357
|
+
listServices(request: protos.google.cloud.agentregistry.v1.IListServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListServicesRequest, protos.google.cloud.agentregistry.v1.IListServicesResponse | null | undefined, protos.google.cloud.agentregistry.v1.IService>): void;
|
|
1358
|
+
listServices(request: protos.google.cloud.agentregistry.v1.IListServicesRequest, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListServicesRequest, protos.google.cloud.agentregistry.v1.IListServicesResponse | null | undefined, protos.google.cloud.agentregistry.v1.IService>): void;
|
|
1359
|
+
/**
|
|
1360
|
+
* Equivalent to `listServices`, but returns a NodeJS Stream object.
|
|
1361
|
+
* @param {Object} request
|
|
1362
|
+
* The request object that will be sent.
|
|
1363
|
+
* @param {string} request.parent
|
|
1364
|
+
* Required. The project and location to list services in.
|
|
1365
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
1366
|
+
* @param {number} [request.pageSize]
|
|
1367
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1368
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
1369
|
+
* @param {string} [request.pageToken]
|
|
1370
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1371
|
+
* @param {string} [request.filter]
|
|
1372
|
+
* Optional. A query string used to filter the list of services returned.
|
|
1373
|
+
* The filter expression must follow AIP-160 syntax.
|
|
1374
|
+
*
|
|
1375
|
+
* Filtering is supported on the `name`, `display_name`, `description`,
|
|
1376
|
+
* and `labels` fields.
|
|
1377
|
+
*
|
|
1378
|
+
* Some examples:
|
|
1379
|
+
*
|
|
1380
|
+
* * `name = "projects/p1/locations/l1/services/s1"`
|
|
1381
|
+
* * `display_name = "my-service"`
|
|
1382
|
+
* * `description : "myservice description"`
|
|
1383
|
+
* * `labels.env = "prod"`
|
|
1384
|
+
* @param {object} [options]
|
|
1385
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1386
|
+
* @returns {Stream}
|
|
1387
|
+
* An object stream which emits an object representing {@link protos.google.cloud.agentregistry.v1.Service|Service} on 'data' event.
|
|
1388
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1389
|
+
* times as needed. Note that it can affect your quota.
|
|
1390
|
+
* We recommend using `listServicesAsync()`
|
|
1391
|
+
* method described below for async iteration which you can stop as needed.
|
|
1392
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1393
|
+
* for more details and examples.
|
|
1394
|
+
*/
|
|
1395
|
+
listServicesStream(request?: protos.google.cloud.agentregistry.v1.IListServicesRequest, options?: CallOptions): Transform;
|
|
1396
|
+
/**
|
|
1397
|
+
* Equivalent to `listServices`, but returns an iterable object.
|
|
1398
|
+
*
|
|
1399
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
1400
|
+
* @param {Object} request
|
|
1401
|
+
* The request object that will be sent.
|
|
1402
|
+
* @param {string} request.parent
|
|
1403
|
+
* Required. The project and location to list services in.
|
|
1404
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
1405
|
+
* @param {number} [request.pageSize]
|
|
1406
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1407
|
+
* requested. If unspecified, server will pick an appropriate default.
|
|
1408
|
+
* @param {string} [request.pageToken]
|
|
1409
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1410
|
+
* @param {string} [request.filter]
|
|
1411
|
+
* Optional. A query string used to filter the list of services returned.
|
|
1412
|
+
* The filter expression must follow AIP-160 syntax.
|
|
1413
|
+
*
|
|
1414
|
+
* Filtering is supported on the `name`, `display_name`, `description`,
|
|
1415
|
+
* and `labels` fields.
|
|
1416
|
+
*
|
|
1417
|
+
* Some examples:
|
|
1418
|
+
*
|
|
1419
|
+
* * `name = "projects/p1/locations/l1/services/s1"`
|
|
1420
|
+
* * `display_name = "my-service"`
|
|
1421
|
+
* * `description : "myservice description"`
|
|
1422
|
+
* * `labels.env = "prod"`
|
|
1423
|
+
* @param {object} [options]
|
|
1424
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1425
|
+
* @returns {Object}
|
|
1426
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
1427
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
1428
|
+
* {@link protos.google.cloud.agentregistry.v1.Service|Service}. The API will be called under the hood as needed, once per the page,
|
|
1429
|
+
* so you can stop the iteration when you don't need more results.
|
|
1430
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1431
|
+
* for more details and examples.
|
|
1432
|
+
* @example <caption>include:samples/generated/v1/agent_registry.list_services.js</caption>
|
|
1433
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_ListServices_async
|
|
1434
|
+
*/
|
|
1435
|
+
listServicesAsync(request?: protos.google.cloud.agentregistry.v1.IListServicesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.agentregistry.v1.IService>;
|
|
1436
|
+
/**
|
|
1437
|
+
* Lists Bindings in a given project and location.
|
|
1438
|
+
*
|
|
1439
|
+
* @param {Object} request
|
|
1440
|
+
* The request object that will be sent.
|
|
1441
|
+
* @param {string} request.parent
|
|
1442
|
+
* Required. The project and location to list bindings in.
|
|
1443
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
1444
|
+
* @param {number} [request.pageSize]
|
|
1445
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1446
|
+
* requested. Page size is 500 if unspecified and is capped at `500` even if a
|
|
1447
|
+
* larger value is given.
|
|
1448
|
+
* @param {string} [request.pageToken]
|
|
1449
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1450
|
+
* @param {string} [request.filter]
|
|
1451
|
+
* Optional. A query string used to filter the list of bindings returned.
|
|
1452
|
+
* The filter expression must follow AIP-160 syntax.
|
|
1453
|
+
* @param {string} [request.orderBy]
|
|
1454
|
+
* Optional. Hint for how to order the results
|
|
1455
|
+
* @param {object} [options]
|
|
1456
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1457
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1458
|
+
* The first element of the array is Array of {@link protos.google.cloud.agentregistry.v1.Binding|Binding}.
|
|
1459
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1460
|
+
* times as needed and will merge results from all the pages into this array.
|
|
1461
|
+
* Note that it can affect your quota.
|
|
1462
|
+
* We recommend using `listBindingsAsync()`
|
|
1463
|
+
* method described below for async iteration which you can stop as needed.
|
|
1464
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1465
|
+
* for more details and examples.
|
|
1466
|
+
*/
|
|
1467
|
+
listBindings(request?: protos.google.cloud.agentregistry.v1.IListBindingsRequest, options?: CallOptions): Promise<[
|
|
1468
|
+
protos.google.cloud.agentregistry.v1.IBinding[],
|
|
1469
|
+
protos.google.cloud.agentregistry.v1.IListBindingsRequest | null,
|
|
1470
|
+
protos.google.cloud.agentregistry.v1.IListBindingsResponse
|
|
1471
|
+
]>;
|
|
1472
|
+
listBindings(request: protos.google.cloud.agentregistry.v1.IListBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListBindingsRequest, protos.google.cloud.agentregistry.v1.IListBindingsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IBinding>): void;
|
|
1473
|
+
listBindings(request: protos.google.cloud.agentregistry.v1.IListBindingsRequest, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IListBindingsRequest, protos.google.cloud.agentregistry.v1.IListBindingsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IBinding>): void;
|
|
1474
|
+
/**
|
|
1475
|
+
* Equivalent to `listBindings`, but returns a NodeJS Stream object.
|
|
1476
|
+
* @param {Object} request
|
|
1477
|
+
* The request object that will be sent.
|
|
1478
|
+
* @param {string} request.parent
|
|
1479
|
+
* Required. The project and location to list bindings in.
|
|
1480
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
1481
|
+
* @param {number} [request.pageSize]
|
|
1482
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1483
|
+
* requested. Page size is 500 if unspecified and is capped at `500` even if a
|
|
1484
|
+
* larger value is given.
|
|
1485
|
+
* @param {string} [request.pageToken]
|
|
1486
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1487
|
+
* @param {string} [request.filter]
|
|
1488
|
+
* Optional. A query string used to filter the list of bindings returned.
|
|
1489
|
+
* The filter expression must follow AIP-160 syntax.
|
|
1490
|
+
* @param {string} [request.orderBy]
|
|
1491
|
+
* Optional. Hint for how to order the results
|
|
1492
|
+
* @param {object} [options]
|
|
1493
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1494
|
+
* @returns {Stream}
|
|
1495
|
+
* An object stream which emits an object representing {@link protos.google.cloud.agentregistry.v1.Binding|Binding} on 'data' event.
|
|
1496
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1497
|
+
* times as needed. Note that it can affect your quota.
|
|
1498
|
+
* We recommend using `listBindingsAsync()`
|
|
1499
|
+
* method described below for async iteration which you can stop as needed.
|
|
1500
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1501
|
+
* for more details and examples.
|
|
1502
|
+
*/
|
|
1503
|
+
listBindingsStream(request?: protos.google.cloud.agentregistry.v1.IListBindingsRequest, options?: CallOptions): Transform;
|
|
1504
|
+
/**
|
|
1505
|
+
* Equivalent to `listBindings`, but returns an iterable object.
|
|
1506
|
+
*
|
|
1507
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
1508
|
+
* @param {Object} request
|
|
1509
|
+
* The request object that will be sent.
|
|
1510
|
+
* @param {string} request.parent
|
|
1511
|
+
* Required. The project and location to list bindings in.
|
|
1512
|
+
* Expected format: `projects/{project}/locations/{location}`.
|
|
1513
|
+
* @param {number} [request.pageSize]
|
|
1514
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1515
|
+
* requested. Page size is 500 if unspecified and is capped at `500` even if a
|
|
1516
|
+
* larger value is given.
|
|
1517
|
+
* @param {string} [request.pageToken]
|
|
1518
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1519
|
+
* @param {string} [request.filter]
|
|
1520
|
+
* Optional. A query string used to filter the list of bindings returned.
|
|
1521
|
+
* The filter expression must follow AIP-160 syntax.
|
|
1522
|
+
* @param {string} [request.orderBy]
|
|
1523
|
+
* Optional. Hint for how to order the results
|
|
1524
|
+
* @param {object} [options]
|
|
1525
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1526
|
+
* @returns {Object}
|
|
1527
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
1528
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
1529
|
+
* {@link protos.google.cloud.agentregistry.v1.Binding|Binding}. The API will be called under the hood as needed, once per the page,
|
|
1530
|
+
* so you can stop the iteration when you don't need more results.
|
|
1531
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1532
|
+
* for more details and examples.
|
|
1533
|
+
* @example <caption>include:samples/generated/v1/agent_registry.list_bindings.js</caption>
|
|
1534
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_ListBindings_async
|
|
1535
|
+
*/
|
|
1536
|
+
listBindingsAsync(request?: protos.google.cloud.agentregistry.v1.IListBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.agentregistry.v1.IBinding>;
|
|
1537
|
+
/**
|
|
1538
|
+
* Fetches available Bindings.
|
|
1539
|
+
*
|
|
1540
|
+
* @param {Object} request
|
|
1541
|
+
* The request object that will be sent.
|
|
1542
|
+
* @param {string} request.sourceIdentifier
|
|
1543
|
+
* The identifier of the source Agent.
|
|
1544
|
+
* Format:
|
|
1545
|
+
*
|
|
1546
|
+
* * `urn:agent:{publisher}:{namespace}:{name}`
|
|
1547
|
+
* @param {string} [request.targetIdentifier]
|
|
1548
|
+
* Optional. The identifier of the target Agent, MCP Server, or Endpoint.
|
|
1549
|
+
* Format:
|
|
1550
|
+
*
|
|
1551
|
+
* * `urn:agent:{publisher}:{namespace}:{name}`
|
|
1552
|
+
* * `urn:mcp:{publisher}:{namespace}:{name}`
|
|
1553
|
+
* * `urn:endpoint:{publisher}:{namespace}:{name}`
|
|
1554
|
+
* @param {string} request.parent
|
|
1555
|
+
* Required. The parent, in the format
|
|
1556
|
+
* `projects/{project}/locations/{location}`.
|
|
1557
|
+
* @param {number} [request.pageSize]
|
|
1558
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1559
|
+
* requested. Page size is 500 if unspecified and is capped at `500` even if a
|
|
1560
|
+
* larger value is given.
|
|
1561
|
+
* @param {string} [request.pageToken]
|
|
1562
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1563
|
+
* @param {object} [options]
|
|
1564
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1565
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1566
|
+
* The first element of the array is Array of {@link protos.google.cloud.agentregistry.v1.Binding|Binding}.
|
|
1567
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1568
|
+
* times as needed and will merge results from all the pages into this array.
|
|
1569
|
+
* Note that it can affect your quota.
|
|
1570
|
+
* We recommend using `fetchAvailableBindingsAsync()`
|
|
1571
|
+
* method described below for async iteration which you can stop as needed.
|
|
1572
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1573
|
+
* for more details and examples.
|
|
1574
|
+
*/
|
|
1575
|
+
fetchAvailableBindings(request?: protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsRequest, options?: CallOptions): Promise<[
|
|
1576
|
+
protos.google.cloud.agentregistry.v1.IBinding[],
|
|
1577
|
+
protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsRequest | null,
|
|
1578
|
+
protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsResponse
|
|
1579
|
+
]>;
|
|
1580
|
+
fetchAvailableBindings(request: protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsRequest, protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IBinding>): void;
|
|
1581
|
+
fetchAvailableBindings(request: protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsRequest, callback: PaginationCallback<protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsRequest, protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsResponse | null | undefined, protos.google.cloud.agentregistry.v1.IBinding>): void;
|
|
1582
|
+
/**
|
|
1583
|
+
* Equivalent to `fetchAvailableBindings`, but returns a NodeJS Stream object.
|
|
1584
|
+
* @param {Object} request
|
|
1585
|
+
* The request object that will be sent.
|
|
1586
|
+
* @param {string} request.sourceIdentifier
|
|
1587
|
+
* The identifier of the source Agent.
|
|
1588
|
+
* Format:
|
|
1589
|
+
*
|
|
1590
|
+
* * `urn:agent:{publisher}:{namespace}:{name}`
|
|
1591
|
+
* @param {string} [request.targetIdentifier]
|
|
1592
|
+
* Optional. The identifier of the target Agent, MCP Server, or Endpoint.
|
|
1593
|
+
* Format:
|
|
1594
|
+
*
|
|
1595
|
+
* * `urn:agent:{publisher}:{namespace}:{name}`
|
|
1596
|
+
* * `urn:mcp:{publisher}:{namespace}:{name}`
|
|
1597
|
+
* * `urn:endpoint:{publisher}:{namespace}:{name}`
|
|
1598
|
+
* @param {string} request.parent
|
|
1599
|
+
* Required. The parent, in the format
|
|
1600
|
+
* `projects/{project}/locations/{location}`.
|
|
1601
|
+
* @param {number} [request.pageSize]
|
|
1602
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1603
|
+
* requested. Page size is 500 if unspecified and is capped at `500` even if a
|
|
1604
|
+
* larger value is given.
|
|
1605
|
+
* @param {string} [request.pageToken]
|
|
1606
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1607
|
+
* @param {object} [options]
|
|
1608
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1609
|
+
* @returns {Stream}
|
|
1610
|
+
* An object stream which emits an object representing {@link protos.google.cloud.agentregistry.v1.Binding|Binding} on 'data' event.
|
|
1611
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
1612
|
+
* times as needed. Note that it can affect your quota.
|
|
1613
|
+
* We recommend using `fetchAvailableBindingsAsync()`
|
|
1614
|
+
* method described below for async iteration which you can stop as needed.
|
|
1615
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1616
|
+
* for more details and examples.
|
|
1617
|
+
*/
|
|
1618
|
+
fetchAvailableBindingsStream(request?: protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsRequest, options?: CallOptions): Transform;
|
|
1619
|
+
/**
|
|
1620
|
+
* Equivalent to `fetchAvailableBindings`, but returns an iterable object.
|
|
1621
|
+
*
|
|
1622
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
1623
|
+
* @param {Object} request
|
|
1624
|
+
* The request object that will be sent.
|
|
1625
|
+
* @param {string} request.sourceIdentifier
|
|
1626
|
+
* The identifier of the source Agent.
|
|
1627
|
+
* Format:
|
|
1628
|
+
*
|
|
1629
|
+
* * `urn:agent:{publisher}:{namespace}:{name}`
|
|
1630
|
+
* @param {string} [request.targetIdentifier]
|
|
1631
|
+
* Optional. The identifier of the target Agent, MCP Server, or Endpoint.
|
|
1632
|
+
* Format:
|
|
1633
|
+
*
|
|
1634
|
+
* * `urn:agent:{publisher}:{namespace}:{name}`
|
|
1635
|
+
* * `urn:mcp:{publisher}:{namespace}:{name}`
|
|
1636
|
+
* * `urn:endpoint:{publisher}:{namespace}:{name}`
|
|
1637
|
+
* @param {string} request.parent
|
|
1638
|
+
* Required. The parent, in the format
|
|
1639
|
+
* `projects/{project}/locations/{location}`.
|
|
1640
|
+
* @param {number} [request.pageSize]
|
|
1641
|
+
* Optional. Requested page size. Server may return fewer items than
|
|
1642
|
+
* requested. Page size is 500 if unspecified and is capped at `500` even if a
|
|
1643
|
+
* larger value is given.
|
|
1644
|
+
* @param {string} [request.pageToken]
|
|
1645
|
+
* Optional. A token identifying a page of results the server should return.
|
|
1646
|
+
* @param {object} [options]
|
|
1647
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1648
|
+
* @returns {Object}
|
|
1649
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
1650
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
1651
|
+
* {@link protos.google.cloud.agentregistry.v1.Binding|Binding}. The API will be called under the hood as needed, once per the page,
|
|
1652
|
+
* so you can stop the iteration when you don't need more results.
|
|
1653
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1654
|
+
* for more details and examples.
|
|
1655
|
+
* @example <caption>include:samples/generated/v1/agent_registry.fetch_available_bindings.js</caption>
|
|
1656
|
+
* region_tag:agentregistry_v1_generated_AgentRegistry_FetchAvailableBindings_async
|
|
1657
|
+
*/
|
|
1658
|
+
fetchAvailableBindingsAsync(request?: protos.google.cloud.agentregistry.v1.IFetchAvailableBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.agentregistry.v1.IBinding>;
|
|
1659
|
+
/**
|
|
1660
|
+
* Gets information about a location.
|
|
1661
|
+
*
|
|
1662
|
+
* @param {Object} request
|
|
1663
|
+
* The request object that will be sent.
|
|
1664
|
+
* @param {string} request.name
|
|
1665
|
+
* Resource name for the location.
|
|
1666
|
+
* @param {object} [options]
|
|
1667
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
|
1668
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
1669
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
|
1670
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
1671
|
+
* for more details and examples.
|
|
1672
|
+
* @example
|
|
1673
|
+
* ```
|
|
1674
|
+
* const [response] = await client.getLocation(request);
|
|
1675
|
+
* ```
|
|
1676
|
+
*/
|
|
1677
|
+
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
|
|
1678
|
+
/**
|
|
1679
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
|
1680
|
+
*
|
|
1681
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
1682
|
+
* @param {Object} request
|
|
1683
|
+
* The request object that will be sent.
|
|
1684
|
+
* @param {string} request.name
|
|
1685
|
+
* The resource that owns the locations collection, if applicable.
|
|
1686
|
+
* @param {string} request.filter
|
|
1687
|
+
* The standard list filter.
|
|
1688
|
+
* @param {number} request.pageSize
|
|
1689
|
+
* The standard list page size.
|
|
1690
|
+
* @param {string} request.pageToken
|
|
1691
|
+
* The standard list page token.
|
|
1692
|
+
* @param {object} [options]
|
|
1693
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
1694
|
+
* @returns {Object}
|
|
1695
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
1696
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
1697
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
|
1698
|
+
* so you can stop the iteration when you don't need more results.
|
|
1699
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
1700
|
+
* for more details and examples.
|
|
1701
|
+
* @example
|
|
1702
|
+
* ```
|
|
1703
|
+
* const iterable = client.listLocationsAsync(request);
|
|
1704
|
+
* for await (const response of iterable) {
|
|
1705
|
+
* // process response
|
|
1706
|
+
* }
|
|
1707
|
+
* ```
|
|
1708
|
+
*/
|
|
1709
|
+
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
|
1710
|
+
/**
|
|
1711
|
+
* Gets the latest state of a long-running operation. Clients can use this
|
|
1712
|
+
* method to poll the operation result at intervals as recommended by the API
|
|
1713
|
+
* service.
|
|
1714
|
+
*
|
|
1715
|
+
* @param {Object} request - The request object that will be sent.
|
|
1716
|
+
* @param {string} request.name - The name of the operation resource.
|
|
1717
|
+
* @param {Object=} options
|
|
1718
|
+
* Optional parameters. You can override the default settings for this call,
|
|
1719
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
|
1720
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
|
1721
|
+
* for the details.
|
|
1722
|
+
* @param {function(?Error, ?Object)=} callback
|
|
1723
|
+
* The function which will be called with the result of the API call.
|
|
1724
|
+
*
|
|
1725
|
+
* The second parameter to the callback is an object representing
|
|
1726
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
|
1727
|
+
* @return {Promise} - The promise which resolves to an array.
|
|
1728
|
+
* The first element of the array is an object representing
|
|
1729
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
|
1730
|
+
* The promise has a method named "cancel" which cancels the ongoing API call.
|
|
1731
|
+
*
|
|
1732
|
+
* @example
|
|
1733
|
+
* ```
|
|
1734
|
+
* const client = longrunning.operationsClient();
|
|
1735
|
+
* const name = '';
|
|
1736
|
+
* const [response] = await client.getOperation({name});
|
|
1737
|
+
* // doThingsWith(response)
|
|
1738
|
+
* ```
|
|
1739
|
+
*/
|
|
1740
|
+
getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
|
|
1741
|
+
/**
|
|
1742
|
+
* Lists operations that match the specified filter in the request. If the
|
|
1743
|
+
* server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
|
|
1744
|
+
*
|
|
1745
|
+
* For-await-of syntax is used with the iterable to recursively get response element on-demand.
|
|
1746
|
+
*
|
|
1747
|
+
* @param {Object} request - The request object that will be sent.
|
|
1748
|
+
* @param {string} request.name - The name of the operation collection.
|
|
1749
|
+
* @param {string} request.filter - The standard list filter.
|
|
1750
|
+
* @param {number=} request.pageSize -
|
|
1751
|
+
* The maximum number of resources contained in the underlying API
|
|
1752
|
+
* response. If page streaming is performed per-resource, this
|
|
1753
|
+
* parameter does not affect the return value. If page streaming is
|
|
1754
|
+
* performed per-page, this determines the maximum number of
|
|
1755
|
+
* resources in a page.
|
|
1756
|
+
* @param {Object=} options
|
|
1757
|
+
* Optional parameters. You can override the default settings for this call,
|
|
1758
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
|
1759
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
|
|
1760
|
+
* details.
|
|
1761
|
+
* @returns {Object}
|
|
1762
|
+
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
|
|
1763
|
+
*
|
|
1764
|
+
* @example
|
|
1765
|
+
* ```
|
|
1766
|
+
* const client = longrunning.operationsClient();
|
|
1767
|
+
* for await (const response of client.listOperationsAsync(request));
|
|
1768
|
+
* // doThingsWith(response)
|
|
1769
|
+
* ```
|
|
1770
|
+
*/
|
|
1771
|
+
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
|
|
1772
|
+
/**
|
|
1773
|
+
* Starts asynchronous cancellation on a long-running operation. The server
|
|
1774
|
+
* makes a best effort to cancel the operation, but success is not
|
|
1775
|
+
* guaranteed. If the server doesn't support this method, it returns
|
|
1776
|
+
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
|
1777
|
+
* {@link Operations.GetOperation} or
|
|
1778
|
+
* other methods to check whether the cancellation succeeded or whether the
|
|
1779
|
+
* operation completed despite cancellation. On successful cancellation,
|
|
1780
|
+
* the operation is not deleted; instead, it becomes an operation with
|
|
1781
|
+
* an {@link Operation.error} value with a {@link google.rpc.Status.code} of
|
|
1782
|
+
* 1, corresponding to `Code.CANCELLED`.
|
|
1783
|
+
*
|
|
1784
|
+
* @param {Object} request - The request object that will be sent.
|
|
1785
|
+
* @param {string} request.name - The name of the operation resource to be cancelled.
|
|
1786
|
+
* @param {Object=} options
|
|
1787
|
+
* Optional parameters. You can override the default settings for this call,
|
|
1788
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
|
1789
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
|
|
1790
|
+
* details.
|
|
1791
|
+
* @param {function(?Error)=} callback
|
|
1792
|
+
* The function which will be called with the result of the API call.
|
|
1793
|
+
* @return {Promise} - The promise which resolves when API call finishes.
|
|
1794
|
+
* The promise has a method named "cancel" which cancels the ongoing API
|
|
1795
|
+
* call.
|
|
1796
|
+
*
|
|
1797
|
+
* @example
|
|
1798
|
+
* ```
|
|
1799
|
+
* const client = longrunning.operationsClient();
|
|
1800
|
+
* await client.cancelOperation({name: ''});
|
|
1801
|
+
* ```
|
|
1802
|
+
*/
|
|
1803
|
+
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
|
|
1804
|
+
/**
|
|
1805
|
+
* Deletes a long-running operation. This method indicates that the client is
|
|
1806
|
+
* no longer interested in the operation result. It does not cancel the
|
|
1807
|
+
* operation. If the server doesn't support this method, it returns
|
|
1808
|
+
* `google.rpc.Code.UNIMPLEMENTED`.
|
|
1809
|
+
*
|
|
1810
|
+
* @param {Object} request - The request object that will be sent.
|
|
1811
|
+
* @param {string} request.name - The name of the operation resource to be deleted.
|
|
1812
|
+
* @param {Object=} options
|
|
1813
|
+
* Optional parameters. You can override the default settings for this call,
|
|
1814
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
|
1815
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
|
1816
|
+
* for the details.
|
|
1817
|
+
* @param {function(?Error)=} callback
|
|
1818
|
+
* The function which will be called with the result of the API call.
|
|
1819
|
+
* @return {Promise} - The promise which resolves when API call finishes.
|
|
1820
|
+
* The promise has a method named "cancel" which cancels the ongoing API
|
|
1821
|
+
* call.
|
|
1822
|
+
*
|
|
1823
|
+
* @example
|
|
1824
|
+
* ```
|
|
1825
|
+
* const client = longrunning.operationsClient();
|
|
1826
|
+
* await client.deleteOperation({name: ''});
|
|
1827
|
+
* ```
|
|
1828
|
+
*/
|
|
1829
|
+
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
|
|
1830
|
+
/**
|
|
1831
|
+
* Return a fully-qualified agent resource name string.
|
|
1832
|
+
*
|
|
1833
|
+
* @param {string} project
|
|
1834
|
+
* @param {string} location
|
|
1835
|
+
* @param {string} agent
|
|
1836
|
+
* @returns {string} Resource name string.
|
|
1837
|
+
*/
|
|
1838
|
+
agentPath(project: string, location: string, agent: string): string;
|
|
1839
|
+
/**
|
|
1840
|
+
* Parse the project from Agent resource.
|
|
1841
|
+
*
|
|
1842
|
+
* @param {string} agentName
|
|
1843
|
+
* A fully-qualified path representing Agent resource.
|
|
1844
|
+
* @returns {string} A string representing the project.
|
|
1845
|
+
*/
|
|
1846
|
+
matchProjectFromAgentName(agentName: string): string | number;
|
|
1847
|
+
/**
|
|
1848
|
+
* Parse the location from Agent resource.
|
|
1849
|
+
*
|
|
1850
|
+
* @param {string} agentName
|
|
1851
|
+
* A fully-qualified path representing Agent resource.
|
|
1852
|
+
* @returns {string} A string representing the location.
|
|
1853
|
+
*/
|
|
1854
|
+
matchLocationFromAgentName(agentName: string): string | number;
|
|
1855
|
+
/**
|
|
1856
|
+
* Parse the agent from Agent resource.
|
|
1857
|
+
*
|
|
1858
|
+
* @param {string} agentName
|
|
1859
|
+
* A fully-qualified path representing Agent resource.
|
|
1860
|
+
* @returns {string} A string representing the agent.
|
|
1861
|
+
*/
|
|
1862
|
+
matchAgentFromAgentName(agentName: string): string | number;
|
|
1863
|
+
/**
|
|
1864
|
+
* Return a fully-qualified binding resource name string.
|
|
1865
|
+
*
|
|
1866
|
+
* @param {string} project
|
|
1867
|
+
* @param {string} location
|
|
1868
|
+
* @param {string} binding
|
|
1869
|
+
* @returns {string} Resource name string.
|
|
1870
|
+
*/
|
|
1871
|
+
bindingPath(project: string, location: string, binding: string): string;
|
|
1872
|
+
/**
|
|
1873
|
+
* Parse the project from Binding resource.
|
|
1874
|
+
*
|
|
1875
|
+
* @param {string} bindingName
|
|
1876
|
+
* A fully-qualified path representing Binding resource.
|
|
1877
|
+
* @returns {string} A string representing the project.
|
|
1878
|
+
*/
|
|
1879
|
+
matchProjectFromBindingName(bindingName: string): string | number;
|
|
1880
|
+
/**
|
|
1881
|
+
* Parse the location from Binding resource.
|
|
1882
|
+
*
|
|
1883
|
+
* @param {string} bindingName
|
|
1884
|
+
* A fully-qualified path representing Binding resource.
|
|
1885
|
+
* @returns {string} A string representing the location.
|
|
1886
|
+
*/
|
|
1887
|
+
matchLocationFromBindingName(bindingName: string): string | number;
|
|
1888
|
+
/**
|
|
1889
|
+
* Parse the binding from Binding resource.
|
|
1890
|
+
*
|
|
1891
|
+
* @param {string} bindingName
|
|
1892
|
+
* A fully-qualified path representing Binding resource.
|
|
1893
|
+
* @returns {string} A string representing the binding.
|
|
1894
|
+
*/
|
|
1895
|
+
matchBindingFromBindingName(bindingName: string): string | number;
|
|
1896
|
+
/**
|
|
1897
|
+
* Return a fully-qualified endpoint resource name string.
|
|
1898
|
+
*
|
|
1899
|
+
* @param {string} project
|
|
1900
|
+
* @param {string} location
|
|
1901
|
+
* @param {string} endpoint
|
|
1902
|
+
* @returns {string} Resource name string.
|
|
1903
|
+
*/
|
|
1904
|
+
endpointPath(project: string, location: string, endpoint: string): string;
|
|
1905
|
+
/**
|
|
1906
|
+
* Parse the project from Endpoint resource.
|
|
1907
|
+
*
|
|
1908
|
+
* @param {string} endpointName
|
|
1909
|
+
* A fully-qualified path representing Endpoint resource.
|
|
1910
|
+
* @returns {string} A string representing the project.
|
|
1911
|
+
*/
|
|
1912
|
+
matchProjectFromEndpointName(endpointName: string): string | number;
|
|
1913
|
+
/**
|
|
1914
|
+
* Parse the location from Endpoint resource.
|
|
1915
|
+
*
|
|
1916
|
+
* @param {string} endpointName
|
|
1917
|
+
* A fully-qualified path representing Endpoint resource.
|
|
1918
|
+
* @returns {string} A string representing the location.
|
|
1919
|
+
*/
|
|
1920
|
+
matchLocationFromEndpointName(endpointName: string): string | number;
|
|
1921
|
+
/**
|
|
1922
|
+
* Parse the endpoint from Endpoint resource.
|
|
1923
|
+
*
|
|
1924
|
+
* @param {string} endpointName
|
|
1925
|
+
* A fully-qualified path representing Endpoint resource.
|
|
1926
|
+
* @returns {string} A string representing the endpoint.
|
|
1927
|
+
*/
|
|
1928
|
+
matchEndpointFromEndpointName(endpointName: string): string | number;
|
|
1929
|
+
/**
|
|
1930
|
+
* Return a fully-qualified location resource name string.
|
|
1931
|
+
*
|
|
1932
|
+
* @param {string} project
|
|
1933
|
+
* @param {string} location
|
|
1934
|
+
* @returns {string} Resource name string.
|
|
1935
|
+
*/
|
|
1936
|
+
locationPath(project: string, location: string): string;
|
|
1937
|
+
/**
|
|
1938
|
+
* Parse the project from Location resource.
|
|
1939
|
+
*
|
|
1940
|
+
* @param {string} locationName
|
|
1941
|
+
* A fully-qualified path representing Location resource.
|
|
1942
|
+
* @returns {string} A string representing the project.
|
|
1943
|
+
*/
|
|
1944
|
+
matchProjectFromLocationName(locationName: string): string | number;
|
|
1945
|
+
/**
|
|
1946
|
+
* Parse the location from Location resource.
|
|
1947
|
+
*
|
|
1948
|
+
* @param {string} locationName
|
|
1949
|
+
* A fully-qualified path representing Location resource.
|
|
1950
|
+
* @returns {string} A string representing the location.
|
|
1951
|
+
*/
|
|
1952
|
+
matchLocationFromLocationName(locationName: string): string | number;
|
|
1953
|
+
/**
|
|
1954
|
+
* Return a fully-qualified mcpServer resource name string.
|
|
1955
|
+
*
|
|
1956
|
+
* @param {string} project
|
|
1957
|
+
* @param {string} location
|
|
1958
|
+
* @param {string} mcp_server
|
|
1959
|
+
* @returns {string} Resource name string.
|
|
1960
|
+
*/
|
|
1961
|
+
mcpServerPath(project: string, location: string, mcpServer: string): string;
|
|
1962
|
+
/**
|
|
1963
|
+
* Parse the project from McpServer resource.
|
|
1964
|
+
*
|
|
1965
|
+
* @param {string} mcpServerName
|
|
1966
|
+
* A fully-qualified path representing McpServer resource.
|
|
1967
|
+
* @returns {string} A string representing the project.
|
|
1968
|
+
*/
|
|
1969
|
+
matchProjectFromMcpServerName(mcpServerName: string): string | number;
|
|
1970
|
+
/**
|
|
1971
|
+
* Parse the location from McpServer resource.
|
|
1972
|
+
*
|
|
1973
|
+
* @param {string} mcpServerName
|
|
1974
|
+
* A fully-qualified path representing McpServer resource.
|
|
1975
|
+
* @returns {string} A string representing the location.
|
|
1976
|
+
*/
|
|
1977
|
+
matchLocationFromMcpServerName(mcpServerName: string): string | number;
|
|
1978
|
+
/**
|
|
1979
|
+
* Parse the mcp_server from McpServer resource.
|
|
1980
|
+
*
|
|
1981
|
+
* @param {string} mcpServerName
|
|
1982
|
+
* A fully-qualified path representing McpServer resource.
|
|
1983
|
+
* @returns {string} A string representing the mcp_server.
|
|
1984
|
+
*/
|
|
1985
|
+
matchMcpServerFromMcpServerName(mcpServerName: string): string | number;
|
|
1986
|
+
/**
|
|
1987
|
+
* Return a fully-qualified project resource name string.
|
|
1988
|
+
*
|
|
1989
|
+
* @param {string} project
|
|
1990
|
+
* @returns {string} Resource name string.
|
|
1991
|
+
*/
|
|
1992
|
+
projectPath(project: string): string;
|
|
1993
|
+
/**
|
|
1994
|
+
* Parse the project from Project resource.
|
|
1995
|
+
*
|
|
1996
|
+
* @param {string} projectName
|
|
1997
|
+
* A fully-qualified path representing Project resource.
|
|
1998
|
+
* @returns {string} A string representing the project.
|
|
1999
|
+
*/
|
|
2000
|
+
matchProjectFromProjectName(projectName: string): string | number;
|
|
2001
|
+
/**
|
|
2002
|
+
* Return a fully-qualified service resource name string.
|
|
2003
|
+
*
|
|
2004
|
+
* @param {string} project
|
|
2005
|
+
* @param {string} location
|
|
2006
|
+
* @param {string} service
|
|
2007
|
+
* @returns {string} Resource name string.
|
|
2008
|
+
*/
|
|
2009
|
+
servicePath(project: string, location: string, service: string): string;
|
|
2010
|
+
/**
|
|
2011
|
+
* Parse the project from Service resource.
|
|
2012
|
+
*
|
|
2013
|
+
* @param {string} serviceName
|
|
2014
|
+
* A fully-qualified path representing Service resource.
|
|
2015
|
+
* @returns {string} A string representing the project.
|
|
2016
|
+
*/
|
|
2017
|
+
matchProjectFromServiceName(serviceName: string): string | number;
|
|
2018
|
+
/**
|
|
2019
|
+
* Parse the location from Service resource.
|
|
2020
|
+
*
|
|
2021
|
+
* @param {string} serviceName
|
|
2022
|
+
* A fully-qualified path representing Service resource.
|
|
2023
|
+
* @returns {string} A string representing the location.
|
|
2024
|
+
*/
|
|
2025
|
+
matchLocationFromServiceName(serviceName: string): string | number;
|
|
2026
|
+
/**
|
|
2027
|
+
* Parse the service from Service resource.
|
|
2028
|
+
*
|
|
2029
|
+
* @param {string} serviceName
|
|
2030
|
+
* A fully-qualified path representing Service resource.
|
|
2031
|
+
* @returns {string} A string representing the service.
|
|
2032
|
+
*/
|
|
2033
|
+
matchServiceFromServiceName(serviceName: string): string | number;
|
|
2034
|
+
/**
|
|
2035
|
+
* Terminate the gRPC channel and close the client.
|
|
2036
|
+
*
|
|
2037
|
+
* The client will no longer be usable and all future behavior is undefined.
|
|
2038
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
|
2039
|
+
*/
|
|
2040
|
+
close(): Promise<void>;
|
|
2041
|
+
}
|