@google-cloud/discoveryengine 1.3.0 → 1.4.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.
Files changed (131) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +63 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +54 -3
  4. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +52 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +51 -4
  6. package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +3 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +40 -1
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +98 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +304 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +215 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +242 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +64 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +137 -4
  16. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +170 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +691 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +3 -3
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +0 -5
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +1 -1
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +97 -0
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +59 -8
  29. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
  30. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
  31. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +40 -1
  33. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +98 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  36. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
  38. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
  39. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +38 -0
  40. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
  41. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +150 -11
  42. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +264 -0
  43. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +147 -0
  44. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
  45. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
  46. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
  47. package/build/protos/protos.d.ts +42822 -21397
  48. package/build/protos/protos.js +110509 -61572
  49. package/build/protos/protos.json +11779 -6752
  50. package/build/src/index.d.ts +10 -1
  51. package/build/src/index.js +11 -2
  52. package/build/src/v1/completion_service_client.d.ts +489 -7
  53. package/build/src/v1/completion_service_client.js +716 -12
  54. package/build/src/v1/completion_service_client_config.json +10 -0
  55. package/build/src/v1/conversational_search_service_client.d.ts +341 -3
  56. package/build/src/v1/conversational_search_service_client.js +467 -10
  57. package/build/src/v1/data_store_service_client.d.ts +1286 -0
  58. package/build/src/v1/data_store_service_client.js +1768 -0
  59. package/build/src/v1/data_store_service_client_config.json +46 -0
  60. package/build/src/v1/document_service_client.d.ts +347 -2
  61. package/build/src/v1/document_service_client.js +507 -10
  62. package/build/src/v1/engine_service_client.d.ts +1211 -0
  63. package/build/src/v1/engine_service_client.js +1731 -0
  64. package/build/src/v1/engine_service_client_config.json +46 -0
  65. package/build/src/v1/index.d.ts +3 -0
  66. package/build/src/v1/index.js +8 -2
  67. package/build/src/v1/schema_service_client.d.ts +272 -2
  68. package/build/src/v1/schema_service_client.js +403 -10
  69. package/build/src/v1/search_service_client.d.ts +515 -11
  70. package/build/src/v1/search_service_client.js +649 -16
  71. package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
  72. package/build/src/v1/site_search_engine_service_client.js +2075 -0
  73. package/build/src/v1/site_search_engine_service_client_config.json +74 -0
  74. package/build/src/v1/user_event_service_client.d.ts +272 -2
  75. package/build/src/v1/user_event_service_client.js +403 -10
  76. package/build/src/v1alpha/completion_service_client.d.ts +230 -2
  77. package/build/src/v1alpha/completion_service_client.js +339 -10
  78. package/build/src/v1alpha/conversational_search_service_client.d.ts +247 -2
  79. package/build/src/v1alpha/conversational_search_service_client.js +339 -10
  80. package/build/src/v1alpha/data_store_service_client.d.ts +230 -2
  81. package/build/src/v1alpha/data_store_service_client.js +347 -12
  82. package/build/src/v1alpha/document_service_client.d.ts +230 -2
  83. package/build/src/v1alpha/document_service_client.js +347 -12
  84. package/build/src/v1alpha/engine_service_client.d.ts +231 -3
  85. package/build/src/v1alpha/engine_service_client.js +347 -12
  86. package/build/src/v1alpha/index.d.ts +1 -0
  87. package/build/src/v1alpha/index.js +4 -2
  88. package/build/src/v1alpha/recommendation_service_client.d.ts +230 -2
  89. package/build/src/v1alpha/recommendation_service_client.js +339 -10
  90. package/build/src/v1alpha/schema_service_client.d.ts +230 -2
  91. package/build/src/v1alpha/schema_service_client.js +347 -12
  92. package/build/src/v1alpha/search_service_client.d.ts +269 -2
  93. package/build/src/v1alpha/search_service_client.js +365 -10
  94. package/build/src/v1alpha/search_tuning_service_client.d.ts +977 -0
  95. package/build/src/v1alpha/search_tuning_service_client.js +1479 -0
  96. package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
  97. package/build/src/v1alpha/site_search_engine_service_client.d.ts +750 -3
  98. package/build/src/v1alpha/site_search_engine_service_client.js +838 -14
  99. package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
  100. package/build/src/v1alpha/user_event_service_client.d.ts +230 -2
  101. package/build/src/v1alpha/user_event_service_client.js +347 -12
  102. package/build/src/v1beta/completion_service_client.d.ts +633 -7
  103. package/build/src/v1beta/completion_service_client.js +912 -12
  104. package/build/src/v1beta/completion_service_client_config.json +10 -0
  105. package/build/src/v1beta/conversational_search_service_client.d.ts +341 -3
  106. package/build/src/v1beta/conversational_search_service_client.js +467 -10
  107. package/build/src/v1beta/data_store_service_client.d.ts +1433 -0
  108. package/build/src/v1beta/data_store_service_client.js +1966 -0
  109. package/build/src/v1beta/data_store_service_client_config.json +46 -0
  110. package/build/src/v1beta/document_service_client.d.ts +491 -2
  111. package/build/src/v1beta/document_service_client.js +707 -12
  112. package/build/src/v1beta/engine_service_client.d.ts +1357 -0
  113. package/build/src/v1beta/engine_service_client.js +1928 -0
  114. package/build/src/v1beta/engine_service_client_config.json +46 -0
  115. package/build/src/v1beta/index.d.ts +4 -0
  116. package/build/src/v1beta/index.js +10 -2
  117. package/build/src/v1beta/recommendation_service_client.d.ts +420 -5
  118. package/build/src/v1beta/recommendation_service_client.js +571 -10
  119. package/build/src/v1beta/schema_service_client.d.ts +416 -2
  120. package/build/src/v1beta/schema_service_client.js +603 -12
  121. package/build/src/v1beta/search_service_client.d.ts +539 -29
  122. package/build/src/v1beta/search_service_client.js +665 -28
  123. package/build/src/v1beta/serving_config_service_client.d.ts +1102 -0
  124. package/build/src/v1beta/serving_config_service_client.js +1563 -0
  125. package/build/src/v1beta/serving_config_service_client_config.json +38 -0
  126. package/build/src/v1beta/site_search_engine_service_client.d.ts +1712 -0
  127. package/build/src/v1beta/site_search_engine_service_client.js +2271 -0
  128. package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
  129. package/build/src/v1beta/user_event_service_client.d.ts +416 -2
  130. package/build/src/v1beta/user_event_service_client.js +603 -12
  131. package/package.json +3 -3
