@google-cloud/discoveryengine 1.1.0 → 1.2.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/CHANGELOG.md +7 -0
- package/README.md +26 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +155 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +134 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +138 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +121 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +318 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +343 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +159 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +221 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +312 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +260 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +851 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +152 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +475 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +154 -0
- package/build/protos/protos.d.ts +12587 -7
- package/build/protos/protos.js +34918 -3126
- package/build/protos/protos.json +3458 -5
- package/build/src/index.d.ts +3 -1
- package/build/src/index.js +4 -1
- package/build/src/v1alpha/completion_service_client.d.ts +603 -0
- package/build/src/v1alpha/completion_service_client.js +843 -0
- package/build/src/v1alpha/completion_service_client_config.json +43 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +998 -0
- package/build/src/v1alpha/conversational_search_service_client.js +1275 -0
- package/build/src/v1alpha/conversational_search_service_client_config.json +68 -0
- package/build/src/v1alpha/document_service_client.d.ts +1140 -0
- package/build/src/v1alpha/document_service_client.js +1393 -0
- package/build/src/v1alpha/document_service_client_config.json +82 -0
- package/build/src/v1alpha/index.d.ts +8 -0
- package/build/src/v1alpha/index.js +37 -0
- package/build/src/v1alpha/recommendation_service_client.d.ts +735 -0
- package/build/src/v1alpha/recommendation_service_client.js +938 -0
- package/build/src/v1alpha/recommendation_service_client_config.json +43 -0
- package/build/src/v1alpha/schema_service_client.d.ts +935 -0
- package/build/src/v1alpha/schema_service_client.js +1327 -0
- package/build/src/v1alpha/schema_service_client_config.json +63 -0
- package/build/src/v1alpha/search_service_client.d.ts +1208 -0
- package/build/src/v1alpha/search_service_client.js +1432 -0
- package/build/src/v1alpha/search_service_client_config.json +43 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +704 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +1087 -0
- package/build/src/v1alpha/site_search_engine_service_client_config.json +30 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +853 -0
- package/build/src/v1alpha/user_event_service_client.js +1174 -0
- package/build/src/v1alpha/user_event_service_client_config.json +67 -0
- package/package.json +3 -3
@@ -0,0 +1,935 @@
|
|
1
|
+
/// <reference types="node" />
|
2
|
+
import type * as gax from 'google-gax';
|
3
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
|
4
|
+
import { Transform } from 'stream';
|
5
|
+
import * as protos from '../../protos/protos';
|
6
|
+
/**
|
7
|
+
* Service for managing {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}s.
|
8
|
+
* @class
|
9
|
+
* @memberof v1alpha
|
10
|
+
*/
|
11
|
+
export declare class SchemaServiceClient {
|
12
|
+
private _terminated;
|
13
|
+
private _opts;
|
14
|
+
private _providedCustomServicePath;
|
15
|
+
private _gaxModule;
|
16
|
+
private _gaxGrpc;
|
17
|
+
private _protos;
|
18
|
+
private _defaults;
|
19
|
+
auth: gax.GoogleAuth;
|
20
|
+
descriptors: Descriptors;
|
21
|
+
warn: (code: string, message: string, warnType?: string) => void;
|
22
|
+
innerApiCalls: {
|
23
|
+
[name: string]: Function;
|
24
|
+
};
|
25
|
+
locationsClient: LocationsClient;
|
26
|
+
pathTemplates: {
|
27
|
+
[name: string]: gax.PathTemplate;
|
28
|
+
};
|
29
|
+
operationsClient: gax.OperationsClient;
|
30
|
+
schemaServiceStub?: Promise<{
|
31
|
+
[name: string]: Function;
|
32
|
+
}>;
|
33
|
+
/**
|
34
|
+
* Construct an instance of SchemaServiceClient.
|
35
|
+
*
|
36
|
+
* @param {object} [options] - The configuration object.
|
37
|
+
* The options accepted by the constructor are described in detail
|
38
|
+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
|
39
|
+
* The common options are:
|
40
|
+
* @param {object} [options.credentials] - Credentials object.
|
41
|
+
* @param {string} [options.credentials.client_email]
|
42
|
+
* @param {string} [options.credentials.private_key]
|
43
|
+
* @param {string} [options.email] - Account email address. Required when
|
44
|
+
* using a .pem or .p12 keyFilename.
|
45
|
+
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
|
46
|
+
* .p12 key downloaded from the Google Developers Console. If you provide
|
47
|
+
* a path to a JSON file, the projectId option below is not necessary.
|
48
|
+
* NOTE: .pem and .p12 require you to specify options.email as well.
|
49
|
+
* @param {number} [options.port] - The port on which to connect to
|
50
|
+
* the remote host.
|
51
|
+
* @param {string} [options.projectId] - The project ID from the Google
|
52
|
+
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
53
|
+
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
54
|
+
* app is running in an environment which supports
|
55
|
+
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
|
56
|
+
* your project ID will be detected automatically.
|
57
|
+
* @param {string} [options.apiEndpoint] - The domain name of the
|
58
|
+
* API remote host.
|
59
|
+
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
60
|
+
* Follows the structure of {@link gapicConfig}.
|
61
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
62
|
+
* For more information, please check the
|
63
|
+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
64
|
+
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
65
|
+
* need to avoid loading the default gRPC version and want to use the fallback
|
66
|
+
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
67
|
+
* ```
|
68
|
+
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
69
|
+
* const client = new SchemaServiceClient({fallback: true}, gax);
|
70
|
+
* ```
|
71
|
+
*/
|
72
|
+
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
73
|
+
/**
|
74
|
+
* Initialize the client.
|
75
|
+
* Performs asynchronous operations (such as authentication) and prepares the client.
|
76
|
+
* This function will be called automatically when any class method is called for the
|
77
|
+
* first time, but if you need to initialize it before calling an actual method,
|
78
|
+
* feel free to call initialize() directly.
|
79
|
+
*
|
80
|
+
* You can await on this method if you want to make sure the client is initialized.
|
81
|
+
*
|
82
|
+
* @returns {Promise} A promise that resolves to an authenticated service stub.
|
83
|
+
*/
|
84
|
+
initialize(): Promise<{
|
85
|
+
[name: string]: Function;
|
86
|
+
}>;
|
87
|
+
/**
|
88
|
+
* The DNS address for this API service.
|
89
|
+
* @returns {string} The DNS address for this service.
|
90
|
+
*/
|
91
|
+
static get servicePath(): string;
|
92
|
+
/**
|
93
|
+
* The DNS address for this API service - same as servicePath(),
|
94
|
+
* exists for compatibility reasons.
|
95
|
+
* @returns {string} The DNS address for this service.
|
96
|
+
*/
|
97
|
+
static get apiEndpoint(): string;
|
98
|
+
/**
|
99
|
+
* The port for this API service.
|
100
|
+
* @returns {number} The default port for this service.
|
101
|
+
*/
|
102
|
+
static get port(): number;
|
103
|
+
/**
|
104
|
+
* The scopes needed to make gRPC calls for every method defined
|
105
|
+
* in this service.
|
106
|
+
* @returns {string[]} List of default scopes.
|
107
|
+
*/
|
108
|
+
static get scopes(): string[];
|
109
|
+
getProjectId(): Promise<string>;
|
110
|
+
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
111
|
+
/**
|
112
|
+
* Gets a {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}.
|
113
|
+
*
|
114
|
+
* @param {Object} request
|
115
|
+
* The request object that will be sent.
|
116
|
+
* @param {string} request.name
|
117
|
+
* Required. The full resource name of the schema, in the format of
|
118
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
|
119
|
+
* @param {object} [options]
|
120
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
121
|
+
* @returns {Promise} - The promise which resolves to an array.
|
122
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}.
|
123
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
124
|
+
* for more details and examples.
|
125
|
+
* @example <caption>include:samples/generated/v1alpha/schema_service.get_schema.js</caption>
|
126
|
+
* region_tag:discoveryengine_v1alpha_generated_SchemaService_GetSchema_async
|
127
|
+
*/
|
128
|
+
getSchema(request?: protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest, options?: CallOptions): Promise<[
|
129
|
+
protos.google.cloud.discoveryengine.v1alpha.ISchema,
|
130
|
+
protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest | undefined,
|
131
|
+
{} | undefined
|
132
|
+
]>;
|
133
|
+
getSchema(request: protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
|
134
|
+
getSchema(request: protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
|
135
|
+
/**
|
136
|
+
* Creates a {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}.
|
137
|
+
*
|
138
|
+
* @param {Object} request
|
139
|
+
* The request object that will be sent.
|
140
|
+
* @param {string} request.parent
|
141
|
+
* Required. The parent data store resource name, in the format of
|
142
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
143
|
+
* @param {google.cloud.discoveryengine.v1alpha.Schema} request.schema
|
144
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema} to
|
145
|
+
* create.
|
146
|
+
* @param {string} request.schemaId
|
147
|
+
* Required. The ID to use for the
|
148
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}, which will become
|
149
|
+
* the final component of the
|
150
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema.name|Schema.name}.
|
151
|
+
*
|
152
|
+
* This field should conform to
|
153
|
+
* [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
|
154
|
+
* limit of 63 characters.
|
155
|
+
* @param {object} [options]
|
156
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
157
|
+
* @returns {Promise} - The promise which resolves to an array.
|
158
|
+
* The first element of the array is an object representing
|
159
|
+
* a long running operation. Its `promise()` method returns a promise
|
160
|
+
* you can `await` for.
|
161
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
162
|
+
* for more details and examples.
|
163
|
+
* @example <caption>include:samples/generated/v1alpha/schema_service.create_schema.js</caption>
|
164
|
+
* region_tag:discoveryengine_v1alpha_generated_SchemaService_CreateSchema_async
|
165
|
+
*/
|
166
|
+
createSchema(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaRequest, options?: CallOptions): Promise<[
|
167
|
+
LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaMetadata>,
|
168
|
+
protos.google.longrunning.IOperation | undefined,
|
169
|
+
{} | undefined
|
170
|
+
]>;
|
171
|
+
createSchema(request: protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
172
|
+
createSchema(request: protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.ICreateSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
173
|
+
/**
|
174
|
+
* Check the status of the long running operation returned by `createSchema()`.
|
175
|
+
* @param {String} name
|
176
|
+
* The operation name that will be passed.
|
177
|
+
* @returns {Promise} - The promise which resolves to an object.
|
178
|
+
* The decoded operation object has result and metadata field to get information from.
|
179
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
180
|
+
* for more details and examples.
|
181
|
+
* @example <caption>include:samples/generated/v1alpha/schema_service.create_schema.js</caption>
|
182
|
+
* region_tag:discoveryengine_v1alpha_generated_SchemaService_CreateSchema_async
|
183
|
+
*/
|
184
|
+
checkCreateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Schema, protos.google.cloud.discoveryengine.v1alpha.CreateSchemaMetadata>>;
|
185
|
+
/**
|
186
|
+
* Updates a {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}.
|
187
|
+
*
|
188
|
+
* @param {Object} request
|
189
|
+
* The request object that will be sent.
|
190
|
+
* @param {google.cloud.discoveryengine.v1alpha.Schema} request.schema
|
191
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema} to
|
192
|
+
* update.
|
193
|
+
* @param {boolean} request.allowMissing
|
194
|
+
* If set to true, and the
|
195
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema} is not found, a new
|
196
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema} will be created. In
|
197
|
+
* this situation, `update_mask` is ignored.
|
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
|
202
|
+
* a long running operation. Its `promise()` method returns a promise
|
203
|
+
* you can `await` for.
|
204
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
205
|
+
* for more details and examples.
|
206
|
+
* @example <caption>include:samples/generated/v1alpha/schema_service.update_schema.js</caption>
|
207
|
+
* region_tag:discoveryengine_v1alpha_generated_SchemaService_UpdateSchema_async
|
208
|
+
*/
|
209
|
+
updateSchema(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaRequest, options?: CallOptions): Promise<[
|
210
|
+
LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaMetadata>,
|
211
|
+
protos.google.longrunning.IOperation | undefined,
|
212
|
+
{} | undefined
|
213
|
+
]>;
|
214
|
+
updateSchema(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
215
|
+
updateSchema(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISchema, protos.google.cloud.discoveryengine.v1alpha.IUpdateSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
216
|
+
/**
|
217
|
+
* Check the status of the long running operation returned by `updateSchema()`.
|
218
|
+
* @param {String} name
|
219
|
+
* The operation name that will be passed.
|
220
|
+
* @returns {Promise} - The promise which resolves to an object.
|
221
|
+
* The decoded operation object has result and metadata field to get information from.
|
222
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
223
|
+
* for more details and examples.
|
224
|
+
* @example <caption>include:samples/generated/v1alpha/schema_service.update_schema.js</caption>
|
225
|
+
* region_tag:discoveryengine_v1alpha_generated_SchemaService_UpdateSchema_async
|
226
|
+
*/
|
227
|
+
checkUpdateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Schema, protos.google.cloud.discoveryengine.v1alpha.UpdateSchemaMetadata>>;
|
228
|
+
/**
|
229
|
+
* Deletes a {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}.
|
230
|
+
*
|
231
|
+
* @param {Object} request
|
232
|
+
* The request object that will be sent.
|
233
|
+
* @param {string} request.name
|
234
|
+
* Required. The full resource name of the schema, in the format of
|
235
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
|
236
|
+
* @param {object} [options]
|
237
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
238
|
+
* @returns {Promise} - The promise which resolves to an array.
|
239
|
+
* The first element of the array is an object representing
|
240
|
+
* a long running operation. Its `promise()` method returns a promise
|
241
|
+
* you can `await` for.
|
242
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
243
|
+
* for more details and examples.
|
244
|
+
* @example <caption>include:samples/generated/v1alpha/schema_service.delete_schema.js</caption>
|
245
|
+
* region_tag:discoveryengine_v1alpha_generated_SchemaService_DeleteSchema_async
|
246
|
+
*/
|
247
|
+
deleteSchema(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaRequest, options?: CallOptions): Promise<[
|
248
|
+
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaMetadata>,
|
249
|
+
protos.google.longrunning.IOperation | undefined,
|
250
|
+
{} | undefined
|
251
|
+
]>;
|
252
|
+
deleteSchema(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
253
|
+
deleteSchema(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteSchemaMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
254
|
+
/**
|
255
|
+
* Check the status of the long running operation returned by `deleteSchema()`.
|
256
|
+
* @param {String} name
|
257
|
+
* The operation name that will be passed.
|
258
|
+
* @returns {Promise} - The promise which resolves to an object.
|
259
|
+
* The decoded operation object has result and metadata field to get information from.
|
260
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
261
|
+
* for more details and examples.
|
262
|
+
* @example <caption>include:samples/generated/v1alpha/schema_service.delete_schema.js</caption>
|
263
|
+
* region_tag:discoveryengine_v1alpha_generated_SchemaService_DeleteSchema_async
|
264
|
+
*/
|
265
|
+
checkDeleteSchemaProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1alpha.DeleteSchemaMetadata>>;
|
266
|
+
/**
|
267
|
+
* Gets a list of {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}s.
|
268
|
+
*
|
269
|
+
* @param {Object} request
|
270
|
+
* The request object that will be sent.
|
271
|
+
* @param {string} request.parent
|
272
|
+
* Required. The parent data store resource name, in the format of
|
273
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
274
|
+
* @param {number} request.pageSize
|
275
|
+
* The maximum number of
|
276
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}s to return. The
|
277
|
+
* service may return fewer than this value.
|
278
|
+
*
|
279
|
+
* If unspecified, at most 100
|
280
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}s will be returned.
|
281
|
+
*
|
282
|
+
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
283
|
+
* @param {string} request.pageToken
|
284
|
+
* A page token, received from a previous
|
285
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
286
|
+
* call. Provide this to retrieve the subsequent page.
|
287
|
+
*
|
288
|
+
* When paginating, all other parameters provided to
|
289
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
290
|
+
* must match the call that provided the page token.
|
291
|
+
* @param {object} [options]
|
292
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
293
|
+
* @returns {Promise} - The promise which resolves to an array.
|
294
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}.
|
295
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
296
|
+
* times as needed and will merge results from all the pages into this array.
|
297
|
+
* Note that it can affect your quota.
|
298
|
+
* We recommend using `listSchemasAsync()`
|
299
|
+
* method described below for async iteration which you can stop as needed.
|
300
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
301
|
+
* for more details and examples.
|
302
|
+
*/
|
303
|
+
listSchemas(request?: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, options?: CallOptions): Promise<[
|
304
|
+
protos.google.cloud.discoveryengine.v1alpha.ISchema[],
|
305
|
+
protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest | null,
|
306
|
+
protos.google.cloud.discoveryengine.v1alpha.IListSchemasResponse
|
307
|
+
]>;
|
308
|
+
listSchemas(request: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, protos.google.cloud.discoveryengine.v1alpha.IListSchemasResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.ISchema>): void;
|
309
|
+
listSchemas(request: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, protos.google.cloud.discoveryengine.v1alpha.IListSchemasResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.ISchema>): void;
|
310
|
+
/**
|
311
|
+
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
312
|
+
* @param {Object} request
|
313
|
+
* The request object that will be sent.
|
314
|
+
* @param {string} request.parent
|
315
|
+
* Required. The parent data store resource name, in the format of
|
316
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
317
|
+
* @param {number} request.pageSize
|
318
|
+
* The maximum number of
|
319
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}s to return. The
|
320
|
+
* service may return fewer than this value.
|
321
|
+
*
|
322
|
+
* If unspecified, at most 100
|
323
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}s will be returned.
|
324
|
+
*
|
325
|
+
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
326
|
+
* @param {string} request.pageToken
|
327
|
+
* A page token, received from a previous
|
328
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
329
|
+
* call. Provide this to retrieve the subsequent page.
|
330
|
+
*
|
331
|
+
* When paginating, all other parameters provided to
|
332
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
333
|
+
* must match the call that provided the page token.
|
334
|
+
* @param {object} [options]
|
335
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
336
|
+
* @returns {Stream}
|
337
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema} on 'data' event.
|
338
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
339
|
+
* times as needed. Note that it can affect your quota.
|
340
|
+
* We recommend using `listSchemasAsync()`
|
341
|
+
* method described below for async iteration which you can stop as needed.
|
342
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
343
|
+
* for more details and examples.
|
344
|
+
*/
|
345
|
+
listSchemasStream(request?: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, options?: CallOptions): Transform;
|
346
|
+
/**
|
347
|
+
* Equivalent to `listSchemas`, but returns an iterable object.
|
348
|
+
*
|
349
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
350
|
+
* @param {Object} request
|
351
|
+
* The request object that will be sent.
|
352
|
+
* @param {string} request.parent
|
353
|
+
* Required. The parent data store resource name, in the format of
|
354
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
355
|
+
* @param {number} request.pageSize
|
356
|
+
* The maximum number of
|
357
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}s to return. The
|
358
|
+
* service may return fewer than this value.
|
359
|
+
*
|
360
|
+
* If unspecified, at most 100
|
361
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}s will be returned.
|
362
|
+
*
|
363
|
+
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
364
|
+
* @param {string} request.pageToken
|
365
|
+
* A page token, received from a previous
|
366
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
367
|
+
* call. Provide this to retrieve the subsequent page.
|
368
|
+
*
|
369
|
+
* When paginating, all other parameters provided to
|
370
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
371
|
+
* must match the call that provided the page token.
|
372
|
+
* @param {object} [options]
|
373
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
374
|
+
* @returns {Object}
|
375
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
376
|
+
* When you iterate the returned iterable, each element will be an object representing
|
377
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}. The API will be called under the hood as needed, once per the page,
|
378
|
+
* so you can stop the iteration when you don't need more results.
|
379
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
380
|
+
* for more details and examples.
|
381
|
+
* @example <caption>include:samples/generated/v1alpha/schema_service.list_schemas.js</caption>
|
382
|
+
* region_tag:discoveryengine_v1alpha_generated_SchemaService_ListSchemas_async
|
383
|
+
*/
|
384
|
+
listSchemasAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListSchemasRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.ISchema>;
|
385
|
+
/**
|
386
|
+
* Gets information about a location.
|
387
|
+
*
|
388
|
+
* @param {Object} request
|
389
|
+
* The request object that will be sent.
|
390
|
+
* @param {string} request.name
|
391
|
+
* Resource name for the location.
|
392
|
+
* @param {object} [options]
|
393
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
394
|
+
* @returns {Promise} - The promise which resolves to an array.
|
395
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
396
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
397
|
+
* for more details and examples.
|
398
|
+
* @example
|
399
|
+
* ```
|
400
|
+
* const [response] = await client.getLocation(request);
|
401
|
+
* ```
|
402
|
+
*/
|
403
|
+
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>;
|
404
|
+
/**
|
405
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
406
|
+
*
|
407
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
408
|
+
* @param {Object} request
|
409
|
+
* The request object that will be sent.
|
410
|
+
* @param {string} request.name
|
411
|
+
* The resource that owns the locations collection, if applicable.
|
412
|
+
* @param {string} request.filter
|
413
|
+
* The standard list filter.
|
414
|
+
* @param {number} request.pageSize
|
415
|
+
* The standard list page size.
|
416
|
+
* @param {string} request.pageToken
|
417
|
+
* The standard list page token.
|
418
|
+
* @param {object} [options]
|
419
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
420
|
+
* @returns {Object}
|
421
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
422
|
+
* When you iterate the returned iterable, each element will be an object representing
|
423
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
424
|
+
* so you can stop the iteration when you don't need more results.
|
425
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
426
|
+
* for more details and examples.
|
427
|
+
* @example
|
428
|
+
* ```
|
429
|
+
* const iterable = client.listLocationsAsync(request);
|
430
|
+
* for await (const response of iterable) {
|
431
|
+
* // process response
|
432
|
+
* }
|
433
|
+
* ```
|
434
|
+
*/
|
435
|
+
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
436
|
+
/**
|
437
|
+
* Gets the latest state of a long-running operation. Clients can use this
|
438
|
+
* method to poll the operation result at intervals as recommended by the API
|
439
|
+
* service.
|
440
|
+
*
|
441
|
+
* @param {Object} request - The request object that will be sent.
|
442
|
+
* @param {string} request.name - The name of the operation resource.
|
443
|
+
* @param {Object=} options
|
444
|
+
* Optional parameters. You can override the default settings for this call,
|
445
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
446
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
447
|
+
* for the details.
|
448
|
+
* @param {function(?Error, ?Object)=} callback
|
449
|
+
* The function which will be called with the result of the API call.
|
450
|
+
*
|
451
|
+
* The second parameter to the callback is an object representing
|
452
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
453
|
+
* @return {Promise} - The promise which resolves to an array.
|
454
|
+
* The first element of the array is an object representing
|
455
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
456
|
+
* The promise has a method named "cancel" which cancels the ongoing API call.
|
457
|
+
*
|
458
|
+
* @example
|
459
|
+
* ```
|
460
|
+
* const client = longrunning.operationsClient();
|
461
|
+
* const name = '';
|
462
|
+
* const [response] = await client.getOperation({name});
|
463
|
+
* // doThingsWith(response)
|
464
|
+
* ```
|
465
|
+
*/
|
466
|
+
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: 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]>;
|
467
|
+
/**
|
468
|
+
* Lists operations that match the specified filter in the request. If the
|
469
|
+
* server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
|
470
|
+
*
|
471
|
+
* For-await-of syntax is used with the iterable to recursively get response element on-demand.
|
472
|
+
*
|
473
|
+
* @param {Object} request - The request object that will be sent.
|
474
|
+
* @param {string} request.name - The name of the operation collection.
|
475
|
+
* @param {string} request.filter - The standard list filter.
|
476
|
+
* @param {number=} request.pageSize -
|
477
|
+
* The maximum number of resources contained in the underlying API
|
478
|
+
* response. If page streaming is performed per-resource, this
|
479
|
+
* parameter does not affect the return value. If page streaming is
|
480
|
+
* performed per-page, this determines the maximum number of
|
481
|
+
* resources in a page.
|
482
|
+
* @param {Object=} options
|
483
|
+
* Optional parameters. You can override the default settings for this call,
|
484
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
485
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
|
486
|
+
* details.
|
487
|
+
* @returns {Object}
|
488
|
+
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
|
489
|
+
*
|
490
|
+
* @example
|
491
|
+
* ```
|
492
|
+
* const client = longrunning.operationsClient();
|
493
|
+
* for await (const response of client.listOperationsAsync(request));
|
494
|
+
* // doThingsWith(response)
|
495
|
+
* ```
|
496
|
+
*/
|
497
|
+
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
|
498
|
+
/**
|
499
|
+
* Starts asynchronous cancellation on a long-running operation. The server
|
500
|
+
* makes a best effort to cancel the operation, but success is not
|
501
|
+
* guaranteed. If the server doesn't support this method, it returns
|
502
|
+
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
503
|
+
* {@link Operations.GetOperation} or
|
504
|
+
* other methods to check whether the cancellation succeeded or whether the
|
505
|
+
* operation completed despite cancellation. On successful cancellation,
|
506
|
+
* the operation is not deleted; instead, it becomes an operation with
|
507
|
+
* an {@link Operation.error} value with a {@link google.rpc.Status.code} of
|
508
|
+
* 1, corresponding to `Code.CANCELLED`.
|
509
|
+
*
|
510
|
+
* @param {Object} request - The request object that will be sent.
|
511
|
+
* @param {string} request.name - The name of the operation resource to be cancelled.
|
512
|
+
* @param {Object=} options
|
513
|
+
* Optional parameters. You can override the default settings for this call,
|
514
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
515
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
|
516
|
+
* details.
|
517
|
+
* @param {function(?Error)=} callback
|
518
|
+
* The function which will be called with the result of the API call.
|
519
|
+
* @return {Promise} - The promise which resolves when API call finishes.
|
520
|
+
* The promise has a method named "cancel" which cancels the ongoing API
|
521
|
+
* call.
|
522
|
+
*
|
523
|
+
* @example
|
524
|
+
* ```
|
525
|
+
* const client = longrunning.operationsClient();
|
526
|
+
* await client.cancelOperation({name: ''});
|
527
|
+
* ```
|
528
|
+
*/
|
529
|
+
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
|
530
|
+
/**
|
531
|
+
* Deletes a long-running operation. This method indicates that the client is
|
532
|
+
* no longer interested in the operation result. It does not cancel the
|
533
|
+
* operation. If the server doesn't support this method, it returns
|
534
|
+
* `google.rpc.Code.UNIMPLEMENTED`.
|
535
|
+
*
|
536
|
+
* @param {Object} request - The request object that will be sent.
|
537
|
+
* @param {string} request.name - The name of the operation resource to be deleted.
|
538
|
+
* @param {Object=} options
|
539
|
+
* Optional parameters. You can override the default settings for this call,
|
540
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
541
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
542
|
+
* for the details.
|
543
|
+
* @param {function(?Error)=} callback
|
544
|
+
* The function which will be called with the result of the API call.
|
545
|
+
* @return {Promise} - The promise which resolves when API call finishes.
|
546
|
+
* The promise has a method named "cancel" which cancels the ongoing API
|
547
|
+
* call.
|
548
|
+
*
|
549
|
+
* @example
|
550
|
+
* ```
|
551
|
+
* const client = longrunning.operationsClient();
|
552
|
+
* await client.deleteOperation({name: ''});
|
553
|
+
* ```
|
554
|
+
*/
|
555
|
+
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: 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>;
|
556
|
+
/**
|
557
|
+
* Return a fully-qualified projectLocationCollectionDataStore resource name string.
|
558
|
+
*
|
559
|
+
* @param {string} project
|
560
|
+
* @param {string} location
|
561
|
+
* @param {string} collection
|
562
|
+
* @param {string} data_store
|
563
|
+
* @returns {string} Resource name string.
|
564
|
+
*/
|
565
|
+
projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
|
566
|
+
/**
|
567
|
+
* Parse the project from ProjectLocationCollectionDataStore resource.
|
568
|
+
*
|
569
|
+
* @param {string} projectLocationCollectionDataStoreName
|
570
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
571
|
+
* @returns {string} A string representing the project.
|
572
|
+
*/
|
573
|
+
matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
574
|
+
/**
|
575
|
+
* Parse the location from ProjectLocationCollectionDataStore resource.
|
576
|
+
*
|
577
|
+
* @param {string} projectLocationCollectionDataStoreName
|
578
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
579
|
+
* @returns {string} A string representing the location.
|
580
|
+
*/
|
581
|
+
matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
582
|
+
/**
|
583
|
+
* Parse the collection from ProjectLocationCollectionDataStore resource.
|
584
|
+
*
|
585
|
+
* @param {string} projectLocationCollectionDataStoreName
|
586
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
587
|
+
* @returns {string} A string representing the collection.
|
588
|
+
*/
|
589
|
+
matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
590
|
+
/**
|
591
|
+
* Parse the data_store from ProjectLocationCollectionDataStore resource.
|
592
|
+
*
|
593
|
+
* @param {string} projectLocationCollectionDataStoreName
|
594
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
595
|
+
* @returns {string} A string representing the data_store.
|
596
|
+
*/
|
597
|
+
matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
598
|
+
/**
|
599
|
+
* Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
|
600
|
+
*
|
601
|
+
* @param {string} project
|
602
|
+
* @param {string} location
|
603
|
+
* @param {string} collection
|
604
|
+
* @param {string} data_store
|
605
|
+
* @param {string} branch
|
606
|
+
* @param {string} document
|
607
|
+
* @returns {string} Resource name string.
|
608
|
+
*/
|
609
|
+
projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
|
610
|
+
/**
|
611
|
+
* Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
|
612
|
+
*
|
613
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
614
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
615
|
+
* @returns {string} A string representing the project.
|
616
|
+
*/
|
617
|
+
matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
618
|
+
/**
|
619
|
+
* Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
|
620
|
+
*
|
621
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
622
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
623
|
+
* @returns {string} A string representing the location.
|
624
|
+
*/
|
625
|
+
matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
626
|
+
/**
|
627
|
+
* Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
|
628
|
+
*
|
629
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
630
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
631
|
+
* @returns {string} A string representing the collection.
|
632
|
+
*/
|
633
|
+
matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
634
|
+
/**
|
635
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
|
636
|
+
*
|
637
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
638
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
639
|
+
* @returns {string} A string representing the data_store.
|
640
|
+
*/
|
641
|
+
matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
642
|
+
/**
|
643
|
+
* Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
|
644
|
+
*
|
645
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
646
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
647
|
+
* @returns {string} A string representing the branch.
|
648
|
+
*/
|
649
|
+
matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
650
|
+
/**
|
651
|
+
* Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
|
652
|
+
*
|
653
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
654
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
655
|
+
* @returns {string} A string representing the document.
|
656
|
+
*/
|
657
|
+
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
658
|
+
/**
|
659
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
660
|
+
*
|
661
|
+
* @param {string} project
|
662
|
+
* @param {string} location
|
663
|
+
* @param {string} collection
|
664
|
+
* @param {string} data_store
|
665
|
+
* @param {string} conversation
|
666
|
+
* @returns {string} Resource name string.
|
667
|
+
*/
|
668
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
669
|
+
/**
|
670
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
671
|
+
*
|
672
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
673
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
674
|
+
* @returns {string} A string representing the project.
|
675
|
+
*/
|
676
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
677
|
+
/**
|
678
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
679
|
+
*
|
680
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
681
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
682
|
+
* @returns {string} A string representing the location.
|
683
|
+
*/
|
684
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
685
|
+
/**
|
686
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
687
|
+
*
|
688
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
689
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
690
|
+
* @returns {string} A string representing the collection.
|
691
|
+
*/
|
692
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
693
|
+
/**
|
694
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
695
|
+
*
|
696
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
697
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
698
|
+
* @returns {string} A string representing the data_store.
|
699
|
+
*/
|
700
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
701
|
+
/**
|
702
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
703
|
+
*
|
704
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
705
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
706
|
+
* @returns {string} A string representing the conversation.
|
707
|
+
*/
|
708
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
709
|
+
/**
|
710
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
711
|
+
*
|
712
|
+
* @param {string} project
|
713
|
+
* @param {string} location
|
714
|
+
* @param {string} collection
|
715
|
+
* @param {string} data_store
|
716
|
+
* @param {string} schema
|
717
|
+
* @returns {string} Resource name string.
|
718
|
+
*/
|
719
|
+
projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
|
720
|
+
/**
|
721
|
+
* Parse the project from ProjectLocationCollectionDataStoreSchema resource.
|
722
|
+
*
|
723
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
724
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
725
|
+
* @returns {string} A string representing the project.
|
726
|
+
*/
|
727
|
+
matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
728
|
+
/**
|
729
|
+
* Parse the location from ProjectLocationCollectionDataStoreSchema resource.
|
730
|
+
*
|
731
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
732
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
733
|
+
* @returns {string} A string representing the location.
|
734
|
+
*/
|
735
|
+
matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
736
|
+
/**
|
737
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
|
738
|
+
*
|
739
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
740
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
741
|
+
* @returns {string} A string representing the collection.
|
742
|
+
*/
|
743
|
+
matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
744
|
+
/**
|
745
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
|
746
|
+
*
|
747
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
748
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
749
|
+
* @returns {string} A string representing the data_store.
|
750
|
+
*/
|
751
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
752
|
+
/**
|
753
|
+
* Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
|
754
|
+
*
|
755
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
756
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
757
|
+
* @returns {string} A string representing the schema.
|
758
|
+
*/
|
759
|
+
matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
760
|
+
/**
|
761
|
+
* Return a fully-qualified projectLocationDataStore resource name string.
|
762
|
+
*
|
763
|
+
* @param {string} project
|
764
|
+
* @param {string} location
|
765
|
+
* @param {string} data_store
|
766
|
+
* @returns {string} Resource name string.
|
767
|
+
*/
|
768
|
+
projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
|
769
|
+
/**
|
770
|
+
* Parse the project from ProjectLocationDataStore resource.
|
771
|
+
*
|
772
|
+
* @param {string} projectLocationDataStoreName
|
773
|
+
* A fully-qualified path representing project_location_data_store resource.
|
774
|
+
* @returns {string} A string representing the project.
|
775
|
+
*/
|
776
|
+
matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
777
|
+
/**
|
778
|
+
* Parse the location from ProjectLocationDataStore resource.
|
779
|
+
*
|
780
|
+
* @param {string} projectLocationDataStoreName
|
781
|
+
* A fully-qualified path representing project_location_data_store resource.
|
782
|
+
* @returns {string} A string representing the location.
|
783
|
+
*/
|
784
|
+
matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
785
|
+
/**
|
786
|
+
* Parse the data_store from ProjectLocationDataStore resource.
|
787
|
+
*
|
788
|
+
* @param {string} projectLocationDataStoreName
|
789
|
+
* A fully-qualified path representing project_location_data_store resource.
|
790
|
+
* @returns {string} A string representing the data_store.
|
791
|
+
*/
|
792
|
+
matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
793
|
+
/**
|
794
|
+
* Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
|
795
|
+
*
|
796
|
+
* @param {string} project
|
797
|
+
* @param {string} location
|
798
|
+
* @param {string} data_store
|
799
|
+
* @param {string} branch
|
800
|
+
* @param {string} document
|
801
|
+
* @returns {string} Resource name string.
|
802
|
+
*/
|
803
|
+
projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
|
804
|
+
/**
|
805
|
+
* Parse the project from ProjectLocationDataStoreBranchDocument resource.
|
806
|
+
*
|
807
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
808
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
809
|
+
* @returns {string} A string representing the project.
|
810
|
+
*/
|
811
|
+
matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
812
|
+
/**
|
813
|
+
* Parse the location from ProjectLocationDataStoreBranchDocument resource.
|
814
|
+
*
|
815
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
816
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
817
|
+
* @returns {string} A string representing the location.
|
818
|
+
*/
|
819
|
+
matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
820
|
+
/**
|
821
|
+
* Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
|
822
|
+
*
|
823
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
824
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
825
|
+
* @returns {string} A string representing the data_store.
|
826
|
+
*/
|
827
|
+
matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
828
|
+
/**
|
829
|
+
* Parse the branch from ProjectLocationDataStoreBranchDocument resource.
|
830
|
+
*
|
831
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
832
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
833
|
+
* @returns {string} A string representing the branch.
|
834
|
+
*/
|
835
|
+
matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
836
|
+
/**
|
837
|
+
* Parse the document from ProjectLocationDataStoreBranchDocument resource.
|
838
|
+
*
|
839
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
840
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
841
|
+
* @returns {string} A string representing the document.
|
842
|
+
*/
|
843
|
+
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
844
|
+
/**
|
845
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
846
|
+
*
|
847
|
+
* @param {string} project
|
848
|
+
* @param {string} location
|
849
|
+
* @param {string} data_store
|
850
|
+
* @param {string} conversation
|
851
|
+
* @returns {string} Resource name string.
|
852
|
+
*/
|
853
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
854
|
+
/**
|
855
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
856
|
+
*
|
857
|
+
* @param {string} projectLocationDataStoreConversationName
|
858
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
859
|
+
* @returns {string} A string representing the project.
|
860
|
+
*/
|
861
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
862
|
+
/**
|
863
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
864
|
+
*
|
865
|
+
* @param {string} projectLocationDataStoreConversationName
|
866
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
867
|
+
* @returns {string} A string representing the location.
|
868
|
+
*/
|
869
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
870
|
+
/**
|
871
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
872
|
+
*
|
873
|
+
* @param {string} projectLocationDataStoreConversationName
|
874
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
875
|
+
* @returns {string} A string representing the data_store.
|
876
|
+
*/
|
877
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
878
|
+
/**
|
879
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
880
|
+
*
|
881
|
+
* @param {string} projectLocationDataStoreConversationName
|
882
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
883
|
+
* @returns {string} A string representing the conversation.
|
884
|
+
*/
|
885
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
886
|
+
/**
|
887
|
+
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
888
|
+
*
|
889
|
+
* @param {string} project
|
890
|
+
* @param {string} location
|
891
|
+
* @param {string} data_store
|
892
|
+
* @param {string} schema
|
893
|
+
* @returns {string} Resource name string.
|
894
|
+
*/
|
895
|
+
projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
|
896
|
+
/**
|
897
|
+
* Parse the project from ProjectLocationDataStoreSchema resource.
|
898
|
+
*
|
899
|
+
* @param {string} projectLocationDataStoreSchemaName
|
900
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
901
|
+
* @returns {string} A string representing the project.
|
902
|
+
*/
|
903
|
+
matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
904
|
+
/**
|
905
|
+
* Parse the location from ProjectLocationDataStoreSchema resource.
|
906
|
+
*
|
907
|
+
* @param {string} projectLocationDataStoreSchemaName
|
908
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
909
|
+
* @returns {string} A string representing the location.
|
910
|
+
*/
|
911
|
+
matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
912
|
+
/**
|
913
|
+
* Parse the data_store from ProjectLocationDataStoreSchema resource.
|
914
|
+
*
|
915
|
+
* @param {string} projectLocationDataStoreSchemaName
|
916
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
917
|
+
* @returns {string} A string representing the data_store.
|
918
|
+
*/
|
919
|
+
matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
920
|
+
/**
|
921
|
+
* Parse the schema from ProjectLocationDataStoreSchema resource.
|
922
|
+
*
|
923
|
+
* @param {string} projectLocationDataStoreSchemaName
|
924
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
925
|
+
* @returns {string} A string representing the schema.
|
926
|
+
*/
|
927
|
+
matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
928
|
+
/**
|
929
|
+
* Terminate the gRPC channel and close the client.
|
930
|
+
*
|
931
|
+
* The client will no longer be usable and all future behavior is undefined.
|
932
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
933
|
+
*/
|
934
|
+
close(): Promise<void>;
|
935
|
+
}
|