@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,1102 @@
1
+ /// <reference types="node" />
2
+ import type * as gax from 'google-gax';
3
+ import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
4
+ import { Transform } from 'stream';
5
+ import * as protos from '../../protos/protos';
6
+ /**
7
+ * Service for modifying ServingConfig.
8
+ * @class
9
+ * @memberof v1beta
10
+ */
11
+ export declare class ServingConfigServiceClient {
12
+ private _terminated;
13
+ private _opts;
14
+ private _providedCustomServicePath;
15
+ private _gaxModule;
16
+ private _gaxGrpc;
17
+ private _protos;
18
+ private _defaults;
19
+ private _universeDomain;
20
+ private _servicePath;
21
+ auth: gax.GoogleAuth;
22
+ descriptors: Descriptors;
23
+ warn: (code: string, message: string, warnType?: string) => void;
24
+ innerApiCalls: {
25
+ [name: string]: Function;
26
+ };
27
+ locationsClient: LocationsClient;
28
+ pathTemplates: {
29
+ [name: string]: gax.PathTemplate;
30
+ };
31
+ servingConfigServiceStub?: Promise<{
32
+ [name: string]: Function;
33
+ }>;
34
+ /**
35
+ * Construct an instance of ServingConfigServiceClient.
36
+ *
37
+ * @param {object} [options] - The configuration object.
38
+ * The options accepted by the constructor are described in detail
39
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
40
+ * The common options are:
41
+ * @param {object} [options.credentials] - Credentials object.
42
+ * @param {string} [options.credentials.client_email]
43
+ * @param {string} [options.credentials.private_key]
44
+ * @param {string} [options.email] - Account email address. Required when
45
+ * using a .pem or .p12 keyFilename.
46
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
47
+ * .p12 key downloaded from the Google Developers Console. If you provide
48
+ * a path to a JSON file, the projectId option below is not necessary.
49
+ * NOTE: .pem and .p12 require you to specify options.email as well.
50
+ * @param {number} [options.port] - The port on which to connect to
51
+ * the remote host.
52
+ * @param {string} [options.projectId] - The project ID from the Google
53
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
54
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
55
+ * app is running in an environment which supports
56
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
57
+ * your project ID will be detected automatically.
58
+ * @param {string} [options.apiEndpoint] - The domain name of the
59
+ * API remote host.
60
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
61
+ * Follows the structure of {@link gapicConfig}.
62
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
63
+ * For more information, please check the
64
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
65
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
66
+ * need to avoid loading the default gRPC version and want to use the fallback
67
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
68
+ * ```
69
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
70
+ * const client = new ServingConfigServiceClient({fallback: true}, gax);
71
+ * ```
72
+ */
73
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
74
+ /**
75
+ * Initialize the client.
76
+ * Performs asynchronous operations (such as authentication) and prepares the client.
77
+ * This function will be called automatically when any class method is called for the
78
+ * first time, but if you need to initialize it before calling an actual method,
79
+ * feel free to call initialize() directly.
80
+ *
81
+ * You can await on this method if you want to make sure the client is initialized.
82
+ *
83
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
84
+ */
85
+ initialize(): Promise<{
86
+ [name: string]: Function;
87
+ }>;
88
+ /**
89
+ * The DNS address for this API service.
90
+ * @deprecated Use the apiEndpoint method of the client instance.
91
+ * @returns {string} The DNS address for this service.
92
+ */
93
+ static get servicePath(): string;
94
+ /**
95
+ * The DNS address for this API service - same as servicePath.
96
+ * @deprecated Use the apiEndpoint method of the client instance.
97
+ * @returns {string} The DNS address for this service.
98
+ */
99
+ static get apiEndpoint(): string;
100
+ /**
101
+ * The DNS address for this API service.
102
+ * @returns {string} The DNS address for this service.
103
+ */
104
+ get apiEndpoint(): string;
105
+ get universeDomain(): string;
106
+ /**
107
+ * The port for this API service.
108
+ * @returns {number} The default port for this service.
109
+ */
110
+ static get port(): number;
111
+ /**
112
+ * The scopes needed to make gRPC calls for every method defined
113
+ * in this service.
114
+ * @returns {string[]} List of default scopes.
115
+ */
116
+ static get scopes(): string[];
117
+ getProjectId(): Promise<string>;
118
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
119
+ /**
120
+ * Updates a ServingConfig.
121
+ *
122
+ * Returns a NOT_FOUND error if the ServingConfig does not exist.
123
+ *
124
+ * @param {Object} request
125
+ * The request object that will be sent.
126
+ * @param {google.cloud.discoveryengine.v1beta.ServingConfig} request.servingConfig
127
+ * Required. The ServingConfig to update.
128
+ * @param {google.protobuf.FieldMask} request.updateMask
129
+ * Indicates which fields in the provided
130
+ * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig|ServingConfig} to
131
+ * update. The following are NOT supported:
132
+ *
133
+ * * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.name|ServingConfig.name}
134
+ *
135
+ * If not set, all supported fields are updated.
136
+ * @param {object} [options]
137
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
138
+ * @returns {Promise} - The promise which resolves to an array.
139
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig|ServingConfig}.
140
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
141
+ * for more details and examples.
142
+ * @example <caption>include:samples/generated/v1beta/serving_config_service.update_serving_config.js</caption>
143
+ * region_tag:discoveryengine_v1beta_generated_ServingConfigService_UpdateServingConfig_async
144
+ */
145
+ updateServingConfig(request?: protos.google.cloud.discoveryengine.v1beta.IUpdateServingConfigRequest, options?: CallOptions): Promise<[
146
+ protos.google.cloud.discoveryengine.v1beta.IServingConfig,
147
+ (protos.google.cloud.discoveryengine.v1beta.IUpdateServingConfigRequest | undefined),
148
+ {} | undefined
149
+ ]>;
150
+ updateServingConfig(request: protos.google.cloud.discoveryengine.v1beta.IUpdateServingConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IServingConfig, protos.google.cloud.discoveryengine.v1beta.IUpdateServingConfigRequest | null | undefined, {} | null | undefined>): void;
151
+ updateServingConfig(request: protos.google.cloud.discoveryengine.v1beta.IUpdateServingConfigRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IServingConfig, protos.google.cloud.discoveryengine.v1beta.IUpdateServingConfigRequest | null | undefined, {} | null | undefined>): void;
152
+ /**
153
+ * Gets a ServingConfig.
154
+ *
155
+ * Returns a NotFound error if the ServingConfig does not exist.
156
+ *
157
+ * @param {Object} request
158
+ * The request object that will be sent.
159
+ * @param {string} request.name
160
+ * Required. The resource name of the ServingConfig to get. Format:
161
+ * `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`
162
+ * @param {object} [options]
163
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
164
+ * @returns {Promise} - The promise which resolves to an array.
165
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig|ServingConfig}.
166
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
167
+ * for more details and examples.
168
+ * @example <caption>include:samples/generated/v1beta/serving_config_service.get_serving_config.js</caption>
169
+ * region_tag:discoveryengine_v1beta_generated_ServingConfigService_GetServingConfig_async
170
+ */
171
+ getServingConfig(request?: protos.google.cloud.discoveryengine.v1beta.IGetServingConfigRequest, options?: CallOptions): Promise<[
172
+ protos.google.cloud.discoveryengine.v1beta.IServingConfig,
173
+ (protos.google.cloud.discoveryengine.v1beta.IGetServingConfigRequest | undefined),
174
+ {} | undefined
175
+ ]>;
176
+ getServingConfig(request: protos.google.cloud.discoveryengine.v1beta.IGetServingConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IServingConfig, protos.google.cloud.discoveryengine.v1beta.IGetServingConfigRequest | null | undefined, {} | null | undefined>): void;
177
+ getServingConfig(request: protos.google.cloud.discoveryengine.v1beta.IGetServingConfigRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IServingConfig, protos.google.cloud.discoveryengine.v1beta.IGetServingConfigRequest | null | undefined, {} | null | undefined>): void;
178
+ /**
179
+ * Lists all ServingConfigs linked to this dataStore.
180
+ *
181
+ * @param {Object} request
182
+ * The request object that will be sent.
183
+ * @param {string} request.parent
184
+ * Required. The dataStore resource name. Format:
185
+ * `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`
186
+ * @param {number} [request.pageSize]
187
+ * Optional. Maximum number of results to return. If unspecified, defaults
188
+ * to 100. If a value greater than 100 is provided, at most 100 results are
189
+ * returned.
190
+ * @param {string} [request.pageToken]
191
+ * Optional. A page token, received from a previous `ListServingConfigs` call.
192
+ * Provide this to retrieve the subsequent page.
193
+ * @param {object} [options]
194
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
195
+ * @returns {Promise} - The promise which resolves to an array.
196
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig|ServingConfig}.
197
+ * The client library will perform auto-pagination by default: it will call the API as many
198
+ * times as needed and will merge results from all the pages into this array.
199
+ * Note that it can affect your quota.
200
+ * We recommend using `listServingConfigsAsync()`
201
+ * method described below for async iteration which you can stop as needed.
202
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
203
+ * for more details and examples.
204
+ */
205
+ listServingConfigs(request?: protos.google.cloud.discoveryengine.v1beta.IListServingConfigsRequest, options?: CallOptions): Promise<[
206
+ protos.google.cloud.discoveryengine.v1beta.IServingConfig[],
207
+ protos.google.cloud.discoveryengine.v1beta.IListServingConfigsRequest | null,
208
+ protos.google.cloud.discoveryengine.v1beta.IListServingConfigsResponse
209
+ ]>;
210
+ listServingConfigs(request: protos.google.cloud.discoveryengine.v1beta.IListServingConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListServingConfigsRequest, protos.google.cloud.discoveryengine.v1beta.IListServingConfigsResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.IServingConfig>): void;
211
+ listServingConfigs(request: protos.google.cloud.discoveryengine.v1beta.IListServingConfigsRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1beta.IListServingConfigsRequest, protos.google.cloud.discoveryengine.v1beta.IListServingConfigsResponse | null | undefined, protos.google.cloud.discoveryengine.v1beta.IServingConfig>): void;
212
+ /**
213
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
214
+ * @param {Object} request
215
+ * The request object that will be sent.
216
+ * @param {string} request.parent
217
+ * Required. The dataStore resource name. Format:
218
+ * `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`
219
+ * @param {number} [request.pageSize]
220
+ * Optional. Maximum number of results to return. If unspecified, defaults
221
+ * to 100. If a value greater than 100 is provided, at most 100 results are
222
+ * returned.
223
+ * @param {string} [request.pageToken]
224
+ * Optional. A page token, received from a previous `ListServingConfigs` call.
225
+ * Provide this to retrieve the subsequent page.
226
+ * @param {object} [options]
227
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
228
+ * @returns {Stream}
229
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig|ServingConfig} on 'data' event.
230
+ * The client library will perform auto-pagination by default: it will call the API as many
231
+ * times as needed. Note that it can affect your quota.
232
+ * We recommend using `listServingConfigsAsync()`
233
+ * method described below for async iteration which you can stop as needed.
234
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
235
+ * for more details and examples.
236
+ */
237
+ listServingConfigsStream(request?: protos.google.cloud.discoveryengine.v1beta.IListServingConfigsRequest, options?: CallOptions): Transform;
238
+ /**
239
+ * Equivalent to `listServingConfigs`, but returns an iterable object.
240
+ *
241
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
242
+ * @param {Object} request
243
+ * The request object that will be sent.
244
+ * @param {string} request.parent
245
+ * Required. The dataStore resource name. Format:
246
+ * `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`
247
+ * @param {number} [request.pageSize]
248
+ * Optional. Maximum number of results to return. If unspecified, defaults
249
+ * to 100. If a value greater than 100 is provided, at most 100 results are
250
+ * returned.
251
+ * @param {string} [request.pageToken]
252
+ * Optional. A page token, received from a previous `ListServingConfigs` call.
253
+ * Provide this to retrieve the subsequent page.
254
+ * @param {object} [options]
255
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
256
+ * @returns {Object}
257
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
258
+ * When you iterate the returned iterable, each element will be an object representing
259
+ * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig|ServingConfig}. The API will be called under the hood as needed, once per the page,
260
+ * so you can stop the iteration when you don't need more results.
261
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
262
+ * for more details and examples.
263
+ * @example <caption>include:samples/generated/v1beta/serving_config_service.list_serving_configs.js</caption>
264
+ * region_tag:discoveryengine_v1beta_generated_ServingConfigService_ListServingConfigs_async
265
+ */
266
+ listServingConfigsAsync(request?: protos.google.cloud.discoveryengine.v1beta.IListServingConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.IServingConfig>;
267
+ /**
268
+ * Gets information about a location.
269
+ *
270
+ * @param {Object} request
271
+ * The request object that will be sent.
272
+ * @param {string} request.name
273
+ * Resource name for the location.
274
+ * @param {object} [options]
275
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
276
+ * @returns {Promise} - The promise which resolves to an array.
277
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
278
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
279
+ * for more details and examples.
280
+ * @example
281
+ * ```
282
+ * const [response] = await client.getLocation(request);
283
+ * ```
284
+ */
285
+ 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>;
286
+ /**
287
+ * Lists information about the supported locations for this service. Returns an iterable object.
288
+ *
289
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
290
+ * @param {Object} request
291
+ * The request object that will be sent.
292
+ * @param {string} request.name
293
+ * The resource that owns the locations collection, if applicable.
294
+ * @param {string} request.filter
295
+ * The standard list filter.
296
+ * @param {number} request.pageSize
297
+ * The standard list page size.
298
+ * @param {string} request.pageToken
299
+ * The standard list page token.
300
+ * @param {object} [options]
301
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
302
+ * @returns {Object}
303
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
304
+ * When you iterate the returned iterable, each element will be an object representing
305
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
306
+ * so you can stop the iteration when you don't need more results.
307
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
308
+ * for more details and examples.
309
+ * @example
310
+ * ```
311
+ * const iterable = client.listLocationsAsync(request);
312
+ * for await (const response of iterable) {
313
+ * // process response
314
+ * }
315
+ * ```
316
+ */
317
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
318
+ /**
319
+ * Return a fully-qualified engine resource name string.
320
+ *
321
+ * @param {string} project
322
+ * @param {string} location
323
+ * @param {string} collection
324
+ * @param {string} engine
325
+ * @returns {string} Resource name string.
326
+ */
327
+ enginePath(project: string, location: string, collection: string, engine: string): string;
328
+ /**
329
+ * Parse the project from Engine resource.
330
+ *
331
+ * @param {string} engineName
332
+ * A fully-qualified path representing Engine resource.
333
+ * @returns {string} A string representing the project.
334
+ */
335
+ matchProjectFromEngineName(engineName: string): string | number;
336
+ /**
337
+ * Parse the location from Engine resource.
338
+ *
339
+ * @param {string} engineName
340
+ * A fully-qualified path representing Engine resource.
341
+ * @returns {string} A string representing the location.
342
+ */
343
+ matchLocationFromEngineName(engineName: string): string | number;
344
+ /**
345
+ * Parse the collection from Engine resource.
346
+ *
347
+ * @param {string} engineName
348
+ * A fully-qualified path representing Engine resource.
349
+ * @returns {string} A string representing the collection.
350
+ */
351
+ matchCollectionFromEngineName(engineName: string): string | number;
352
+ /**
353
+ * Parse the engine from Engine resource.
354
+ *
355
+ * @param {string} engineName
356
+ * A fully-qualified path representing Engine resource.
357
+ * @returns {string} A string representing the engine.
358
+ */
359
+ matchEngineFromEngineName(engineName: string): string | number;
360
+ /**
361
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
362
+ *
363
+ * @param {string} project
364
+ * @param {string} location
365
+ * @param {string} collection
366
+ * @param {string} data_store
367
+ * @returns {string} Resource name string.
368
+ */
369
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
370
+ /**
371
+ * Parse the project from ProjectLocationCollectionDataStore resource.
372
+ *
373
+ * @param {string} projectLocationCollectionDataStoreName
374
+ * A fully-qualified path representing project_location_collection_data_store resource.
375
+ * @returns {string} A string representing the project.
376
+ */
377
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
378
+ /**
379
+ * Parse the location from ProjectLocationCollectionDataStore resource.
380
+ *
381
+ * @param {string} projectLocationCollectionDataStoreName
382
+ * A fully-qualified path representing project_location_collection_data_store resource.
383
+ * @returns {string} A string representing the location.
384
+ */
385
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
386
+ /**
387
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
388
+ *
389
+ * @param {string} projectLocationCollectionDataStoreName
390
+ * A fully-qualified path representing project_location_collection_data_store resource.
391
+ * @returns {string} A string representing the collection.
392
+ */
393
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
394
+ /**
395
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
396
+ *
397
+ * @param {string} projectLocationCollectionDataStoreName
398
+ * A fully-qualified path representing project_location_collection_data_store resource.
399
+ * @returns {string} A string representing the data_store.
400
+ */
401
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
402
+ /**
403
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
404
+ *
405
+ * @param {string} project
406
+ * @param {string} location
407
+ * @param {string} collection
408
+ * @param {string} data_store
409
+ * @param {string} branch
410
+ * @param {string} document
411
+ * @returns {string} Resource name string.
412
+ */
413
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
414
+ /**
415
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
416
+ *
417
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
418
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
419
+ * @returns {string} A string representing the project.
420
+ */
421
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
422
+ /**
423
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
424
+ *
425
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
426
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
427
+ * @returns {string} A string representing the location.
428
+ */
429
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
430
+ /**
431
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
432
+ *
433
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
434
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
435
+ * @returns {string} A string representing the collection.
436
+ */
437
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
438
+ /**
439
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
440
+ *
441
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
442
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
443
+ * @returns {string} A string representing the data_store.
444
+ */
445
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
446
+ /**
447
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
448
+ *
449
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
450
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
451
+ * @returns {string} A string representing the branch.
452
+ */
453
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
454
+ /**
455
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
456
+ *
457
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
458
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
459
+ * @returns {string} A string representing the document.
460
+ */
461
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
462
+ /**
463
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
464
+ *
465
+ * @param {string} project
466
+ * @param {string} location
467
+ * @param {string} collection
468
+ * @param {string} data_store
469
+ * @param {string} conversation
470
+ * @returns {string} Resource name string.
471
+ */
472
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
473
+ /**
474
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
475
+ *
476
+ * @param {string} projectLocationCollectionDataStoreConversationName
477
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
478
+ * @returns {string} A string representing the project.
479
+ */
480
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
481
+ /**
482
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
483
+ *
484
+ * @param {string} projectLocationCollectionDataStoreConversationName
485
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
486
+ * @returns {string} A string representing the location.
487
+ */
488
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
489
+ /**
490
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
491
+ *
492
+ * @param {string} projectLocationCollectionDataStoreConversationName
493
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
494
+ * @returns {string} A string representing the collection.
495
+ */
496
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
497
+ /**
498
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
499
+ *
500
+ * @param {string} projectLocationCollectionDataStoreConversationName
501
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
502
+ * @returns {string} A string representing the data_store.
503
+ */
504
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
505
+ /**
506
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
507
+ *
508
+ * @param {string} projectLocationCollectionDataStoreConversationName
509
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
510
+ * @returns {string} A string representing the conversation.
511
+ */
512
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
513
+ /**
514
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
515
+ *
516
+ * @param {string} project
517
+ * @param {string} location
518
+ * @param {string} collection
519
+ * @param {string} data_store
520
+ * @param {string} schema
521
+ * @returns {string} Resource name string.
522
+ */
523
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
524
+ /**
525
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
526
+ *
527
+ * @param {string} projectLocationCollectionDataStoreSchemaName
528
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
529
+ * @returns {string} A string representing the project.
530
+ */
531
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
532
+ /**
533
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
534
+ *
535
+ * @param {string} projectLocationCollectionDataStoreSchemaName
536
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
537
+ * @returns {string} A string representing the location.
538
+ */
539
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
540
+ /**
541
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
542
+ *
543
+ * @param {string} projectLocationCollectionDataStoreSchemaName
544
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
545
+ * @returns {string} A string representing the collection.
546
+ */
547
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
548
+ /**
549
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
550
+ *
551
+ * @param {string} projectLocationCollectionDataStoreSchemaName
552
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
553
+ * @returns {string} A string representing the data_store.
554
+ */
555
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
556
+ /**
557
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
558
+ *
559
+ * @param {string} projectLocationCollectionDataStoreSchemaName
560
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
561
+ * @returns {string} A string representing the schema.
562
+ */
563
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
564
+ /**
565
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
566
+ *
567
+ * @param {string} project
568
+ * @param {string} location
569
+ * @param {string} collection
570
+ * @param {string} data_store
571
+ * @param {string} serving_config
572
+ * @returns {string} Resource name string.
573
+ */
574
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
575
+ /**
576
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
577
+ *
578
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
579
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
580
+ * @returns {string} A string representing the project.
581
+ */
582
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
583
+ /**
584
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
585
+ *
586
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
587
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
588
+ * @returns {string} A string representing the location.
589
+ */
590
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
591
+ /**
592
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
593
+ *
594
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
595
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
596
+ * @returns {string} A string representing the collection.
597
+ */
598
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
599
+ /**
600
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
601
+ *
602
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
603
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
604
+ * @returns {string} A string representing the data_store.
605
+ */
606
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
607
+ /**
608
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
609
+ *
610
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
611
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
612
+ * @returns {string} A string representing the serving_config.
613
+ */
614
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
615
+ /**
616
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
617
+ *
618
+ * @param {string} project
619
+ * @param {string} location
620
+ * @param {string} collection
621
+ * @param {string} data_store
622
+ * @returns {string} Resource name string.
623
+ */
624
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
625
+ /**
626
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
627
+ *
628
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
629
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
630
+ * @returns {string} A string representing the project.
631
+ */
632
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
633
+ /**
634
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
635
+ *
636
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
637
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
638
+ * @returns {string} A string representing the location.
639
+ */
640
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
641
+ /**
642
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
643
+ *
644
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
645
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
646
+ * @returns {string} A string representing the collection.
647
+ */
648
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
649
+ /**
650
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
651
+ *
652
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
653
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
654
+ * @returns {string} A string representing the data_store.
655
+ */
656
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
657
+ /**
658
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
659
+ *
660
+ * @param {string} project
661
+ * @param {string} location
662
+ * @param {string} collection
663
+ * @param {string} data_store
664
+ * @param {string} target_site
665
+ * @returns {string} Resource name string.
666
+ */
667
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
668
+ /**
669
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
670
+ *
671
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
672
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
673
+ * @returns {string} A string representing the project.
674
+ */
675
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
676
+ /**
677
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
678
+ *
679
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
680
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
681
+ * @returns {string} A string representing the location.
682
+ */
683
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
684
+ /**
685
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
686
+ *
687
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
688
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
689
+ * @returns {string} A string representing the collection.
690
+ */
691
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
692
+ /**
693
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
694
+ *
695
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
696
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
697
+ * @returns {string} A string representing the data_store.
698
+ */
699
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
700
+ /**
701
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
702
+ *
703
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
704
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
705
+ * @returns {string} A string representing the target_site.
706
+ */
707
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
708
+ /**
709
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
710
+ *
711
+ * @param {string} project
712
+ * @param {string} location
713
+ * @param {string} collection
714
+ * @param {string} engine
715
+ * @param {string} conversation
716
+ * @returns {string} Resource name string.
717
+ */
718
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
719
+ /**
720
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
721
+ *
722
+ * @param {string} projectLocationCollectionEngineConversationName
723
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
724
+ * @returns {string} A string representing the project.
725
+ */
726
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
727
+ /**
728
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
729
+ *
730
+ * @param {string} projectLocationCollectionEngineConversationName
731
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
732
+ * @returns {string} A string representing the location.
733
+ */
734
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
735
+ /**
736
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
737
+ *
738
+ * @param {string} projectLocationCollectionEngineConversationName
739
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
740
+ * @returns {string} A string representing the collection.
741
+ */
742
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
743
+ /**
744
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
745
+ *
746
+ * @param {string} projectLocationCollectionEngineConversationName
747
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
748
+ * @returns {string} A string representing the engine.
749
+ */
750
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
751
+ /**
752
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
753
+ *
754
+ * @param {string} projectLocationCollectionEngineConversationName
755
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
756
+ * @returns {string} A string representing the conversation.
757
+ */
758
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
759
+ /**
760
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
761
+ *
762
+ * @param {string} project
763
+ * @param {string} location
764
+ * @param {string} collection
765
+ * @param {string} engine
766
+ * @param {string} serving_config
767
+ * @returns {string} Resource name string.
768
+ */
769
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
770
+ /**
771
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
772
+ *
773
+ * @param {string} projectLocationCollectionEngineServingConfigName
774
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
775
+ * @returns {string} A string representing the project.
776
+ */
777
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
778
+ /**
779
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
780
+ *
781
+ * @param {string} projectLocationCollectionEngineServingConfigName
782
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
783
+ * @returns {string} A string representing the location.
784
+ */
785
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
786
+ /**
787
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
788
+ *
789
+ * @param {string} projectLocationCollectionEngineServingConfigName
790
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
791
+ * @returns {string} A string representing the collection.
792
+ */
793
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
794
+ /**
795
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
796
+ *
797
+ * @param {string} projectLocationCollectionEngineServingConfigName
798
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
799
+ * @returns {string} A string representing the engine.
800
+ */
801
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
802
+ /**
803
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
804
+ *
805
+ * @param {string} projectLocationCollectionEngineServingConfigName
806
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
807
+ * @returns {string} A string representing the serving_config.
808
+ */
809
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
810
+ /**
811
+ * Return a fully-qualified projectLocationDataStore resource name string.
812
+ *
813
+ * @param {string} project
814
+ * @param {string} location
815
+ * @param {string} data_store
816
+ * @returns {string} Resource name string.
817
+ */
818
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
819
+ /**
820
+ * Parse the project from ProjectLocationDataStore resource.
821
+ *
822
+ * @param {string} projectLocationDataStoreName
823
+ * A fully-qualified path representing project_location_data_store resource.
824
+ * @returns {string} A string representing the project.
825
+ */
826
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
827
+ /**
828
+ * Parse the location from ProjectLocationDataStore resource.
829
+ *
830
+ * @param {string} projectLocationDataStoreName
831
+ * A fully-qualified path representing project_location_data_store resource.
832
+ * @returns {string} A string representing the location.
833
+ */
834
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
835
+ /**
836
+ * Parse the data_store from ProjectLocationDataStore resource.
837
+ *
838
+ * @param {string} projectLocationDataStoreName
839
+ * A fully-qualified path representing project_location_data_store resource.
840
+ * @returns {string} A string representing the data_store.
841
+ */
842
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
843
+ /**
844
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
845
+ *
846
+ * @param {string} project
847
+ * @param {string} location
848
+ * @param {string} data_store
849
+ * @param {string} branch
850
+ * @param {string} document
851
+ * @returns {string} Resource name string.
852
+ */
853
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
854
+ /**
855
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
856
+ *
857
+ * @param {string} projectLocationDataStoreBranchDocumentName
858
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
859
+ * @returns {string} A string representing the project.
860
+ */
861
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
862
+ /**
863
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
864
+ *
865
+ * @param {string} projectLocationDataStoreBranchDocumentName
866
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
867
+ * @returns {string} A string representing the location.
868
+ */
869
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
870
+ /**
871
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
872
+ *
873
+ * @param {string} projectLocationDataStoreBranchDocumentName
874
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
875
+ * @returns {string} A string representing the data_store.
876
+ */
877
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
878
+ /**
879
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
880
+ *
881
+ * @param {string} projectLocationDataStoreBranchDocumentName
882
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
883
+ * @returns {string} A string representing the branch.
884
+ */
885
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
886
+ /**
887
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
888
+ *
889
+ * @param {string} projectLocationDataStoreBranchDocumentName
890
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
891
+ * @returns {string} A string representing the document.
892
+ */
893
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
894
+ /**
895
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
896
+ *
897
+ * @param {string} project
898
+ * @param {string} location
899
+ * @param {string} data_store
900
+ * @param {string} conversation
901
+ * @returns {string} Resource name string.
902
+ */
903
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
904
+ /**
905
+ * Parse the project from ProjectLocationDataStoreConversation resource.
906
+ *
907
+ * @param {string} projectLocationDataStoreConversationName
908
+ * A fully-qualified path representing project_location_data_store_conversation resource.
909
+ * @returns {string} A string representing the project.
910
+ */
911
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
912
+ /**
913
+ * Parse the location from ProjectLocationDataStoreConversation resource.
914
+ *
915
+ * @param {string} projectLocationDataStoreConversationName
916
+ * A fully-qualified path representing project_location_data_store_conversation resource.
917
+ * @returns {string} A string representing the location.
918
+ */
919
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
920
+ /**
921
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
922
+ *
923
+ * @param {string} projectLocationDataStoreConversationName
924
+ * A fully-qualified path representing project_location_data_store_conversation resource.
925
+ * @returns {string} A string representing the data_store.
926
+ */
927
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
928
+ /**
929
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
930
+ *
931
+ * @param {string} projectLocationDataStoreConversationName
932
+ * A fully-qualified path representing project_location_data_store_conversation resource.
933
+ * @returns {string} A string representing the conversation.
934
+ */
935
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
936
+ /**
937
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
938
+ *
939
+ * @param {string} project
940
+ * @param {string} location
941
+ * @param {string} data_store
942
+ * @param {string} schema
943
+ * @returns {string} Resource name string.
944
+ */
945
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
946
+ /**
947
+ * Parse the project from ProjectLocationDataStoreSchema resource.
948
+ *
949
+ * @param {string} projectLocationDataStoreSchemaName
950
+ * A fully-qualified path representing project_location_data_store_schema resource.
951
+ * @returns {string} A string representing the project.
952
+ */
953
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
954
+ /**
955
+ * Parse the location from ProjectLocationDataStoreSchema resource.
956
+ *
957
+ * @param {string} projectLocationDataStoreSchemaName
958
+ * A fully-qualified path representing project_location_data_store_schema resource.
959
+ * @returns {string} A string representing the location.
960
+ */
961
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
962
+ /**
963
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
964
+ *
965
+ * @param {string} projectLocationDataStoreSchemaName
966
+ * A fully-qualified path representing project_location_data_store_schema resource.
967
+ * @returns {string} A string representing the data_store.
968
+ */
969
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
970
+ /**
971
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
972
+ *
973
+ * @param {string} projectLocationDataStoreSchemaName
974
+ * A fully-qualified path representing project_location_data_store_schema resource.
975
+ * @returns {string} A string representing the schema.
976
+ */
977
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
978
+ /**
979
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
980
+ *
981
+ * @param {string} project
982
+ * @param {string} location
983
+ * @param {string} data_store
984
+ * @param {string} serving_config
985
+ * @returns {string} Resource name string.
986
+ */
987
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
988
+ /**
989
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
990
+ *
991
+ * @param {string} projectLocationDataStoreServingConfigName
992
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
993
+ * @returns {string} A string representing the project.
994
+ */
995
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
996
+ /**
997
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
998
+ *
999
+ * @param {string} projectLocationDataStoreServingConfigName
1000
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1001
+ * @returns {string} A string representing the location.
1002
+ */
1003
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1004
+ /**
1005
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
1006
+ *
1007
+ * @param {string} projectLocationDataStoreServingConfigName
1008
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1009
+ * @returns {string} A string representing the data_store.
1010
+ */
1011
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1012
+ /**
1013
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
1014
+ *
1015
+ * @param {string} projectLocationDataStoreServingConfigName
1016
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1017
+ * @returns {string} A string representing the serving_config.
1018
+ */
1019
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1020
+ /**
1021
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1022
+ *
1023
+ * @param {string} project
1024
+ * @param {string} location
1025
+ * @param {string} data_store
1026
+ * @returns {string} Resource name string.
1027
+ */
1028
+ projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
1029
+ /**
1030
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1031
+ *
1032
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1033
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1034
+ * @returns {string} A string representing the project.
1035
+ */
1036
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1037
+ /**
1038
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1039
+ *
1040
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1041
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1042
+ * @returns {string} A string representing the location.
1043
+ */
1044
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1045
+ /**
1046
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1047
+ *
1048
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1049
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1050
+ * @returns {string} A string representing the data_store.
1051
+ */
1052
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1053
+ /**
1054
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1055
+ *
1056
+ * @param {string} project
1057
+ * @param {string} location
1058
+ * @param {string} data_store
1059
+ * @param {string} target_site
1060
+ * @returns {string} Resource name string.
1061
+ */
1062
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
1063
+ /**
1064
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1065
+ *
1066
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1067
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1068
+ * @returns {string} A string representing the project.
1069
+ */
1070
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1071
+ /**
1072
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1073
+ *
1074
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1075
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1076
+ * @returns {string} A string representing the location.
1077
+ */
1078
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1079
+ /**
1080
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1081
+ *
1082
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1083
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1084
+ * @returns {string} A string representing the data_store.
1085
+ */
1086
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1087
+ /**
1088
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1089
+ *
1090
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1091
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1092
+ * @returns {string} A string representing the target_site.
1093
+ */
1094
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1095
+ /**
1096
+ * Terminate the gRPC channel and close the client.
1097
+ *
1098
+ * The client will no longer be usable and all future behavior is undefined.
1099
+ * @returns {Promise} A promise that resolves when the client is closed.
1100
+ */
1101
+ close(): Promise<void>;
1102
+ }