@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,1140 @@
|
|
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 ingesting
|
8
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} information of the
|
9
|
+
* customer's website.
|
10
|
+
* @class
|
11
|
+
* @memberof v1alpha
|
12
|
+
*/
|
13
|
+
export declare class DocumentServiceClient {
|
14
|
+
private _terminated;
|
15
|
+
private _opts;
|
16
|
+
private _providedCustomServicePath;
|
17
|
+
private _gaxModule;
|
18
|
+
private _gaxGrpc;
|
19
|
+
private _protos;
|
20
|
+
private _defaults;
|
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
|
+
documentServiceStub?: Promise<{
|
33
|
+
[name: string]: Function;
|
34
|
+
}>;
|
35
|
+
/**
|
36
|
+
* Construct an instance of DocumentServiceClient.
|
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://developers.google.com/identity/protocols/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 DocumentServiceClient({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
|
+
* @returns {string} The DNS address for this service.
|
92
|
+
*/
|
93
|
+
static get servicePath(): string;
|
94
|
+
/**
|
95
|
+
* The DNS address for this API service - same as servicePath(),
|
96
|
+
* exists for compatibility reasons.
|
97
|
+
* @returns {string} The DNS address for this service.
|
98
|
+
*/
|
99
|
+
static get apiEndpoint(): string;
|
100
|
+
/**
|
101
|
+
* The port for this API service.
|
102
|
+
* @returns {number} The default port for this service.
|
103
|
+
*/
|
104
|
+
static get port(): number;
|
105
|
+
/**
|
106
|
+
* The scopes needed to make gRPC calls for every method defined
|
107
|
+
* in this service.
|
108
|
+
* @returns {string[]} List of default scopes.
|
109
|
+
*/
|
110
|
+
static get scopes(): string[];
|
111
|
+
getProjectId(): Promise<string>;
|
112
|
+
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
113
|
+
/**
|
114
|
+
* Gets a {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}.
|
115
|
+
*
|
116
|
+
* @param {Object} request
|
117
|
+
* The request object that will be sent.
|
118
|
+
* @param {string} request.name
|
119
|
+
* Required. Full resource name of
|
120
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}, such as
|
121
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
|
122
|
+
*
|
123
|
+
* If the caller does not have permission to access the
|
124
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}, regardless of
|
125
|
+
* whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
126
|
+
*
|
127
|
+
* If the requested {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
|
128
|
+
* does not exist, a `NOT_FOUND` error is returned.
|
129
|
+
* @param {object} [options]
|
130
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
131
|
+
* @returns {Promise} - The promise which resolves to an array.
|
132
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}.
|
133
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
134
|
+
* for more details and examples.
|
135
|
+
* @example <caption>include:samples/generated/v1alpha/document_service.get_document.js</caption>
|
136
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_GetDocument_async
|
137
|
+
*/
|
138
|
+
getDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest, options?: CallOptions): Promise<[
|
139
|
+
protos.google.cloud.discoveryengine.v1alpha.IDocument,
|
140
|
+
(protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest | undefined),
|
141
|
+
{} | undefined
|
142
|
+
]>;
|
143
|
+
getDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
|
144
|
+
getDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
|
145
|
+
/**
|
146
|
+
* Creates a {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}.
|
147
|
+
*
|
148
|
+
* @param {Object} request
|
149
|
+
* The request object that will be sent.
|
150
|
+
* @param {string} request.parent
|
151
|
+
* Required. The parent resource name, such as
|
152
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
153
|
+
* @param {google.cloud.discoveryengine.v1alpha.Document} request.document
|
154
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} to
|
155
|
+
* create.
|
156
|
+
* @param {string} request.documentId
|
157
|
+
* Required. The ID to use for the
|
158
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}, which will
|
159
|
+
* become the final component of the
|
160
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document.name|Document.name}.
|
161
|
+
*
|
162
|
+
* If the caller does not have permission to create the
|
163
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}, regardless of
|
164
|
+
* whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
165
|
+
*
|
166
|
+
* This field must be unique among all
|
167
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s with the same
|
168
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.CreateDocumentRequest.parent|parent}.
|
169
|
+
* Otherwise, an `ALREADY_EXISTS` error is returned.
|
170
|
+
*
|
171
|
+
* This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
172
|
+
* standard with a length limit of 63 characters. Otherwise, an
|
173
|
+
* `INVALID_ARGUMENT` error is returned.
|
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.discoveryengine.v1alpha.Document|Document}.
|
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/v1alpha/document_service.create_document.js</caption>
|
181
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_CreateDocument_async
|
182
|
+
*/
|
183
|
+
createDocument(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest, options?: CallOptions): Promise<[
|
184
|
+
protos.google.cloud.discoveryengine.v1alpha.IDocument,
|
185
|
+
(protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest | undefined),
|
186
|
+
{} | undefined
|
187
|
+
]>;
|
188
|
+
createDocument(request: protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
|
189
|
+
createDocument(request: protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
|
190
|
+
/**
|
191
|
+
* Updates a {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}.
|
192
|
+
*
|
193
|
+
* @param {Object} request
|
194
|
+
* The request object that will be sent.
|
195
|
+
* @param {google.cloud.discoveryengine.v1alpha.Document} request.document
|
196
|
+
* Required. The document to update/create.
|
197
|
+
*
|
198
|
+
* If the caller does not have permission to update the
|
199
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}, regardless of
|
200
|
+
* whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
201
|
+
*
|
202
|
+
* If the {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} to update
|
203
|
+
* does not exist and
|
204
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.UpdateDocumentRequest.allow_missing|allow_missing}
|
205
|
+
* is not set, a `NOT_FOUND` error is returned.
|
206
|
+
* @param {boolean} request.allowMissing
|
207
|
+
* If set to true, and the
|
208
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} is not found, a
|
209
|
+
* new {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} will be
|
210
|
+
* created.
|
211
|
+
* @param {object} [options]
|
212
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
213
|
+
* @returns {Promise} - The promise which resolves to an array.
|
214
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}.
|
215
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
216
|
+
* for more details and examples.
|
217
|
+
* @example <caption>include:samples/generated/v1alpha/document_service.update_document.js</caption>
|
218
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_UpdateDocument_async
|
219
|
+
*/
|
220
|
+
updateDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest, options?: CallOptions): Promise<[
|
221
|
+
protos.google.cloud.discoveryengine.v1alpha.IDocument,
|
222
|
+
(protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest | undefined),
|
223
|
+
{} | undefined
|
224
|
+
]>;
|
225
|
+
updateDocument(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
|
226
|
+
updateDocument(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
|
227
|
+
/**
|
228
|
+
* Deletes a {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}.
|
229
|
+
*
|
230
|
+
* @param {Object} request
|
231
|
+
* The request object that will be sent.
|
232
|
+
* @param {string} request.name
|
233
|
+
* Required. Full resource name of
|
234
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}, such as
|
235
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
|
236
|
+
*
|
237
|
+
* If the caller does not have permission to delete the
|
238
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}, regardless of
|
239
|
+
* whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
240
|
+
*
|
241
|
+
* If the {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} to delete
|
242
|
+
* does not exist, a `NOT_FOUND` error is returned.
|
243
|
+
* @param {object} [options]
|
244
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
245
|
+
* @returns {Promise} - The promise which resolves to an array.
|
246
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
247
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
248
|
+
* for more details and examples.
|
249
|
+
* @example <caption>include:samples/generated/v1alpha/document_service.delete_document.js</caption>
|
250
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_DeleteDocument_async
|
251
|
+
*/
|
252
|
+
deleteDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest, options?: CallOptions): Promise<[
|
253
|
+
protos.google.protobuf.IEmpty,
|
254
|
+
(protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest | undefined),
|
255
|
+
{} | undefined
|
256
|
+
]>;
|
257
|
+
deleteDocument(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
|
258
|
+
deleteDocument(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
|
259
|
+
/**
|
260
|
+
* Bulk import of multiple
|
261
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s. Request
|
262
|
+
* processing may be synchronous. Non-existing items will be created.
|
263
|
+
*
|
264
|
+
* Note: It is possible for a subset of the
|
265
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to be
|
266
|
+
* successfully updated.
|
267
|
+
*
|
268
|
+
* @param {Object} request
|
269
|
+
* The request object that will be sent.
|
270
|
+
* @param {google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.InlineSource} request.inlineSource
|
271
|
+
* The Inline source for the input content for documents.
|
272
|
+
* @param {google.cloud.discoveryengine.v1alpha.GcsSource} request.gcsSource
|
273
|
+
* Cloud Storage location for the input content.
|
274
|
+
* @param {google.cloud.discoveryengine.v1alpha.BigQuerySource} request.bigquerySource
|
275
|
+
* BigQuery input source.
|
276
|
+
* @param {string} request.parent
|
277
|
+
* Required. The parent branch resource name, such as
|
278
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
279
|
+
* Requires create/update permission.
|
280
|
+
* @param {google.cloud.discoveryengine.v1alpha.ImportErrorConfig} request.errorConfig
|
281
|
+
* The desired location of errors incurred during the Import.
|
282
|
+
* @param {google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode} request.reconciliationMode
|
283
|
+
* The mode of reconciliation between existing documents and the documents to
|
284
|
+
* be imported. Defaults to
|
285
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
|
286
|
+
* @param {boolean} request.autoGenerateIds
|
287
|
+
* Whether to automatically generate IDs for the documents if absent.
|
288
|
+
*
|
289
|
+
* If set to `true`,
|
290
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document.id|Document.id}s are
|
291
|
+
* automatically generated based on the hash of the payload, where IDs may not
|
292
|
+
* be consistent during multiple imports. In which case
|
293
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
|
294
|
+
* is highly recommended to avoid duplicate contents. If unset or set to
|
295
|
+
* `false`, {@link protos.google.cloud.discoveryengine.v1alpha.Document.id|Document.id}s
|
296
|
+
* have to be specified using
|
297
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field|id_field},
|
298
|
+
* otherwise, documents without IDs fail to be imported.
|
299
|
+
*
|
300
|
+
* Only set this field when using
|
301
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.GcsSource|GcsSource} or
|
302
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.BigQuerySource|BigQuerySource}, and
|
303
|
+
* when
|
304
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.GcsSource.data_schema|GcsSource.data_schema}
|
305
|
+
* or
|
306
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema|BigQuerySource.data_schema}
|
307
|
+
* is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
308
|
+
* @param {string} request.idField
|
309
|
+
* The field in the Cloud Storage and BigQuery sources that indicates the
|
310
|
+
* unique IDs of the documents.
|
311
|
+
*
|
312
|
+
* For {@link protos.google.cloud.discoveryengine.v1alpha.GcsSource|GcsSource} it is the
|
313
|
+
* key of the JSON field. For instance, `my_id` for JSON `{"my_id":
|
314
|
+
* "some_uuid"}`. For
|
315
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.BigQuerySource|BigQuerySource} it is
|
316
|
+
* the column name of the BigQuery table where the unique ids are stored.
|
317
|
+
*
|
318
|
+
* The values of the JSON field or the BigQuery column are used as the
|
319
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document.id|Document.id}s. The JSON
|
320
|
+
* field or the BigQuery column must be of string type, and the values must be
|
321
|
+
* set as valid strings conform to
|
322
|
+
* [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
|
323
|
+
* Otherwise, documents without valid IDs fail to be imported.
|
324
|
+
*
|
325
|
+
* Only set this field when using
|
326
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.GcsSource|GcsSource} or
|
327
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.BigQuerySource|BigQuerySource}, and
|
328
|
+
* when
|
329
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.GcsSource.data_schema|GcsSource.data_schema}
|
330
|
+
* or
|
331
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema|BigQuerySource.data_schema}
|
332
|
+
* is `custom`. And only set this field when
|
333
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
|
334
|
+
* is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
335
|
+
*
|
336
|
+
* If it is unset, a default value `_id` is used when importing from the
|
337
|
+
* allowed data sources.
|
338
|
+
* @param {object} [options]
|
339
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
340
|
+
* @returns {Promise} - The promise which resolves to an array.
|
341
|
+
* The first element of the array is an object representing
|
342
|
+
* a long running operation. Its `promise()` method returns a promise
|
343
|
+
* you can `await` for.
|
344
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
345
|
+
* for more details and examples.
|
346
|
+
* @example <caption>include:samples/generated/v1alpha/document_service.import_documents.js</caption>
|
347
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_ImportDocuments_async
|
348
|
+
*/
|
349
|
+
importDocuments(request?: protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsRequest, options?: CallOptions): Promise<[
|
350
|
+
LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsMetadata>,
|
351
|
+
protos.google.longrunning.IOperation | undefined,
|
352
|
+
{} | undefined
|
353
|
+
]>;
|
354
|
+
importDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
355
|
+
importDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
356
|
+
/**
|
357
|
+
* Check the status of the long running operation returned by `importDocuments()`.
|
358
|
+
* @param {String} name
|
359
|
+
* The operation name that will be passed.
|
360
|
+
* @returns {Promise} - The promise which resolves to an object.
|
361
|
+
* The decoded operation object has result and metadata field to get information from.
|
362
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
363
|
+
* for more details and examples.
|
364
|
+
* @example <caption>include:samples/generated/v1alpha/document_service.import_documents.js</caption>
|
365
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_ImportDocuments_async
|
366
|
+
*/
|
367
|
+
checkImportDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.ImportDocumentsMetadata>>;
|
368
|
+
/**
|
369
|
+
* Permanently deletes all selected
|
370
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s in a branch.
|
371
|
+
*
|
372
|
+
* This process is asynchronous. Depending on the number of
|
373
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to be deleted,
|
374
|
+
* this operation can take hours to complete. Before the delete operation
|
375
|
+
* completes, some {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s
|
376
|
+
* might still be returned by
|
377
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument|DocumentService.GetDocument}
|
378
|
+
* or
|
379
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}.
|
380
|
+
*
|
381
|
+
* To get a list of the
|
382
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to be deleted,
|
383
|
+
* set
|
384
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
|
385
|
+
* to false.
|
386
|
+
*
|
387
|
+
* @param {Object} request
|
388
|
+
* The request object that will be sent.
|
389
|
+
* @param {string} request.parent
|
390
|
+
* Required. The parent resource name, such as
|
391
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
392
|
+
* @param {string} request.filter
|
393
|
+
* Required. Filter matching documents to purge. Only currently supported
|
394
|
+
* value is
|
395
|
+
* `*` (all items).
|
396
|
+
* @param {boolean} request.force
|
397
|
+
* Actually performs the purge. If `force` is set to false, return the
|
398
|
+
* expected purge count without deleting any documents.
|
399
|
+
* @param {object} [options]
|
400
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
401
|
+
* @returns {Promise} - The promise which resolves to an array.
|
402
|
+
* The first element of the array is an object representing
|
403
|
+
* a long running operation. Its `promise()` method returns a promise
|
404
|
+
* you can `await` for.
|
405
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
406
|
+
* for more details and examples.
|
407
|
+
* @example <caption>include:samples/generated/v1alpha/document_service.purge_documents.js</caption>
|
408
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_PurgeDocuments_async
|
409
|
+
*/
|
410
|
+
purgeDocuments(request?: protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest, options?: CallOptions): Promise<[
|
411
|
+
LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsMetadata>,
|
412
|
+
protos.google.longrunning.IOperation | undefined,
|
413
|
+
{} | undefined
|
414
|
+
]>;
|
415
|
+
purgeDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
416
|
+
purgeDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
417
|
+
/**
|
418
|
+
* Check the status of the long running operation returned by `purgeDocuments()`.
|
419
|
+
* @param {String} name
|
420
|
+
* The operation name that will be passed.
|
421
|
+
* @returns {Promise} - The promise which resolves to an object.
|
422
|
+
* The decoded operation object has result and metadata field to get information from.
|
423
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
424
|
+
* for more details and examples.
|
425
|
+
* @example <caption>include:samples/generated/v1alpha/document_service.purge_documents.js</caption>
|
426
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_PurgeDocuments_async
|
427
|
+
*/
|
428
|
+
checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsMetadata>>;
|
429
|
+
/**
|
430
|
+
* Gets a list of {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s.
|
431
|
+
*
|
432
|
+
* @param {Object} request
|
433
|
+
* The request object that will be sent.
|
434
|
+
* @param {string} request.parent
|
435
|
+
* Required. The parent branch resource name, such as
|
436
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
437
|
+
* Use `default_branch` as the branch ID, to list documents under the default
|
438
|
+
* branch.
|
439
|
+
*
|
440
|
+
* If the caller does not have permission to list
|
441
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s under this
|
442
|
+
* branch, regardless of whether or not this branch exists, a
|
443
|
+
* `PERMISSION_DENIED` error is returned.
|
444
|
+
* @param {number} request.pageSize
|
445
|
+
* Maximum number of
|
446
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
|
447
|
+
* unspecified, defaults to 100. The maximum allowed value is 1000. Values
|
448
|
+
* above 1000 will be coerced to 1000.
|
449
|
+
*
|
450
|
+
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
451
|
+
* @param {string} request.pageToken
|
452
|
+
* A page token
|
453
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
454
|
+
* received from a previous
|
455
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
456
|
+
* call. Provide this to retrieve the subsequent page.
|
457
|
+
*
|
458
|
+
* When paginating, all other parameters provided to
|
459
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
460
|
+
* must match the call that provided the page token. Otherwise, an
|
461
|
+
* `INVALID_ARGUMENT` error is returned.
|
462
|
+
* @param {object} [options]
|
463
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
464
|
+
* @returns {Promise} - The promise which resolves to an array.
|
465
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}.
|
466
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
467
|
+
* times as needed and will merge results from all the pages into this array.
|
468
|
+
* Note that it can affect your quota.
|
469
|
+
* We recommend using `listDocumentsAsync()`
|
470
|
+
* method described below for async iteration which you can stop as needed.
|
471
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
472
|
+
* for more details and examples.
|
473
|
+
*/
|
474
|
+
listDocuments(request?: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options?: CallOptions): Promise<[
|
475
|
+
protos.google.cloud.discoveryengine.v1alpha.IDocument[],
|
476
|
+
protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest | null,
|
477
|
+
protos.google.cloud.discoveryengine.v1alpha.IListDocumentsResponse
|
478
|
+
]>;
|
479
|
+
listDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, protos.google.cloud.discoveryengine.v1alpha.IListDocumentsResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IDocument>): void;
|
480
|
+
listDocuments(request: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, protos.google.cloud.discoveryengine.v1alpha.IListDocumentsResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IDocument>): void;
|
481
|
+
/**
|
482
|
+
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
483
|
+
* @param {Object} request
|
484
|
+
* The request object that will be sent.
|
485
|
+
* @param {string} request.parent
|
486
|
+
* Required. The parent branch resource name, such as
|
487
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
488
|
+
* Use `default_branch` as the branch ID, to list documents under the default
|
489
|
+
* branch.
|
490
|
+
*
|
491
|
+
* If the caller does not have permission to list
|
492
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s under this
|
493
|
+
* branch, regardless of whether or not this branch exists, a
|
494
|
+
* `PERMISSION_DENIED` error is returned.
|
495
|
+
* @param {number} request.pageSize
|
496
|
+
* Maximum number of
|
497
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
|
498
|
+
* unspecified, defaults to 100. The maximum allowed value is 1000. Values
|
499
|
+
* above 1000 will be coerced to 1000.
|
500
|
+
*
|
501
|
+
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
502
|
+
* @param {string} request.pageToken
|
503
|
+
* A page token
|
504
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
505
|
+
* received from a previous
|
506
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
507
|
+
* call. Provide this to retrieve the subsequent page.
|
508
|
+
*
|
509
|
+
* When paginating, all other parameters provided to
|
510
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
511
|
+
* must match the call that provided the page token. Otherwise, an
|
512
|
+
* `INVALID_ARGUMENT` error is returned.
|
513
|
+
* @param {object} [options]
|
514
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
515
|
+
* @returns {Stream}
|
516
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document} on 'data' event.
|
517
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
518
|
+
* times as needed. Note that it can affect your quota.
|
519
|
+
* We recommend using `listDocumentsAsync()`
|
520
|
+
* method described below for async iteration which you can stop as needed.
|
521
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
522
|
+
* for more details and examples.
|
523
|
+
*/
|
524
|
+
listDocumentsStream(request?: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options?: CallOptions): Transform;
|
525
|
+
/**
|
526
|
+
* Equivalent to `listDocuments`, but returns an iterable object.
|
527
|
+
*
|
528
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
529
|
+
* @param {Object} request
|
530
|
+
* The request object that will be sent.
|
531
|
+
* @param {string} request.parent
|
532
|
+
* Required. The parent branch resource name, such as
|
533
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
534
|
+
* Use `default_branch` as the branch ID, to list documents under the default
|
535
|
+
* branch.
|
536
|
+
*
|
537
|
+
* If the caller does not have permission to list
|
538
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s under this
|
539
|
+
* branch, regardless of whether or not this branch exists, a
|
540
|
+
* `PERMISSION_DENIED` error is returned.
|
541
|
+
* @param {number} request.pageSize
|
542
|
+
* Maximum number of
|
543
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
|
544
|
+
* unspecified, defaults to 100. The maximum allowed value is 1000. Values
|
545
|
+
* above 1000 will be coerced to 1000.
|
546
|
+
*
|
547
|
+
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
548
|
+
* @param {string} request.pageToken
|
549
|
+
* A page token
|
550
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
551
|
+
* received from a previous
|
552
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
553
|
+
* call. Provide this to retrieve the subsequent page.
|
554
|
+
*
|
555
|
+
* When paginating, all other parameters provided to
|
556
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
557
|
+
* must match the call that provided the page token. Otherwise, an
|
558
|
+
* `INVALID_ARGUMENT` error is returned.
|
559
|
+
* @param {object} [options]
|
560
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
561
|
+
* @returns {Object}
|
562
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
563
|
+
* When you iterate the returned iterable, each element will be an object representing
|
564
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}. The API will be called under the hood as needed, once per the page,
|
565
|
+
* so you can stop the iteration when you don't need more results.
|
566
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
567
|
+
* for more details and examples.
|
568
|
+
* @example <caption>include:samples/generated/v1alpha/document_service.list_documents.js</caption>
|
569
|
+
* region_tag:discoveryengine_v1alpha_generated_DocumentService_ListDocuments_async
|
570
|
+
*/
|
571
|
+
listDocumentsAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IDocument>;
|
572
|
+
/**
|
573
|
+
* Gets information about a location.
|
574
|
+
*
|
575
|
+
* @param {Object} request
|
576
|
+
* The request object that will be sent.
|
577
|
+
* @param {string} request.name
|
578
|
+
* Resource name for the location.
|
579
|
+
* @param {object} [options]
|
580
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
581
|
+
* @returns {Promise} - The promise which resolves to an array.
|
582
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
583
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
584
|
+
* for more details and examples.
|
585
|
+
* @example
|
586
|
+
* ```
|
587
|
+
* const [response] = await client.getLocation(request);
|
588
|
+
* ```
|
589
|
+
*/
|
590
|
+
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>;
|
591
|
+
/**
|
592
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
593
|
+
*
|
594
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
595
|
+
* @param {Object} request
|
596
|
+
* The request object that will be sent.
|
597
|
+
* @param {string} request.name
|
598
|
+
* The resource that owns the locations collection, if applicable.
|
599
|
+
* @param {string} request.filter
|
600
|
+
* The standard list filter.
|
601
|
+
* @param {number} request.pageSize
|
602
|
+
* The standard list page size.
|
603
|
+
* @param {string} request.pageToken
|
604
|
+
* The standard list page token.
|
605
|
+
* @param {object} [options]
|
606
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
607
|
+
* @returns {Object}
|
608
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
609
|
+
* When you iterate the returned iterable, each element will be an object representing
|
610
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
611
|
+
* so you can stop the iteration when you don't need more results.
|
612
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
613
|
+
* for more details and examples.
|
614
|
+
* @example
|
615
|
+
* ```
|
616
|
+
* const iterable = client.listLocationsAsync(request);
|
617
|
+
* for await (const response of iterable) {
|
618
|
+
* // process response
|
619
|
+
* }
|
620
|
+
* ```
|
621
|
+
*/
|
622
|
+
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
623
|
+
/**
|
624
|
+
* Gets the latest state of a long-running operation. Clients can use this
|
625
|
+
* method to poll the operation result at intervals as recommended by the API
|
626
|
+
* service.
|
627
|
+
*
|
628
|
+
* @param {Object} request - The request object that will be sent.
|
629
|
+
* @param {string} request.name - The name of the operation resource.
|
630
|
+
* @param {Object=} options
|
631
|
+
* Optional parameters. You can override the default settings for this call,
|
632
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
633
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
634
|
+
* for the details.
|
635
|
+
* @param {function(?Error, ?Object)=} callback
|
636
|
+
* The function which will be called with the result of the API call.
|
637
|
+
*
|
638
|
+
* The second parameter to the callback is an object representing
|
639
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
640
|
+
* @return {Promise} - The promise which resolves to an array.
|
641
|
+
* The first element of the array is an object representing
|
642
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
643
|
+
* The promise has a method named "cancel" which cancels the ongoing API call.
|
644
|
+
*
|
645
|
+
* @example
|
646
|
+
* ```
|
647
|
+
* const client = longrunning.operationsClient();
|
648
|
+
* const name = '';
|
649
|
+
* const [response] = await client.getOperation({name});
|
650
|
+
* // doThingsWith(response)
|
651
|
+
* ```
|
652
|
+
*/
|
653
|
+
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]>;
|
654
|
+
/**
|
655
|
+
* Lists operations that match the specified filter in the request. If the
|
656
|
+
* server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
|
657
|
+
*
|
658
|
+
* For-await-of syntax is used with the iterable to recursively get response element on-demand.
|
659
|
+
*
|
660
|
+
* @param {Object} request - The request object that will be sent.
|
661
|
+
* @param {string} request.name - The name of the operation collection.
|
662
|
+
* @param {string} request.filter - The standard list filter.
|
663
|
+
* @param {number=} request.pageSize -
|
664
|
+
* The maximum number of resources contained in the underlying API
|
665
|
+
* response. If page streaming is performed per-resource, this
|
666
|
+
* parameter does not affect the return value. If page streaming is
|
667
|
+
* performed per-page, this determines the maximum number of
|
668
|
+
* resources in a page.
|
669
|
+
* @param {Object=} options
|
670
|
+
* Optional parameters. You can override the default settings for this call,
|
671
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
672
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
|
673
|
+
* details.
|
674
|
+
* @returns {Object}
|
675
|
+
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
|
676
|
+
*
|
677
|
+
* @example
|
678
|
+
* ```
|
679
|
+
* const client = longrunning.operationsClient();
|
680
|
+
* for await (const response of client.listOperationsAsync(request));
|
681
|
+
* // doThingsWith(response)
|
682
|
+
* ```
|
683
|
+
*/
|
684
|
+
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
|
685
|
+
/**
|
686
|
+
* Starts asynchronous cancellation on a long-running operation. The server
|
687
|
+
* makes a best effort to cancel the operation, but success is not
|
688
|
+
* guaranteed. If the server doesn't support this method, it returns
|
689
|
+
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
690
|
+
* {@link Operations.GetOperation} or
|
691
|
+
* other methods to check whether the cancellation succeeded or whether the
|
692
|
+
* operation completed despite cancellation. On successful cancellation,
|
693
|
+
* the operation is not deleted; instead, it becomes an operation with
|
694
|
+
* an {@link Operation.error} value with a {@link google.rpc.Status.code} of
|
695
|
+
* 1, corresponding to `Code.CANCELLED`.
|
696
|
+
*
|
697
|
+
* @param {Object} request - The request object that will be sent.
|
698
|
+
* @param {string} request.name - The name of the operation resource to be cancelled.
|
699
|
+
* @param {Object=} options
|
700
|
+
* Optional parameters. You can override the default settings for this call,
|
701
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
702
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
|
703
|
+
* details.
|
704
|
+
* @param {function(?Error)=} callback
|
705
|
+
* The function which will be called with the result of the API call.
|
706
|
+
* @return {Promise} - The promise which resolves when API call finishes.
|
707
|
+
* The promise has a method named "cancel" which cancels the ongoing API
|
708
|
+
* call.
|
709
|
+
*
|
710
|
+
* @example
|
711
|
+
* ```
|
712
|
+
* const client = longrunning.operationsClient();
|
713
|
+
* await client.cancelOperation({name: ''});
|
714
|
+
* ```
|
715
|
+
*/
|
716
|
+
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>;
|
717
|
+
/**
|
718
|
+
* Deletes a long-running operation. This method indicates that the client is
|
719
|
+
* no longer interested in the operation result. It does not cancel the
|
720
|
+
* operation. If the server doesn't support this method, it returns
|
721
|
+
* `google.rpc.Code.UNIMPLEMENTED`.
|
722
|
+
*
|
723
|
+
* @param {Object} request - The request object that will be sent.
|
724
|
+
* @param {string} request.name - The name of the operation resource to be deleted.
|
725
|
+
* @param {Object=} options
|
726
|
+
* Optional parameters. You can override the default settings for this call,
|
727
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
728
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
729
|
+
* for the details.
|
730
|
+
* @param {function(?Error)=} callback
|
731
|
+
* The function which will be called with the result of the API call.
|
732
|
+
* @return {Promise} - The promise which resolves when API call finishes.
|
733
|
+
* The promise has a method named "cancel" which cancels the ongoing API
|
734
|
+
* call.
|
735
|
+
*
|
736
|
+
* @example
|
737
|
+
* ```
|
738
|
+
* const client = longrunning.operationsClient();
|
739
|
+
* await client.deleteOperation({name: ''});
|
740
|
+
* ```
|
741
|
+
*/
|
742
|
+
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>;
|
743
|
+
/**
|
744
|
+
* Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
|
745
|
+
*
|
746
|
+
* @param {string} project
|
747
|
+
* @param {string} location
|
748
|
+
* @param {string} collection
|
749
|
+
* @param {string} data_store
|
750
|
+
* @param {string} branch
|
751
|
+
* @returns {string} Resource name string.
|
752
|
+
*/
|
753
|
+
projectLocationCollectionDataStoreBranchPath(project: string, location: string, collection: string, dataStore: string, branch: string): string;
|
754
|
+
/**
|
755
|
+
* Parse the project from ProjectLocationCollectionDataStoreBranch resource.
|
756
|
+
*
|
757
|
+
* @param {string} projectLocationCollectionDataStoreBranchName
|
758
|
+
* A fully-qualified path representing project_location_collection_data_store_branch resource.
|
759
|
+
* @returns {string} A string representing the project.
|
760
|
+
*/
|
761
|
+
matchProjectFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
|
762
|
+
/**
|
763
|
+
* Parse the location from ProjectLocationCollectionDataStoreBranch resource.
|
764
|
+
*
|
765
|
+
* @param {string} projectLocationCollectionDataStoreBranchName
|
766
|
+
* A fully-qualified path representing project_location_collection_data_store_branch resource.
|
767
|
+
* @returns {string} A string representing the location.
|
768
|
+
*/
|
769
|
+
matchLocationFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
|
770
|
+
/**
|
771
|
+
* Parse the collection from ProjectLocationCollectionDataStoreBranch resource.
|
772
|
+
*
|
773
|
+
* @param {string} projectLocationCollectionDataStoreBranchName
|
774
|
+
* A fully-qualified path representing project_location_collection_data_store_branch resource.
|
775
|
+
* @returns {string} A string representing the collection.
|
776
|
+
*/
|
777
|
+
matchCollectionFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
|
778
|
+
/**
|
779
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreBranch resource.
|
780
|
+
*
|
781
|
+
* @param {string} projectLocationCollectionDataStoreBranchName
|
782
|
+
* A fully-qualified path representing project_location_collection_data_store_branch resource.
|
783
|
+
* @returns {string} A string representing the data_store.
|
784
|
+
*/
|
785
|
+
matchDataStoreFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
|
786
|
+
/**
|
787
|
+
* Parse the branch from ProjectLocationCollectionDataStoreBranch resource.
|
788
|
+
*
|
789
|
+
* @param {string} projectLocationCollectionDataStoreBranchName
|
790
|
+
* A fully-qualified path representing project_location_collection_data_store_branch resource.
|
791
|
+
* @returns {string} A string representing the branch.
|
792
|
+
*/
|
793
|
+
matchBranchFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
|
794
|
+
/**
|
795
|
+
* Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
|
796
|
+
*
|
797
|
+
* @param {string} project
|
798
|
+
* @param {string} location
|
799
|
+
* @param {string} collection
|
800
|
+
* @param {string} data_store
|
801
|
+
* @param {string} branch
|
802
|
+
* @param {string} document
|
803
|
+
* @returns {string} Resource name string.
|
804
|
+
*/
|
805
|
+
projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
|
806
|
+
/**
|
807
|
+
* Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
|
808
|
+
*
|
809
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
810
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
811
|
+
* @returns {string} A string representing the project.
|
812
|
+
*/
|
813
|
+
matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
814
|
+
/**
|
815
|
+
* Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
|
816
|
+
*
|
817
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
818
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
819
|
+
* @returns {string} A string representing the location.
|
820
|
+
*/
|
821
|
+
matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
822
|
+
/**
|
823
|
+
* Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
|
824
|
+
*
|
825
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
826
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
827
|
+
* @returns {string} A string representing the collection.
|
828
|
+
*/
|
829
|
+
matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
830
|
+
/**
|
831
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
|
832
|
+
*
|
833
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
834
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
835
|
+
* @returns {string} A string representing the data_store.
|
836
|
+
*/
|
837
|
+
matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
838
|
+
/**
|
839
|
+
* Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
|
840
|
+
*
|
841
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
842
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
843
|
+
* @returns {string} A string representing the branch.
|
844
|
+
*/
|
845
|
+
matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
846
|
+
/**
|
847
|
+
* Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
|
848
|
+
*
|
849
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
850
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
851
|
+
* @returns {string} A string representing the document.
|
852
|
+
*/
|
853
|
+
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
854
|
+
/**
|
855
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
856
|
+
*
|
857
|
+
* @param {string} project
|
858
|
+
* @param {string} location
|
859
|
+
* @param {string} collection
|
860
|
+
* @param {string} data_store
|
861
|
+
* @param {string} conversation
|
862
|
+
* @returns {string} Resource name string.
|
863
|
+
*/
|
864
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
865
|
+
/**
|
866
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
867
|
+
*
|
868
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
869
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
870
|
+
* @returns {string} A string representing the project.
|
871
|
+
*/
|
872
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
873
|
+
/**
|
874
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
875
|
+
*
|
876
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
877
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
878
|
+
* @returns {string} A string representing the location.
|
879
|
+
*/
|
880
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
881
|
+
/**
|
882
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
883
|
+
*
|
884
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
885
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
886
|
+
* @returns {string} A string representing the collection.
|
887
|
+
*/
|
888
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
889
|
+
/**
|
890
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
891
|
+
*
|
892
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
893
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
894
|
+
* @returns {string} A string representing the data_store.
|
895
|
+
*/
|
896
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
897
|
+
/**
|
898
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
899
|
+
*
|
900
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
901
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
902
|
+
* @returns {string} A string representing the conversation.
|
903
|
+
*/
|
904
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
905
|
+
/**
|
906
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
907
|
+
*
|
908
|
+
* @param {string} project
|
909
|
+
* @param {string} location
|
910
|
+
* @param {string} collection
|
911
|
+
* @param {string} data_store
|
912
|
+
* @param {string} schema
|
913
|
+
* @returns {string} Resource name string.
|
914
|
+
*/
|
915
|
+
projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
|
916
|
+
/**
|
917
|
+
* Parse the project from ProjectLocationCollectionDataStoreSchema resource.
|
918
|
+
*
|
919
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
920
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
921
|
+
* @returns {string} A string representing the project.
|
922
|
+
*/
|
923
|
+
matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
924
|
+
/**
|
925
|
+
* Parse the location from ProjectLocationCollectionDataStoreSchema resource.
|
926
|
+
*
|
927
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
928
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
929
|
+
* @returns {string} A string representing the location.
|
930
|
+
*/
|
931
|
+
matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
932
|
+
/**
|
933
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
|
934
|
+
*
|
935
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
936
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
937
|
+
* @returns {string} A string representing the collection.
|
938
|
+
*/
|
939
|
+
matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
940
|
+
/**
|
941
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
|
942
|
+
*
|
943
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
944
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
945
|
+
* @returns {string} A string representing the data_store.
|
946
|
+
*/
|
947
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
948
|
+
/**
|
949
|
+
* Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
|
950
|
+
*
|
951
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
952
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
953
|
+
* @returns {string} A string representing the schema.
|
954
|
+
*/
|
955
|
+
matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
956
|
+
/**
|
957
|
+
* Return a fully-qualified projectLocationDataStoreBranch resource name string.
|
958
|
+
*
|
959
|
+
* @param {string} project
|
960
|
+
* @param {string} location
|
961
|
+
* @param {string} data_store
|
962
|
+
* @param {string} branch
|
963
|
+
* @returns {string} Resource name string.
|
964
|
+
*/
|
965
|
+
projectLocationDataStoreBranchPath(project: string, location: string, dataStore: string, branch: string): string;
|
966
|
+
/**
|
967
|
+
* Parse the project from ProjectLocationDataStoreBranch resource.
|
968
|
+
*
|
969
|
+
* @param {string} projectLocationDataStoreBranchName
|
970
|
+
* A fully-qualified path representing project_location_data_store_branch resource.
|
971
|
+
* @returns {string} A string representing the project.
|
972
|
+
*/
|
973
|
+
matchProjectFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
|
974
|
+
/**
|
975
|
+
* Parse the location from ProjectLocationDataStoreBranch resource.
|
976
|
+
*
|
977
|
+
* @param {string} projectLocationDataStoreBranchName
|
978
|
+
* A fully-qualified path representing project_location_data_store_branch resource.
|
979
|
+
* @returns {string} A string representing the location.
|
980
|
+
*/
|
981
|
+
matchLocationFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
|
982
|
+
/**
|
983
|
+
* Parse the data_store from ProjectLocationDataStoreBranch resource.
|
984
|
+
*
|
985
|
+
* @param {string} projectLocationDataStoreBranchName
|
986
|
+
* A fully-qualified path representing project_location_data_store_branch resource.
|
987
|
+
* @returns {string} A string representing the data_store.
|
988
|
+
*/
|
989
|
+
matchDataStoreFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
|
990
|
+
/**
|
991
|
+
* Parse the branch from ProjectLocationDataStoreBranch resource.
|
992
|
+
*
|
993
|
+
* @param {string} projectLocationDataStoreBranchName
|
994
|
+
* A fully-qualified path representing project_location_data_store_branch resource.
|
995
|
+
* @returns {string} A string representing the branch.
|
996
|
+
*/
|
997
|
+
matchBranchFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
|
998
|
+
/**
|
999
|
+
* Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
|
1000
|
+
*
|
1001
|
+
* @param {string} project
|
1002
|
+
* @param {string} location
|
1003
|
+
* @param {string} data_store
|
1004
|
+
* @param {string} branch
|
1005
|
+
* @param {string} document
|
1006
|
+
* @returns {string} Resource name string.
|
1007
|
+
*/
|
1008
|
+
projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
|
1009
|
+
/**
|
1010
|
+
* Parse the project from ProjectLocationDataStoreBranchDocument resource.
|
1011
|
+
*
|
1012
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
1013
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
1014
|
+
* @returns {string} A string representing the project.
|
1015
|
+
*/
|
1016
|
+
matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
1017
|
+
/**
|
1018
|
+
* Parse the location from ProjectLocationDataStoreBranchDocument resource.
|
1019
|
+
*
|
1020
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
1021
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
1022
|
+
* @returns {string} A string representing the location.
|
1023
|
+
*/
|
1024
|
+
matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
1025
|
+
/**
|
1026
|
+
* Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
|
1027
|
+
*
|
1028
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
1029
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
1030
|
+
* @returns {string} A string representing the data_store.
|
1031
|
+
*/
|
1032
|
+
matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
1033
|
+
/**
|
1034
|
+
* Parse the branch from ProjectLocationDataStoreBranchDocument resource.
|
1035
|
+
*
|
1036
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
1037
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
1038
|
+
* @returns {string} A string representing the branch.
|
1039
|
+
*/
|
1040
|
+
matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
1041
|
+
/**
|
1042
|
+
* Parse the document from ProjectLocationDataStoreBranchDocument resource.
|
1043
|
+
*
|
1044
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
1045
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
1046
|
+
* @returns {string} A string representing the document.
|
1047
|
+
*/
|
1048
|
+
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
1049
|
+
/**
|
1050
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
1051
|
+
*
|
1052
|
+
* @param {string} project
|
1053
|
+
* @param {string} location
|
1054
|
+
* @param {string} data_store
|
1055
|
+
* @param {string} conversation
|
1056
|
+
* @returns {string} Resource name string.
|
1057
|
+
*/
|
1058
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
1059
|
+
/**
|
1060
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
1061
|
+
*
|
1062
|
+
* @param {string} projectLocationDataStoreConversationName
|
1063
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1064
|
+
* @returns {string} A string representing the project.
|
1065
|
+
*/
|
1066
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
1067
|
+
/**
|
1068
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
1069
|
+
*
|
1070
|
+
* @param {string} projectLocationDataStoreConversationName
|
1071
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1072
|
+
* @returns {string} A string representing the location.
|
1073
|
+
*/
|
1074
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
1075
|
+
/**
|
1076
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
1077
|
+
*
|
1078
|
+
* @param {string} projectLocationDataStoreConversationName
|
1079
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1080
|
+
* @returns {string} A string representing the data_store.
|
1081
|
+
*/
|
1082
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
1083
|
+
/**
|
1084
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
1085
|
+
*
|
1086
|
+
* @param {string} projectLocationDataStoreConversationName
|
1087
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1088
|
+
* @returns {string} A string representing the conversation.
|
1089
|
+
*/
|
1090
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
1091
|
+
/**
|
1092
|
+
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
1093
|
+
*
|
1094
|
+
* @param {string} project
|
1095
|
+
* @param {string} location
|
1096
|
+
* @param {string} data_store
|
1097
|
+
* @param {string} schema
|
1098
|
+
* @returns {string} Resource name string.
|
1099
|
+
*/
|
1100
|
+
projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
|
1101
|
+
/**
|
1102
|
+
* Parse the project from ProjectLocationDataStoreSchema resource.
|
1103
|
+
*
|
1104
|
+
* @param {string} projectLocationDataStoreSchemaName
|
1105
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
1106
|
+
* @returns {string} A string representing the project.
|
1107
|
+
*/
|
1108
|
+
matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
1109
|
+
/**
|
1110
|
+
* Parse the location from ProjectLocationDataStoreSchema resource.
|
1111
|
+
*
|
1112
|
+
* @param {string} projectLocationDataStoreSchemaName
|
1113
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
1114
|
+
* @returns {string} A string representing the location.
|
1115
|
+
*/
|
1116
|
+
matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
1117
|
+
/**
|
1118
|
+
* Parse the data_store from ProjectLocationDataStoreSchema resource.
|
1119
|
+
*
|
1120
|
+
* @param {string} projectLocationDataStoreSchemaName
|
1121
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
1122
|
+
* @returns {string} A string representing the data_store.
|
1123
|
+
*/
|
1124
|
+
matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
1125
|
+
/**
|
1126
|
+
* Parse the schema from ProjectLocationDataStoreSchema resource.
|
1127
|
+
*
|
1128
|
+
* @param {string} projectLocationDataStoreSchemaName
|
1129
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
1130
|
+
* @returns {string} A string representing the schema.
|
1131
|
+
*/
|
1132
|
+
matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
1133
|
+
/**
|
1134
|
+
* Terminate the gRPC channel and close the client.
|
1135
|
+
*
|
1136
|
+
* The client will no longer be usable and all future behavior is undefined.
|
1137
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
1138
|
+
*/
|
1139
|
+
close(): Promise<void>;
|
1140
|
+
}
|