@@ -0,0 +1,1433 @@
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
8
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore} configuration.
9
+ * @class
10
+ * @memberof v1beta
11
+ */
12
+ export declare class DataStoreServiceClient {
13
+ private _terminated;
14
+ private _opts;
15
+ private _providedCustomServicePath;
16
+ private _gaxModule;
17
+ private _gaxGrpc;
18
+ private _protos;
19
+ private _defaults;
20
+ private _universeDomain;
21
+ private _servicePath;
22
+ auth: gax.GoogleAuth;
23
+ descriptors: Descriptors;
24
+ warn: (code: string, message: string, warnType?: string) => void;
25
+ innerApiCalls: {
26
+ [name: string]: Function;
27
+ };
28
+ locationsClient: LocationsClient;
29
+ pathTemplates: {
30
+ [name: string]: gax.PathTemplate;
31
+ };
32
+ operationsClient: gax.OperationsClient;
33
+ dataStoreServiceStub?: Promise<{
34
+ [name: string]: Function;
35
+ }>;
36
+ /**
37
+ * Construct an instance of DataStoreServiceClient.
38
+ *
39
+ * @param {object} [options] - The configuration object.
40
+ * The options accepted by the constructor are described in detail
41
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
42
+ * The common options are:
43
+ * @param {object} [options.credentials] - Credentials object.
44
+ * @param {string} [options.credentials.client_email]
45
+ * @param {string} [options.credentials.private_key]
46
+ * @param {string} [options.email] - Account email address. Required when
47
+ * using a .pem or .p12 keyFilename.
48
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
49
+ * .p12 key downloaded from the Google Developers Console. If you provide
50
+ * a path to a JSON file, the projectId option below is not necessary.
51
+ * NOTE: .pem and .p12 require you to specify options.email as well.
52
+ * @param {number} [options.port] - The port on which to connect to
53
+ * the remote host.
54
+ * @param {string} [options.projectId] - The project ID from the Google
55
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
56
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
57
+ * app is running in an environment which supports
58
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
59
+ * your project ID will be detected automatically.
60
+ * @param {string} [options.apiEndpoint] - The domain name of the
61
+ * API remote host.
62
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
63
+ * Follows the structure of {@link gapicConfig}.
64
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
65
+ * For more information, please check the
66
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
67
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
68
+ * need to avoid loading the default gRPC version and want to use the fallback
69
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
70
+ * ```
71
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
72
+ * const client = new DataStoreServiceClient({fallback: true}, gax);
73
+ * ```
74
+ */
75
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
76
+ /**
77
+ * Initialize the client.
78
+ * Performs asynchronous operations (such as authentication) and prepares the client.
79
+ * This function will be called automatically when any class method is called for the
80
+ * first time, but if you need to initialize it before calling an actual method,
81
+ * feel free to call initialize() directly.
82
+ *
83
+ * You can await on this method if you want to make sure the client is initialized.
84
+ *
85
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
86
+ */
87
+ initialize(): Promise<{
88
+ [name: string]: Function;
89
+ }>;
90
+ /**
91
+ * The DNS address for this API service.
92
+ * @deprecated Use the apiEndpoint method of the client instance.
93
+ * @returns {string} The DNS address for this service.
94
+ */
95
+ static get servicePath(): string;
96
+ /**
97
+ * The DNS address for this API service - same as servicePath.
98
+ * @deprecated Use the apiEndpoint method of the client instance.
99
+ * @returns {string} The DNS address for this service.
100
+ */
101
+ static get apiEndpoint(): string;
102
+ /**
103
+ * The DNS address for this API service.
104
+ * @returns {string} The DNS address for this service.
105
+ */
106
+ get apiEndpoint(): string;
107
+ get universeDomain(): string;
108
+ /**
109
+ * The port for this API service.
110
+ * @returns {number} The default port for this service.
111
+ */
112
+ static get port(): number;
113
+ /**
114
+ * The scopes needed to make gRPC calls for every method defined
115
+ * in this service.
116
+ * @returns {string[]} List of default scopes.
117
+ */
118
+ static get scopes(): string[];
119
+ getProjectId(): Promise<string>;
120
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
121
+ /**
122
+ * Gets a {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}.
123
+ *
124
+ * @param {Object} request
125
+ * The request object that will be sent.
126
+ * @param {string} request.name
127
+ * Required. Full resource name of
128
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}, such as
129
+ * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
130
+ *
131
+ * If the caller does not have permission to access the
132
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}, regardless of
133
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
134
+ *
135
+ * If the requested {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}
136
+ * does not exist, a NOT_FOUND error is returned.
137
+ * @param {object} [options]
138
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
139
+ * @returns {Promise} - The promise which resolves to an array.
140
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}.
141
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
142
+ * for more details and examples.
143
+ * @example <caption>include:samples/generated/v1beta/data_store_service.get_data_store.js</caption>
144
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_GetDataStore_async
145
+ */
146
+ getDataStore(request?: protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest, options?: CallOptions): Promise<[
147
+ protos.google.cloud.discoveryengine.v1beta.IDataStore,
148
+ (protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest | undefined),
149
+ {} | undefined
150
+ ]>;
151
+ getDataStore(request: protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDataStore, protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest | null | undefined, {} | null | undefined>): void;
152
+ getDataStore(request: protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDataStore, protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest | null | undefined, {} | null | undefined>): void;
153
+ /**
154
+ * Updates a {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}
155
+ *
156
+ * @param {Object} request
157
+ * The request object that will be sent.
158
+ * @param {google.cloud.discoveryengine.v1beta.DataStore} request.dataStore
159
+ * Required. The {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore} to
160
+ * update.
161
+ *
162
+ * If the caller does not have permission to update the
163
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}, regardless of
164
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
165
+ *
166
+ * If the {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore} to update
167
+ * does not exist, a NOT_FOUND error is returned.
168
+ * @param {google.protobuf.FieldMask} request.updateMask
169
+ * Indicates which fields in the provided
170
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore} to update.
171
+ *
172
+ * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
173
+ * 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.v1beta.DataStore|DataStore}.
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/v1beta/data_store_service.update_data_store.js</caption>
181
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_UpdateDataStore_async
182
+ */
183
+ updateDataStore(request?: protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest, options?: CallOptions): Promise<[
184
+ protos.google.cloud.discoveryengine.v1beta.IDataStore,
185
+ (protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest | undefined),
186
+ {} | undefined
187
+ ]>;
188
+ updateDataStore(request: protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDataStore, protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest | null | undefined, {} | null | undefined>): void;
189
+ updateDataStore(request: protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDataStore, protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest | null | undefined, {} | null | undefined>): void;
190
+ /**
191
+ * Creates a {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}.
192
+ *
193
+ * DataStore is for storing
194
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Documents}. To serve these
195
+ * documents for Search, or Recommendation use case, an
196
+ * {@link protos.google.cloud.discoveryengine.v1beta.Engine|Engine} needs to be created
197
+ * separately.
198
+ *
199
+ * @param {Object} request
200
+ * The request object that will be sent.
201
+ * @param {string} request.parent
202
+ * Required. The parent resource name, such as
203
+ * `projects/{project}/locations/{location}/collections/{collection}`.
204
+ * @param {google.cloud.discoveryengine.v1beta.DataStore} request.dataStore
205
+ * Required. The {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore} to
206
+ * create.
207
+ * @param {string} request.dataStoreId
208
+ * Required. The ID to use for the
209
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}, which will
210
+ * become the final component of the
211
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}'s resource name.
212
+ *
213
+ * This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
214
+ * standard with a length limit of 63 characters. Otherwise, an
215
+ * INVALID_ARGUMENT error is returned.
216
+ * @param {boolean} request.createAdvancedSiteSearch
217
+ * A boolean flag indicating whether user want to directly create an advanced
218
+ * data store for site search.
219
+ * If the data store is not configured as site
220
+ * search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
221
+ * be ignored.
222
+ * @param {object} [options]
223
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
224
+ * @returns {Promise} - The promise which resolves to an array.
225
+ * The first element of the array is an object representing
226
+ * a long running operation. Its `promise()` method returns a promise
227
+ * you can `await` for.
228
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
229
+ * for more details and examples.
230
+ * @example <caption>include:samples/generated/v1beta/data_store_service.create_data_store.js</caption>
231
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_CreateDataStore_async
232
+ */
233
+ createDataStore(request?: protos.google.cloud.discoveryengine.v1beta.ICreateDataStoreRequest, options?: CallOptions): Promise<[
234
+ LROperation<protos.google.cloud.discoveryengine.v1beta.IDataStore, protos.google.cloud.discoveryengine.v1beta.ICreateDataStoreMetadata>,
235
+ protos.google.longrunning.IOperation | undefined,
236
+ {} | undefined
237
+ ]>;
238
+ createDataStore(request: protos.google.cloud.discoveryengine.v1beta.ICreateDataStoreRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IDataStore, protos.google.cloud.discoveryengine.v1beta.ICreateDataStoreMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
239
+ createDataStore(request: protos.google.cloud.discoveryengine.v1beta.ICreateDataStoreRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IDataStore, protos.google.cloud.discoveryengine.v1beta.ICreateDataStoreMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
240
+ /**
241
+ * Check the status of the long running operation returned by `createDataStore()`.
242
+ * @param {String} name
243
+ * The operation name that will be passed.
244
+ * @returns {Promise} - The promise which resolves to an object.
245
+ * The decoded operation object has result and metadata field to get information from.
246
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
247
+ * for more details and examples.
248
+ * @example <caption>include:samples/generated/v1beta/data_store_service.create_data_store.js</caption>
249
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_CreateDataStore_async
250
+ */
251
+ checkCreateDataStoreProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.DataStore, protos.google.cloud.discoveryengine.v1beta.CreateDataStoreMetadata>>;
252
+ /**
253
+ * Deletes a {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}.
254
+ *
255
+ * @param {Object} request
256
+ * The request object that will be sent.
257
+ * @param {string} request.name
258
+ * Required. Full resource name of
259
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}, such as
260
+ * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
261
+ *
262
+ * If the caller does not have permission to delete the
263
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}, regardless of
264
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
265
+ *
266
+ * If the {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore} to delete
267
+ * does not exist, a NOT_FOUND error is returned.
268
+ * @param {object} [options]
269
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
270
+ * @returns {Promise} - The promise which resolves to an array.
271
+ * The first element of the array is an object representing
272
+ * a long running operation. Its `promise()` method returns a promise
273
+ * you can `await` for.
274
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
275
+ * for more details and examples.
276
+ * @example <caption>include:samples/generated/v1beta/data_store_service.delete_data_store.js</caption>
277
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_DeleteDataStore_async
278
+ */
279
+ deleteDataStore(request?: protos.google.cloud.discoveryengine.v1beta.IDeleteDataStoreRequest, options?: CallOptions): Promise<[
280
+ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteDataStoreMetadata>,
281
+ protos.google.longrunning.IOperation | undefined,
282
+ {} | undefined
283
+ ]>;
284
+ deleteDataStore(request: protos.google.cloud.discoveryengine.v1beta.IDeleteDataStoreRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteDataStoreMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
285
+ deleteDataStore(request: protos.google.cloud.discoveryengine.v1beta.IDeleteDataStoreRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteDataStoreMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
286
+ /**
287
+ * Check the status of the long running operation returned by `deleteDataStore()`.
288
+ * @param {String} name
289
+ * The operation name that will be passed.
290
+ * @returns {Promise} - The promise which resolves to an object.
291
+ * The decoded operation object has result and metadata field to get information from.
292
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
293
+ * for more details and examples.
294
+ * @example <caption>include:samples/generated/v1beta/data_store_service.delete_data_store.js</caption>
295
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_DeleteDataStore_async
296
+ */
297
+ checkDeleteDataStoreProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1beta.DeleteDataStoreMetadata>>;
298
+ /**
299
+ * Lists all the {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s
300
+ * associated with the project.
301
+ *
302
+ * @param {Object} request
303
+ * The request object that will be sent.
304
+ * @param {string} request.parent
305
+ * Required. The parent branch resource name, such as
306
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
307
+ *
308
+ * If the caller does not have permission to list
309
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s under this
310
+ * location, regardless of whether or not this data store exists, a
311
+ * PERMISSION_DENIED error is returned.
312
+ * @param {number} request.pageSize
313
+ * Maximum number of
314
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s to return. If
315
+ * unspecified, defaults to 10. The maximum allowed value is 50. Values above
316
+ * 50 will be coerced to 50.
317
+ *
318
+ * If this field is negative, an INVALID_ARGUMENT is returned.
319
+ * @param {string} request.pageToken
320
+ * A page token
321
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
322
+ * received from a previous
323
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
324
+ * call. Provide this to retrieve the subsequent page.
325
+ *
326
+ * When paginating, all other parameters provided to
327
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
328
+ * must match the call that provided the page token. Otherwise, an
329
+ * INVALID_ARGUMENT error is returned.
330
+ * @param {string} request.filter
331
+ * Filter by solution type. For example: filter =
332
+ * 'solution_type:SOLUTION_TYPE_SEARCH'
333
+ * @param {object} [options]
334
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
335
+ * @returns {Promise} - The promise which resolves to an array.
336
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}.
337
+ * The client library will perform auto-pagination by default: it will call the API as many
338
+ * times as needed and will merge results from all the pages into this array.
339
+ * Note that it can affect your quota.
340
+ * We recommend using `listDataStoresAsync()`
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
+ listDataStores(request?: protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest, options?: CallOptions): Promise<[
346
+ protos.google.cloud.discoveryengine.v1beta.IDataStore[],
347
+ protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest | null,
348
+ protos.google.cloud.discoveryengine.v1beta.IListDataStoresResponse
349
+ ]>;
350
+ listDataStores(request: protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest, protos.google.cloud.discoveryengine.v1beta.IListDataStoresResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.IDataStore>): void;
351
+ listDataStores(request: protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest, protos.google.cloud.discoveryengine.v1beta.IListDataStoresResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.IDataStore>): void;
352
+ /**
353
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
354
+ * @param {Object} request
355
+ * The request object that will be sent.
356
+ * @param {string} request.parent
357
+ * Required. The parent branch resource name, such as
358
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
359
+ *
360
+ * If the caller does not have permission to list
361
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s under this
362
+ * location, regardless of whether or not this data store exists, a
363
+ * PERMISSION_DENIED error is returned.
364
+ * @param {number} request.pageSize
365
+ * Maximum number of
366
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s to return. If
367
+ * unspecified, defaults to 10. The maximum allowed value is 50. Values above
368
+ * 50 will be coerced to 50.
369
+ *
370
+ * If this field is negative, an INVALID_ARGUMENT is returned.
371
+ * @param {string} request.pageToken
372
+ * A page token
373
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
374
+ * received from a previous
375
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
376
+ * call. Provide this to retrieve the subsequent page.
377
+ *
378
+ * When paginating, all other parameters provided to
379
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
380
+ * must match the call that provided the page token. Otherwise, an
381
+ * INVALID_ARGUMENT error is returned.
382
+ * @param {string} request.filter
383
+ * Filter by solution type. For example: filter =
384
+ * 'solution_type:SOLUTION_TYPE_SEARCH'
385
+ * @param {object} [options]
386
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
387
+ * @returns {Stream}
388
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore} on 'data' event.
389
+ * The client library will perform auto-pagination by default: it will call the API as many
390
+ * times as needed. Note that it can affect your quota.
391
+ * We recommend using `listDataStoresAsync()`
392
+ * method described below for async iteration which you can stop as needed.
393
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
394
+ * for more details and examples.
395
+ */
396
+ listDataStoresStream(request?: protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest, options?: CallOptions): Transform;
397
+ /**
398
+ * Equivalent to `listDataStores`, but returns an iterable object.
399
+ *
400
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
401
+ * @param {Object} request
402
+ * The request object that will be sent.
403
+ * @param {string} request.parent
404
+ * Required. The parent branch resource name, such as
405
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
406
+ *
407
+ * If the caller does not have permission to list
408
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s under this
409
+ * location, regardless of whether or not this data store exists, a
410
+ * PERMISSION_DENIED error is returned.
411
+ * @param {number} request.pageSize
412
+ * Maximum number of
413
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s to return. If
414
+ * unspecified, defaults to 10. The maximum allowed value is 50. Values above
415
+ * 50 will be coerced to 50.
416
+ *
417
+ * If this field is negative, an INVALID_ARGUMENT is returned.
418
+ * @param {string} request.pageToken
419
+ * A page token
420
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
421
+ * received from a previous
422
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
423
+ * call. Provide this to retrieve the subsequent page.
424
+ *
425
+ * When paginating, all other parameters provided to
426
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
427
+ * must match the call that provided the page token. Otherwise, an
428
+ * INVALID_ARGUMENT error is returned.
429
+ * @param {string} request.filter
430
+ * Filter by solution type. For example: filter =
431
+ * 'solution_type:SOLUTION_TYPE_SEARCH'
432
+ * @param {object} [options]
433
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
434
+ * @returns {Object}
435
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
436
+ * When you iterate the returned iterable, each element will be an object representing
437
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}. The API will be called under the hood as needed, once per the page,
438
+ * so you can stop the iteration when you don't need more results.
439
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
440
+ * for more details and examples.
441
+ * @example <caption>include:samples/generated/v1beta/data_store_service.list_data_stores.js</caption>
442
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_ListDataStores_async
443
+ */
444
+ listDataStoresAsync(request?: protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.IDataStore>;
445
+ /**
446
+ * Gets information about a location.
447
+ *
448
+ * @param {Object} request
449
+ * The request object that will be sent.
450
+ * @param {string} request.name
451
+ * Resource name for the location.
452
+ * @param {object} [options]
453
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
454
+ * @returns {Promise} - The promise which resolves to an array.
455
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
456
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
457
+ * for more details and examples.
458
+ * @example
459
+ * ```
460
+ * const [response] = await client.getLocation(request);
461
+ * ```
462
+ */
463
+ 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>;
464
+ /**
465
+ * Lists information about the supported locations for this service. Returns an iterable object.
466
+ *
467
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
468
+ * @param {Object} request
469
+ * The request object that will be sent.
470
+ * @param {string} request.name
471
+ * The resource that owns the locations collection, if applicable.
472
+ * @param {string} request.filter
473
+ * The standard list filter.
474
+ * @param {number} request.pageSize
475
+ * The standard list page size.
476
+ * @param {string} request.pageToken
477
+ * The standard list page token.
478
+ * @param {object} [options]
479
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
480
+ * @returns {Object}
481
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
482
+ * When you iterate the returned iterable, each element will be an object representing
483
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
484
+ * so you can stop the iteration when you don't need more results.
485
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
486
+ * for more details and examples.
487
+ * @example
488
+ * ```
489
+ * const iterable = client.listLocationsAsync(request);
490
+ * for await (const response of iterable) {
491
+ * // process response
492
+ * }
493
+ * ```
494
+ */
495
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
496
+ /**
497
+ * Gets the latest state of a long-running operation. Clients can use this
498
+ * method to poll the operation result at intervals as recommended by the API
499
+ * service.
500
+ *
501
+ * @param {Object} request - The request object that will be sent.
502
+ * @param {string} request.name - The name of the operation resource.
503
+ * @param {Object=} options
504
+ * Optional parameters. You can override the default settings for this call,
505
+ * e.g, timeout, retries, paginations, etc. See {@link
506
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
507
+ * for the details.
508
+ * @param {function(?Error, ?Object)=} callback
509
+ * The function which will be called with the result of the API call.
510
+ *
511
+ * The second parameter to the callback is an object representing
512
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
513
+ * @return {Promise} - The promise which resolves to an array.
514
+ * The first element of the array is an object representing
515
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
516
+ * The promise has a method named "cancel" which cancels the ongoing API call.
517
+ *
518
+ * @example
519
+ * ```
520
+ * const client = longrunning.operationsClient();
521
+ * const name = '';
522
+ * const [response] = await client.getOperation({name});
523
+ * // doThingsWith(response)
524
+ * ```
525
+ */
526
+ 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]>;
527
+ /**
528
+ * Lists operations that match the specified filter in the request. If the
529
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
530
+ *
531
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
532
+ *
533
+ * @param {Object} request - The request object that will be sent.
534
+ * @param {string} request.name - The name of the operation collection.
535
+ * @param {string} request.filter - The standard list filter.
536
+ * @param {number=} request.pageSize -
537
+ * The maximum number of resources contained in the underlying API
538
+ * response. If page streaming is performed per-resource, this
539
+ * parameter does not affect the return value. If page streaming is
540
+ * performed per-page, this determines the maximum number of
541
+ * resources in a page.
542
+ * @param {Object=} options
543
+ * Optional parameters. You can override the default settings for this call,
544
+ * e.g, timeout, retries, paginations, etc. See {@link
545
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
546
+ * details.
547
+ * @returns {Object}
548
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
549
+ *
550
+ * @example
551
+ * ```
552
+ * const client = longrunning.operationsClient();
553
+ * for await (const response of client.listOperationsAsync(request));
554
+ * // doThingsWith(response)
555
+ * ```
556
+ */
557
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
558
+ /**
559
+ * Starts asynchronous cancellation on a long-running operation. The server
560
+ * makes a best effort to cancel the operation, but success is not
561
+ * guaranteed. If the server doesn't support this method, it returns
562
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
563
+ * {@link Operations.GetOperation} or
564
+ * other methods to check whether the cancellation succeeded or whether the
565
+ * operation completed despite cancellation. On successful cancellation,
566
+ * the operation is not deleted; instead, it becomes an operation with
567
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
568
+ * 1, corresponding to `Code.CANCELLED`.
569
+ *
570
+ * @param {Object} request - The request object that will be sent.
571
+ * @param {string} request.name - The name of the operation resource to be cancelled.
572
+ * @param {Object=} options
573
+ * Optional parameters. You can override the default settings for this call,
574
+ * e.g, timeout, retries, paginations, etc. See {@link
575
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
576
+ * details.
577
+ * @param {function(?Error)=} callback
578
+ * The function which will be called with the result of the API call.
579
+ * @return {Promise} - The promise which resolves when API call finishes.
580
+ * The promise has a method named "cancel" which cancels the ongoing API
581
+ * call.
582
+ *
583
+ * @example
584
+ * ```
585
+ * const client = longrunning.operationsClient();
586
+ * await client.cancelOperation({name: ''});
587
+ * ```
588
+ */
589
+ 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>;
590
+ /**
591
+ * Deletes a long-running operation. This method indicates that the client is
592
+ * no longer interested in the operation result. It does not cancel the
593
+ * operation. If the server doesn't support this method, it returns
594
+ * `google.rpc.Code.UNIMPLEMENTED`.
595
+ *
596
+ * @param {Object} request - The request object that will be sent.
597
+ * @param {string} request.name - The name of the operation resource to be deleted.
598
+ * @param {Object=} options
599
+ * Optional parameters. You can override the default settings for this call,
600
+ * e.g, timeout, retries, paginations, etc. See {@link
601
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
602
+ * for the details.
603
+ * @param {function(?Error)=} callback
604
+ * The function which will be called with the result of the API call.
605
+ * @return {Promise} - The promise which resolves when API call finishes.
606
+ * The promise has a method named "cancel" which cancels the ongoing API
607
+ * call.
608
+ *
609
+ * @example
610
+ * ```
611
+ * const client = longrunning.operationsClient();
612
+ * await client.deleteOperation({name: ''});
613
+ * ```
614
+ */
615
+ 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>;
616
+ /**
617
+ * Return a fully-qualified collection resource name string.
618
+ *
619
+ * @param {string} project
620
+ * @param {string} location
621
+ * @param {string} collection
622
+ * @returns {string} Resource name string.
623
+ */
624
+ collectionPath(project: string, location: string, collection: string): string;
625
+ /**
626
+ * Parse the project from Collection resource.
627
+ *
628
+ * @param {string} collectionName
629
+ * A fully-qualified path representing Collection resource.
630
+ * @returns {string} A string representing the project.
631
+ */
632
+ matchProjectFromCollectionName(collectionName: string): string | number;
633
+ /**
634
+ * Parse the location from Collection resource.
635
+ *
636
+ * @param {string} collectionName
637
+ * A fully-qualified path representing Collection resource.
638
+ * @returns {string} A string representing the location.
639
+ */
640
+ matchLocationFromCollectionName(collectionName: string): string | number;
641
+ /**
642
+ * Parse the collection from Collection resource.
643
+ *
644
+ * @param {string} collectionName
645
+ * A fully-qualified path representing Collection resource.
646
+ * @returns {string} A string representing the collection.
647
+ */
648
+ matchCollectionFromCollectionName(collectionName: string): string | number;
649
+ /**
650
+ * Return a fully-qualified engine resource name string.
651
+ *
652
+ * @param {string} project
653
+ * @param {string} location
654
+ * @param {string} collection
655
+ * @param {string} engine
656
+ * @returns {string} Resource name string.
657
+ */
658
+ enginePath(project: string, location: string, collection: string, engine: string): string;
659
+ /**
660
+ * Parse the project from Engine resource.
661
+ *
662
+ * @param {string} engineName
663
+ * A fully-qualified path representing Engine resource.
664
+ * @returns {string} A string representing the project.
665
+ */
666
+ matchProjectFromEngineName(engineName: string): string | number;
667
+ /**
668
+ * Parse the location from Engine resource.
669
+ *
670
+ * @param {string} engineName
671
+ * A fully-qualified path representing Engine resource.
672
+ * @returns {string} A string representing the location.
673
+ */
674
+ matchLocationFromEngineName(engineName: string): string | number;
675
+ /**
676
+ * Parse the collection from Engine resource.
677
+ *
678
+ * @param {string} engineName
679
+ * A fully-qualified path representing Engine resource.
680
+ * @returns {string} A string representing the collection.
681
+ */
682
+ matchCollectionFromEngineName(engineName: string): string | number;
683
+ /**
684
+ * Parse the engine from Engine resource.
685
+ *
686
+ * @param {string} engineName
687
+ * A fully-qualified path representing Engine resource.
688
+ * @returns {string} A string representing the engine.
689
+ */
690
+ matchEngineFromEngineName(engineName: string): string | number;
691
+ /**
692
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
693
+ *
694
+ * @param {string} project
695
+ * @param {string} location
696
+ * @param {string} collection
697
+ * @param {string} data_store
698
+ * @returns {string} Resource name string.
699
+ */
700
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
701
+ /**
702
+ * Parse the project from ProjectLocationCollectionDataStore resource.
703
+ *
704
+ * @param {string} projectLocationCollectionDataStoreName
705
+ * A fully-qualified path representing project_location_collection_data_store resource.
706
+ * @returns {string} A string representing the project.
707
+ */
708
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
709
+ /**
710
+ * Parse the location from ProjectLocationCollectionDataStore resource.
711
+ *
712
+ * @param {string} projectLocationCollectionDataStoreName
713
+ * A fully-qualified path representing project_location_collection_data_store resource.
714
+ * @returns {string} A string representing the location.
715
+ */
716
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
717
+ /**
718
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
719
+ *
720
+ * @param {string} projectLocationCollectionDataStoreName
721
+ * A fully-qualified path representing project_location_collection_data_store resource.
722
+ * @returns {string} A string representing the collection.
723
+ */
724
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
725
+ /**
726
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
727
+ *
728
+ * @param {string} projectLocationCollectionDataStoreName
729
+ * A fully-qualified path representing project_location_collection_data_store resource.
730
+ * @returns {string} A string representing the data_store.
731
+ */
732
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
733
+ /**
734
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
735
+ *
736
+ * @param {string} project
737
+ * @param {string} location
738
+ * @param {string} collection
739
+ * @param {string} data_store
740
+ * @param {string} branch
741
+ * @param {string} document
742
+ * @returns {string} Resource name string.
743
+ */
744
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
745
+ /**
746
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
747
+ *
748
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
749
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
750
+ * @returns {string} A string representing the project.
751
+ */
752
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
753
+ /**
754
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
755
+ *
756
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
757
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
758
+ * @returns {string} A string representing the location.
759
+ */
760
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
761
+ /**
762
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
763
+ *
764
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
765
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
766
+ * @returns {string} A string representing the collection.
767
+ */
768
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
769
+ /**
770
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
771
+ *
772
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
773
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
774
+ * @returns {string} A string representing the data_store.
775
+ */
776
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
777
+ /**
778
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
779
+ *
780
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
781
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
782
+ * @returns {string} A string representing the branch.
783
+ */
784
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
785
+ /**
786
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
787
+ *
788
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
789
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
790
+ * @returns {string} A string representing the document.
791
+ */
792
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
793
+ /**
794
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
795
+ *
796
+ * @param {string} project
797
+ * @param {string} location
798
+ * @param {string} collection
799
+ * @param {string} data_store
800
+ * @param {string} conversation
801
+ * @returns {string} Resource name string.
802
+ */
803
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
804
+ /**
805
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
806
+ *
807
+ * @param {string} projectLocationCollectionDataStoreConversationName
808
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
809
+ * @returns {string} A string representing the project.
810
+ */
811
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
812
+ /**
813
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
814
+ *
815
+ * @param {string} projectLocationCollectionDataStoreConversationName
816
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
817
+ * @returns {string} A string representing the location.
818
+ */
819
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
820
+ /**
821
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
822
+ *
823
+ * @param {string} projectLocationCollectionDataStoreConversationName
824
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
825
+ * @returns {string} A string representing the collection.
826
+ */
827
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
828
+ /**
829
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
830
+ *
831
+ * @param {string} projectLocationCollectionDataStoreConversationName
832
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
833
+ * @returns {string} A string representing the data_store.
834
+ */
835
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
836
+ /**
837
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
838
+ *
839
+ * @param {string} projectLocationCollectionDataStoreConversationName
840
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
841
+ * @returns {string} A string representing the conversation.
842
+ */
843
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
844
+ /**
845
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
846
+ *
847
+ * @param {string} project
848
+ * @param {string} location
849
+ * @param {string} collection
850
+ * @param {string} data_store
851
+ * @param {string} schema
852
+ * @returns {string} Resource name string.
853
+ */
854
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
855
+ /**
856
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
857
+ *
858
+ * @param {string} projectLocationCollectionDataStoreSchemaName
859
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
860
+ * @returns {string} A string representing the project.
861
+ */
862
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
863
+ /**
864
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
865
+ *
866
+ * @param {string} projectLocationCollectionDataStoreSchemaName
867
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
868
+ * @returns {string} A string representing the location.
869
+ */
870
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
871
+ /**
872
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
873
+ *
874
+ * @param {string} projectLocationCollectionDataStoreSchemaName
875
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
876
+ * @returns {string} A string representing the collection.
877
+ */
878
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
879
+ /**
880
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
881
+ *
882
+ * @param {string} projectLocationCollectionDataStoreSchemaName
883
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
884
+ * @returns {string} A string representing the data_store.
885
+ */
886
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
887
+ /**
888
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
889
+ *
890
+ * @param {string} projectLocationCollectionDataStoreSchemaName
891
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
892
+ * @returns {string} A string representing the schema.
893
+ */
894
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
895
+ /**
896
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
897
+ *
898
+ * @param {string} project
899
+ * @param {string} location
900
+ * @param {string} collection
901
+ * @param {string} data_store
902
+ * @param {string} serving_config
903
+ * @returns {string} Resource name string.
904
+ */
905
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
906
+ /**
907
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
908
+ *
909
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
910
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
911
+ * @returns {string} A string representing the project.
912
+ */
913
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
914
+ /**
915
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
916
+ *
917
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
918
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
919
+ * @returns {string} A string representing the location.
920
+ */
921
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
922
+ /**
923
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
924
+ *
925
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
926
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
927
+ * @returns {string} A string representing the collection.
928
+ */
929
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
930
+ /**
931
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
932
+ *
933
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
934
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
935
+ * @returns {string} A string representing the data_store.
936
+ */
937
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
938
+ /**
939
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
940
+ *
941
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
942
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
943
+ * @returns {string} A string representing the serving_config.
944
+ */
945
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
946
+ /**
947
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
948
+ *
949
+ * @param {string} project
950
+ * @param {string} location
951
+ * @param {string} collection
952
+ * @param {string} data_store
953
+ * @returns {string} Resource name string.
954
+ */
955
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
956
+ /**
957
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
958
+ *
959
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
960
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
961
+ * @returns {string} A string representing the project.
962
+ */
963
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
964
+ /**
965
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
966
+ *
967
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
968
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
969
+ * @returns {string} A string representing the location.
970
+ */
971
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
972
+ /**
973
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
974
+ *
975
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
976
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
977
+ * @returns {string} A string representing the collection.
978
+ */
979
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
980
+ /**
981
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
982
+ *
983
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
984
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
985
+ * @returns {string} A string representing the data_store.
986
+ */
987
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
988
+ /**
989
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
990
+ *
991
+ * @param {string} project
992
+ * @param {string} location
993
+ * @param {string} collection
994
+ * @param {string} data_store
995
+ * @param {string} target_site
996
+ * @returns {string} Resource name string.
997
+ */
998
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
999
+ /**
1000
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1001
+ *
1002
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1003
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1004
+ * @returns {string} A string representing the project.
1005
+ */
1006
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1007
+ /**
1008
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1009
+ *
1010
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1011
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1012
+ * @returns {string} A string representing the location.
1013
+ */
1014
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1015
+ /**
1016
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1017
+ *
1018
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1019
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1020
+ * @returns {string} A string representing the collection.
1021
+ */
1022
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1023
+ /**
1024
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1025
+ *
1026
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1027
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1028
+ * @returns {string} A string representing the data_store.
1029
+ */
1030
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1031
+ /**
1032
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1033
+ *
1034
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1035
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1036
+ * @returns {string} A string representing the target_site.
1037
+ */
1038
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1039
+ /**
1040
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1041
+ *
1042
+ * @param {string} project
1043
+ * @param {string} location
1044
+ * @param {string} collection
1045
+ * @param {string} engine
1046
+ * @param {string} conversation
1047
+ * @returns {string} Resource name string.
1048
+ */
1049
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
1050
+ /**
1051
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1052
+ *
1053
+ * @param {string} projectLocationCollectionEngineConversationName
1054
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1055
+ * @returns {string} A string representing the project.
1056
+ */
1057
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1058
+ /**
1059
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1060
+ *
1061
+ * @param {string} projectLocationCollectionEngineConversationName
1062
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1063
+ * @returns {string} A string representing the location.
1064
+ */
1065
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1066
+ /**
1067
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1068
+ *
1069
+ * @param {string} projectLocationCollectionEngineConversationName
1070
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1071
+ * @returns {string} A string representing the collection.
1072
+ */
1073
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1074
+ /**
1075
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1076
+ *
1077
+ * @param {string} projectLocationCollectionEngineConversationName
1078
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1079
+ * @returns {string} A string representing the engine.
1080
+ */
1081
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1082
+ /**
1083
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1084
+ *
1085
+ * @param {string} projectLocationCollectionEngineConversationName
1086
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1087
+ * @returns {string} A string representing the conversation.
1088
+ */
1089
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1090
+ /**
1091
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1092
+ *
1093
+ * @param {string} project
1094
+ * @param {string} location
1095
+ * @param {string} collection
1096
+ * @param {string} engine
1097
+ * @param {string} serving_config
1098
+ * @returns {string} Resource name string.
1099
+ */
1100
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
1101
+ /**
1102
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
1103
+ *
1104
+ * @param {string} projectLocationCollectionEngineServingConfigName
1105
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1106
+ * @returns {string} A string representing the project.
1107
+ */
1108
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1109
+ /**
1110
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
1111
+ *
1112
+ * @param {string} projectLocationCollectionEngineServingConfigName
1113
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1114
+ * @returns {string} A string representing the location.
1115
+ */
1116
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1117
+ /**
1118
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
1119
+ *
1120
+ * @param {string} projectLocationCollectionEngineServingConfigName
1121
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1122
+ * @returns {string} A string representing the collection.
1123
+ */
1124
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1125
+ /**
1126
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
1127
+ *
1128
+ * @param {string} projectLocationCollectionEngineServingConfigName
1129
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1130
+ * @returns {string} A string representing the engine.
1131
+ */
1132
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1133
+ /**
1134
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
1135
+ *
1136
+ * @param {string} projectLocationCollectionEngineServingConfigName
1137
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1138
+ * @returns {string} A string representing the serving_config.
1139
+ */
1140
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1141
+ /**
1142
+ * Return a fully-qualified projectLocationDataStore resource name string.
1143
+ *
1144
+ * @param {string} project
1145
+ * @param {string} location
1146
+ * @param {string} data_store
1147
+ * @returns {string} Resource name string.
1148
+ */
1149
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
1150
+ /**
1151
+ * Parse the project from ProjectLocationDataStore resource.
1152
+ *
1153
+ * @param {string} projectLocationDataStoreName
1154
+ * A fully-qualified path representing project_location_data_store resource.
1155
+ * @returns {string} A string representing the project.
1156
+ */
1157
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
1158
+ /**
1159
+ * Parse the location from ProjectLocationDataStore resource.
1160
+ *
1161
+ * @param {string} projectLocationDataStoreName
1162
+ * A fully-qualified path representing project_location_data_store resource.
1163
+ * @returns {string} A string representing the location.
1164
+ */
1165
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
1166
+ /**
1167
+ * Parse the data_store from ProjectLocationDataStore resource.
1168
+ *
1169
+ * @param {string} projectLocationDataStoreName
1170
+ * A fully-qualified path representing project_location_data_store resource.
1171
+ * @returns {string} A string representing the data_store.
1172
+ */
1173
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
1174
+ /**
1175
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
1176
+ *
1177
+ * @param {string} project
1178
+ * @param {string} location
1179
+ * @param {string} data_store
1180
+ * @param {string} branch
1181
+ * @param {string} document
1182
+ * @returns {string} Resource name string.
1183
+ */
1184
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
1185
+ /**
1186
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
1187
+ *
1188
+ * @param {string} projectLocationDataStoreBranchDocumentName
1189
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1190
+ * @returns {string} A string representing the project.
1191
+ */
1192
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1193
+ /**
1194
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
1195
+ *
1196
+ * @param {string} projectLocationDataStoreBranchDocumentName
1197
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1198
+ * @returns {string} A string representing the location.
1199
+ */
1200
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1201
+ /**
1202
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
1203
+ *
1204
+ * @param {string} projectLocationDataStoreBranchDocumentName
1205
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1206
+ * @returns {string} A string representing the data_store.
1207
+ */
1208
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1209
+ /**
1210
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
1211
+ *
1212
+ * @param {string} projectLocationDataStoreBranchDocumentName
1213
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1214
+ * @returns {string} A string representing the branch.
1215
+ */
1216
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1217
+ /**
1218
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
1219
+ *
1220
+ * @param {string} projectLocationDataStoreBranchDocumentName
1221
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1222
+ * @returns {string} A string representing the document.
1223
+ */
1224
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1225
+ /**
1226
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
1227
+ *
1228
+ * @param {string} project
1229
+ * @param {string} location
1230
+ * @param {string} data_store
1231
+ * @param {string} conversation
1232
+ * @returns {string} Resource name string.
1233
+ */
1234
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
1235
+ /**
1236
+ * Parse the project from ProjectLocationDataStoreConversation resource.
1237
+ *
1238
+ * @param {string} projectLocationDataStoreConversationName
1239
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1240
+ * @returns {string} A string representing the project.
1241
+ */
1242
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1243
+ /**
1244
+ * Parse the location from ProjectLocationDataStoreConversation resource.
1245
+ *
1246
+ * @param {string} projectLocationDataStoreConversationName
1247
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1248
+ * @returns {string} A string representing the location.
1249
+ */
1250
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1251
+ /**
1252
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
1253
+ *
1254
+ * @param {string} projectLocationDataStoreConversationName
1255
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1256
+ * @returns {string} A string representing the data_store.
1257
+ */
1258
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1259
+ /**
1260
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
1261
+ *
1262
+ * @param {string} projectLocationDataStoreConversationName
1263
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1264
+ * @returns {string} A string representing the conversation.
1265
+ */
1266
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1267
+ /**
1268
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
1269
+ *
1270
+ * @param {string} project
1271
+ * @param {string} location
1272
+ * @param {string} data_store
1273
+ * @param {string} schema
1274
+ * @returns {string} Resource name string.
1275
+ */
1276
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
1277
+ /**
1278
+ * Parse the project from ProjectLocationDataStoreSchema resource.
1279
+ *
1280
+ * @param {string} projectLocationDataStoreSchemaName
1281
+ * A fully-qualified path representing project_location_data_store_schema resource.
1282
+ * @returns {string} A string representing the project.
1283
+ */
1284
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1285
+ /**
1286
+ * Parse the location from ProjectLocationDataStoreSchema resource.
1287
+ *
1288
+ * @param {string} projectLocationDataStoreSchemaName
1289
+ * A fully-qualified path representing project_location_data_store_schema resource.
1290
+ * @returns {string} A string representing the location.
1291
+ */
1292
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1293
+ /**
1294
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
1295
+ *
1296
+ * @param {string} projectLocationDataStoreSchemaName
1297
+ * A fully-qualified path representing project_location_data_store_schema resource.
1298
+ * @returns {string} A string representing the data_store.
1299
+ */
1300
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1301
+ /**
1302
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
1303
+ *
1304
+ * @param {string} projectLocationDataStoreSchemaName
1305
+ * A fully-qualified path representing project_location_data_store_schema resource.
1306
+ * @returns {string} A string representing the schema.
1307
+ */
1308
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1309
+ /**
1310
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
1311
+ *
1312
+ * @param {string} project
1313
+ * @param {string} location
1314
+ * @param {string} data_store
1315
+ * @param {string} serving_config
1316
+ * @returns {string} Resource name string.
1317
+ */
1318
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
1319
+ /**
1320
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
1321
+ *
1322
+ * @param {string} projectLocationDataStoreServingConfigName
1323
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1324
+ * @returns {string} A string representing the project.
1325
+ */
1326
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1327
+ /**
1328
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
1329
+ *
1330
+ * @param {string} projectLocationDataStoreServingConfigName
1331
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1332
+ * @returns {string} A string representing the location.
1333
+ */
1334
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1335
+ /**
1336
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
1337
+ *
1338
+ * @param {string} projectLocationDataStoreServingConfigName
1339
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1340
+ * @returns {string} A string representing the data_store.
1341
+ */
1342
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1343
+ /**
1344
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
1345
+ *
1346
+ * @param {string} projectLocationDataStoreServingConfigName
1347
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1348
+ * @returns {string} A string representing the serving_config.
1349
+ */
1350
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1351
+ /**
1352
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1353
+ *
1354
+ * @param {string} project
1355
+ * @param {string} location
1356
+ * @param {string} data_store
1357
+ * @returns {string} Resource name string.
1358
+ */
1359
+ projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
1360
+ /**
1361
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1362
+ *
1363
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1364
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1365
+ * @returns {string} A string representing the project.
1366
+ */
1367
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1368
+ /**
1369
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1370
+ *
1371
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1372
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1373
+ * @returns {string} A string representing the location.
1374
+ */
1375
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1376
+ /**
1377
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1378
+ *
1379
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1380
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1381
+ * @returns {string} A string representing the data_store.
1382
+ */
1383
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1384
+ /**
1385
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1386
+ *
1387
+ * @param {string} project
1388
+ * @param {string} location
1389
+ * @param {string} data_store
1390
+ * @param {string} target_site
1391
+ * @returns {string} Resource name string.
1392
+ */
1393
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
1394
+ /**
1395
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1396
+ *
1397
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1398
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1399
+ * @returns {string} A string representing the project.
1400
+ */
1401
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1402
+ /**
1403
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1404
+ *
1405
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1406
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1407
+ * @returns {string} A string representing the location.
1408
+ */
1409
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1410
+ /**
1411
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1412
+ *
1413
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1414
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1415
+ * @returns {string} A string representing the data_store.
1416
+ */
1417
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1418
+ /**
1419
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1420
+ *
1421
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1422
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1423
+ * @returns {string} A string representing the target_site.
1424
+ */
1425
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1426
+ /**
1427
+ * Terminate the gRPC channel and close the client.
1428
+ *
1429
+ * The client will no longer be usable and all future behavior is undefined.
1430
+ * @returns {Promise} A promise that resolves when the client is closed.
1431
+ */
1432
+ close(): Promise<void>;
1433
+ }