@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,1564 @@
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 site search related resources.
8
+ * @class
9
+ * @memberof v1
10
+ */
11
+ export declare class SiteSearchEngineServiceClient {
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
+ operationsClient: gax.OperationsClient;
32
+ siteSearchEngineServiceStub?: Promise<{
33
+ [name: string]: Function;
34
+ }>;
35
+ /**
36
+ * Construct an instance of SiteSearchEngineServiceClient.
37
+ *
38
+ * @param {object} [options] - The configuration object.
39
+ * The options accepted by the constructor are described in detail
40
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
41
+ * The common options are:
42
+ * @param {object} [options.credentials] - Credentials object.
43
+ * @param {string} [options.credentials.client_email]
44
+ * @param {string} [options.credentials.private_key]
45
+ * @param {string} [options.email] - Account email address. Required when
46
+ * using a .pem or .p12 keyFilename.
47
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
48
+ * .p12 key downloaded from the Google Developers Console. If you provide
49
+ * a path to a JSON file, the projectId option below is not necessary.
50
+ * NOTE: .pem and .p12 require you to specify options.email as well.
51
+ * @param {number} [options.port] - The port on which to connect to
52
+ * the remote host.
53
+ * @param {string} [options.projectId] - The project ID from the Google
54
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
55
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
56
+ * app is running in an environment which supports
57
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
58
+ * your project ID will be detected automatically.
59
+ * @param {string} [options.apiEndpoint] - The domain name of the
60
+ * API remote host.
61
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
62
+ * Follows the structure of {@link gapicConfig}.
63
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
64
+ * For more information, please check the
65
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
66
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
67
+ * need to avoid loading the default gRPC version and want to use the fallback
68
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
69
+ * ```
70
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
71
+ * const client = new SiteSearchEngineServiceClient({fallback: true}, gax);
72
+ * ```
73
+ */
74
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
75
+ /**
76
+ * Initialize the client.
77
+ * Performs asynchronous operations (such as authentication) and prepares the client.
78
+ * This function will be called automatically when any class method is called for the
79
+ * first time, but if you need to initialize it before calling an actual method,
80
+ * feel free to call initialize() directly.
81
+ *
82
+ * You can await on this method if you want to make sure the client is initialized.
83
+ *
84
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
85
+ */
86
+ initialize(): Promise<{
87
+ [name: string]: Function;
88
+ }>;
89
+ /**
90
+ * The DNS address for this API service.
91
+ * @deprecated Use the apiEndpoint method of the client instance.
92
+ * @returns {string} The DNS address for this service.
93
+ */
94
+ static get servicePath(): string;
95
+ /**
96
+ * The DNS address for this API service - same as servicePath.
97
+ * @deprecated Use the apiEndpoint method of the client instance.
98
+ * @returns {string} The DNS address for this service.
99
+ */
100
+ static get apiEndpoint(): string;
101
+ /**
102
+ * The DNS address for this API service.
103
+ * @returns {string} The DNS address for this service.
104
+ */
105
+ get apiEndpoint(): string;
106
+ get universeDomain(): string;
107
+ /**
108
+ * The port for this API service.
109
+ * @returns {number} The default port for this service.
110
+ */
111
+ static get port(): number;
112
+ /**
113
+ * The scopes needed to make gRPC calls for every method defined
114
+ * in this service.
115
+ * @returns {string[]} List of default scopes.
116
+ */
117
+ static get scopes(): string[];
118
+ getProjectId(): Promise<string>;
119
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
120
+ /**
121
+ * Gets the
122
+ * {@link protos.google.cloud.discoveryengine.v1.SiteSearchEngine|SiteSearchEngine}.
123
+ *
124
+ * @param {Object} request
125
+ * The request object that will be sent.
126
+ * @param {string} request.name
127
+ * Required. Resource name of
128
+ * {@link protos.google.cloud.discoveryengine.v1.SiteSearchEngine|SiteSearchEngine}, such
129
+ * as
130
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
131
+ *
132
+ * If the caller does not have permission to access the [SiteSearchEngine],
133
+ * regardless of whether or not it exists, a PERMISSION_DENIED error is
134
+ * returned.
135
+ * @param {object} [options]
136
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
137
+ * @returns {Promise} - The promise which resolves to an array.
138
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.SiteSearchEngine|SiteSearchEngine}.
139
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
140
+ * for more details and examples.
141
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.get_site_search_engine.js</caption>
142
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_GetSiteSearchEngine_async
143
+ */
144
+ getSiteSearchEngine(request?: protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest, options?: CallOptions): Promise<[
145
+ protos.google.cloud.discoveryengine.v1.ISiteSearchEngine,
146
+ (protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest | undefined),
147
+ {} | undefined
148
+ ]>;
149
+ getSiteSearchEngine(request: protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.ISiteSearchEngine, protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest | null | undefined, {} | null | undefined>): void;
150
+ getSiteSearchEngine(request: protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.ISiteSearchEngine, protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest | null | undefined, {} | null | undefined>): void;
151
+ /**
152
+ * Gets a {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
153
+ *
154
+ * @param {Object} request
155
+ * The request object that will be sent.
156
+ * @param {string} request.name
157
+ * Required. Full resource name of
158
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}, such as
159
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
160
+ *
161
+ * If the caller does not have permission to access the
162
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}, regardless of
163
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
164
+ *
165
+ * If the requested {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}
166
+ * does not exist, a NOT_FOUND error is returned.
167
+ * @param {object} [options]
168
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
169
+ * @returns {Promise} - The promise which resolves to an array.
170
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
171
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
172
+ * for more details and examples.
173
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.get_target_site.js</caption>
174
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_GetTargetSite_async
175
+ */
176
+ getTargetSite(request?: protos.google.cloud.discoveryengine.v1.IGetTargetSiteRequest, options?: CallOptions): Promise<[
177
+ protos.google.cloud.discoveryengine.v1.ITargetSite,
178
+ protos.google.cloud.discoveryengine.v1.IGetTargetSiteRequest | undefined,
179
+ {} | undefined
180
+ ]>;
181
+ getTargetSite(request: protos.google.cloud.discoveryengine.v1.IGetTargetSiteRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.ITargetSite, protos.google.cloud.discoveryengine.v1.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;
182
+ getTargetSite(request: protos.google.cloud.discoveryengine.v1.IGetTargetSiteRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.ITargetSite, protos.google.cloud.discoveryengine.v1.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;
183
+ /**
184
+ * Creates a {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
185
+ *
186
+ * @param {Object} request
187
+ * The request object that will be sent.
188
+ * @param {string} request.parent
189
+ * Required. Parent resource name of
190
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}, such as
191
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
192
+ * @param {google.cloud.discoveryengine.v1.TargetSite} request.targetSite
193
+ * Required. The {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite} to
194
+ * create.
195
+ * @param {object} [options]
196
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
197
+ * @returns {Promise} - The promise which resolves to an array.
198
+ * The first element of the array is an object representing
199
+ * a long running operation. Its `promise()` method returns a promise
200
+ * you can `await` for.
201
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
202
+ * for more details and examples.
203
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.create_target_site.js</caption>
204
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_CreateTargetSite_async
205
+ */
206
+ createTargetSite(request?: protos.google.cloud.discoveryengine.v1.ICreateTargetSiteRequest, options?: CallOptions): Promise<[
207
+ LROperation<protos.google.cloud.discoveryengine.v1.ITargetSite, protos.google.cloud.discoveryengine.v1.ICreateTargetSiteMetadata>,
208
+ protos.google.longrunning.IOperation | undefined,
209
+ {} | undefined
210
+ ]>;
211
+ createTargetSite(request: protos.google.cloud.discoveryengine.v1.ICreateTargetSiteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.ITargetSite, protos.google.cloud.discoveryengine.v1.ICreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
212
+ createTargetSite(request: protos.google.cloud.discoveryengine.v1.ICreateTargetSiteRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.ITargetSite, protos.google.cloud.discoveryengine.v1.ICreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
213
+ /**
214
+ * Check the status of the long running operation returned by `createTargetSite()`.
215
+ * @param {String} name
216
+ * The operation name that will be passed.
217
+ * @returns {Promise} - The promise which resolves to an object.
218
+ * The decoded operation object has result and metadata field to get information from.
219
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
220
+ * for more details and examples.
221
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.create_target_site.js</caption>
222
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_CreateTargetSite_async
223
+ */
224
+ checkCreateTargetSiteProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.TargetSite, protos.google.cloud.discoveryengine.v1.CreateTargetSiteMetadata>>;
225
+ /**
226
+ * Creates {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite} in a
227
+ * batch.
228
+ *
229
+ * @param {Object} request
230
+ * The request object that will be sent.
231
+ * @param {string} request.parent
232
+ * Required. The parent resource shared by all TargetSites being created.
233
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
234
+ * The parent field in the CreateBookRequest messages must either be empty or
235
+ * match this field.
236
+ * @param {number[]} request.requests
237
+ * Required. The request message specifying the resources to create.
238
+ * A maximum of 20 TargetSites can be created in a batch.
239
+ * @param {object} [options]
240
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
241
+ * @returns {Promise} - The promise which resolves to an array.
242
+ * The first element of the array is an object representing
243
+ * a long running operation. Its `promise()` method returns a promise
244
+ * you can `await` for.
245
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
246
+ * for more details and examples.
247
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.batch_create_target_sites.js</caption>
248
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_BatchCreateTargetSites_async
249
+ */
250
+ batchCreateTargetSites(request?: protos.google.cloud.discoveryengine.v1.IBatchCreateTargetSitesRequest, options?: CallOptions): Promise<[
251
+ LROperation<protos.google.cloud.discoveryengine.v1.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1.IBatchCreateTargetSiteMetadata>,
252
+ protos.google.longrunning.IOperation | undefined,
253
+ {} | undefined
254
+ ]>;
255
+ batchCreateTargetSites(request: protos.google.cloud.discoveryengine.v1.IBatchCreateTargetSitesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1.IBatchCreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
256
+ batchCreateTargetSites(request: protos.google.cloud.discoveryengine.v1.IBatchCreateTargetSitesRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1.IBatchCreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
257
+ /**
258
+ * Check the status of the long running operation returned by `batchCreateTargetSites()`.
259
+ * @param {String} name
260
+ * The operation name that will be passed.
261
+ * @returns {Promise} - The promise which resolves to an object.
262
+ * The decoded operation object has result and metadata field to get information from.
263
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
264
+ * for more details and examples.
265
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.batch_create_target_sites.js</caption>
266
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_BatchCreateTargetSites_async
267
+ */
268
+ checkBatchCreateTargetSitesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.BatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1.BatchCreateTargetSiteMetadata>>;
269
+ /**
270
+ * Updates a {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
271
+ *
272
+ * @param {Object} request
273
+ * The request object that will be sent.
274
+ * @param {google.cloud.discoveryengine.v1.TargetSite} request.targetSite
275
+ * Required. The target site to update.
276
+ * If the caller does not have permission to update the
277
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}, regardless of
278
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
279
+ *
280
+ * If the {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite} to update
281
+ * does not exist, a NOT_FOUND error is returned.
282
+ * @param {object} [options]
283
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
284
+ * @returns {Promise} - The promise which resolves to an array.
285
+ * The first element of the array is an object representing
286
+ * a long running operation. Its `promise()` method returns a promise
287
+ * you can `await` for.
288
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
289
+ * for more details and examples.
290
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.update_target_site.js</caption>
291
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_UpdateTargetSite_async
292
+ */
293
+ updateTargetSite(request?: protos.google.cloud.discoveryengine.v1.IUpdateTargetSiteRequest, options?: CallOptions): Promise<[
294
+ LROperation<protos.google.cloud.discoveryengine.v1.ITargetSite, protos.google.cloud.discoveryengine.v1.IUpdateTargetSiteMetadata>,
295
+ protos.google.longrunning.IOperation | undefined,
296
+ {} | undefined
297
+ ]>;
298
+ updateTargetSite(request: protos.google.cloud.discoveryengine.v1.IUpdateTargetSiteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.ITargetSite, protos.google.cloud.discoveryengine.v1.IUpdateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
299
+ updateTargetSite(request: protos.google.cloud.discoveryengine.v1.IUpdateTargetSiteRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.ITargetSite, protos.google.cloud.discoveryengine.v1.IUpdateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
300
+ /**
301
+ * Check the status of the long running operation returned by `updateTargetSite()`.
302
+ * @param {String} name
303
+ * The operation name that will be passed.
304
+ * @returns {Promise} - The promise which resolves to an object.
305
+ * The decoded operation object has result and metadata field to get information from.
306
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
307
+ * for more details and examples.
308
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.update_target_site.js</caption>
309
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_UpdateTargetSite_async
310
+ */
311
+ checkUpdateTargetSiteProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.TargetSite, protos.google.cloud.discoveryengine.v1.UpdateTargetSiteMetadata>>;
312
+ /**
313
+ * Deletes a {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
314
+ *
315
+ * @param {Object} request
316
+ * The request object that will be sent.
317
+ * @param {string} request.name
318
+ * Required. Full resource name of
319
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}, such as
320
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
321
+ *
322
+ * If the caller does not have permission to access the
323
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}, regardless of
324
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
325
+ *
326
+ * If the requested {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}
327
+ * does not exist, a NOT_FOUND error is returned.
328
+ * @param {object} [options]
329
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
330
+ * @returns {Promise} - The promise which resolves to an array.
331
+ * The first element of the array is an object representing
332
+ * a long running operation. Its `promise()` method returns a promise
333
+ * you can `await` for.
334
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
335
+ * for more details and examples.
336
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.delete_target_site.js</caption>
337
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_DeleteTargetSite_async
338
+ */
339
+ deleteTargetSite(request?: protos.google.cloud.discoveryengine.v1.IDeleteTargetSiteRequest, options?: CallOptions): Promise<[
340
+ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteTargetSiteMetadata>,
341
+ protos.google.longrunning.IOperation | undefined,
342
+ {} | undefined
343
+ ]>;
344
+ deleteTargetSite(request: protos.google.cloud.discoveryengine.v1.IDeleteTargetSiteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
345
+ deleteTargetSite(request: protos.google.cloud.discoveryengine.v1.IDeleteTargetSiteRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
346
+ /**
347
+ * Check the status of the long running operation returned by `deleteTargetSite()`.
348
+ * @param {String} name
349
+ * The operation name that will be passed.
350
+ * @returns {Promise} - The promise which resolves to an object.
351
+ * The decoded operation object has result and metadata field to get information from.
352
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
353
+ * for more details and examples.
354
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.delete_target_site.js</caption>
355
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_DeleteTargetSite_async
356
+ */
357
+ checkDeleteTargetSiteProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1.DeleteTargetSiteMetadata>>;
358
+ /**
359
+ * Upgrade from basic site search to advanced site search.
360
+ *
361
+ * @param {Object} request
362
+ * The request object that will be sent.
363
+ * @param {string} request.siteSearchEngine
364
+ * Required. Full resource name of the
365
+ * {@link protos.google.cloud.discoveryengine.v1.SiteSearchEngine|SiteSearchEngine}, such
366
+ * as
367
+ * `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
368
+ * @param {object} [options]
369
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
370
+ * @returns {Promise} - The promise which resolves to an array.
371
+ * The first element of the array is an object representing
372
+ * a long running operation. Its `promise()` method returns a promise
373
+ * you can `await` for.
374
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
375
+ * for more details and examples.
376
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.enable_advanced_site_search.js</caption>
377
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_async
378
+ */
379
+ enableAdvancedSiteSearch(request?: protos.google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchRequest, options?: CallOptions): Promise<[
380
+ LROperation<protos.google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchMetadata>,
381
+ protos.google.longrunning.IOperation | undefined,
382
+ {} | undefined
383
+ ]>;
384
+ enableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
385
+ enableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
386
+ /**
387
+ * Check the status of the long running operation returned by `enableAdvancedSiteSearch()`.
388
+ * @param {String} name
389
+ * The operation name that will be passed.
390
+ * @returns {Promise} - The promise which resolves to an object.
391
+ * The decoded operation object has result and metadata field to get information from.
392
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
393
+ * for more details and examples.
394
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.enable_advanced_site_search.js</caption>
395
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_async
396
+ */
397
+ checkEnableAdvancedSiteSearchProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.EnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1.EnableAdvancedSiteSearchMetadata>>;
398
+ /**
399
+ * Downgrade from advanced site search to basic site search.
400
+ *
401
+ * @param {Object} request
402
+ * The request object that will be sent.
403
+ * @param {string} request.siteSearchEngine
404
+ * Required. Full resource name of the
405
+ * {@link protos.google.cloud.discoveryengine.v1.SiteSearchEngine|SiteSearchEngine}, such
406
+ * as
407
+ * `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
408
+ * @param {object} [options]
409
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
410
+ * @returns {Promise} - The promise which resolves to an array.
411
+ * The first element of the array is an object representing
412
+ * a long running operation. Its `promise()` method returns a promise
413
+ * you can `await` for.
414
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
415
+ * for more details and examples.
416
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.disable_advanced_site_search.js</caption>
417
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_async
418
+ */
419
+ disableAdvancedSiteSearch(request?: protos.google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchRequest, options?: CallOptions): Promise<[
420
+ LROperation<protos.google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchMetadata>,
421
+ protos.google.longrunning.IOperation | undefined,
422
+ {} | undefined
423
+ ]>;
424
+ disableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
425
+ disableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
426
+ /**
427
+ * Check the status of the long running operation returned by `disableAdvancedSiteSearch()`.
428
+ * @param {String} name
429
+ * The operation name that will be passed.
430
+ * @returns {Promise} - The promise which resolves to an object.
431
+ * The decoded operation object has result and metadata field to get information from.
432
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
433
+ * for more details and examples.
434
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.disable_advanced_site_search.js</caption>
435
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_async
436
+ */
437
+ checkDisableAdvancedSiteSearchProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.DisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1.DisableAdvancedSiteSearchMetadata>>;
438
+ /**
439
+ * Request on-demand recrawl for a list of URIs.
440
+ *
441
+ * @param {Object} request
442
+ * The request object that will be sent.
443
+ * @param {string} request.siteSearchEngine
444
+ * Required. Full resource name of the
445
+ * {@link protos.google.cloud.discoveryengine.v1.SiteSearchEngine|SiteSearchEngine}, such
446
+ * as `projects/* /locations/* /collections/* /dataStores/* /siteSearchEngine`.
447
+ * @param {string[]} request.uris
448
+ * Required. List of URIs to crawl. At most 10K URIs are supported, otherwise
449
+ * an INVALID_ARGUMENT error is thrown. Each URI should match at least one
450
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite} in
451
+ * `site_search_engine`.
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
456
+ * a long running operation. Its `promise()` method returns a promise
457
+ * you can `await` for.
458
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
459
+ * for more details and examples.
460
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.recrawl_uris.js</caption>
461
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_RecrawlUris_async
462
+ */
463
+ recrawlUris(request?: protos.google.cloud.discoveryengine.v1.IRecrawlUrisRequest, options?: CallOptions): Promise<[
464
+ LROperation<protos.google.cloud.discoveryengine.v1.IRecrawlUrisResponse, protos.google.cloud.discoveryengine.v1.IRecrawlUrisMetadata>,
465
+ protos.google.longrunning.IOperation | undefined,
466
+ {} | undefined
467
+ ]>;
468
+ recrawlUris(request: protos.google.cloud.discoveryengine.v1.IRecrawlUrisRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IRecrawlUrisResponse, protos.google.cloud.discoveryengine.v1.IRecrawlUrisMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
469
+ recrawlUris(request: protos.google.cloud.discoveryengine.v1.IRecrawlUrisRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IRecrawlUrisResponse, protos.google.cloud.discoveryengine.v1.IRecrawlUrisMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
470
+ /**
471
+ * Check the status of the long running operation returned by `recrawlUris()`.
472
+ * @param {String} name
473
+ * The operation name that will be passed.
474
+ * @returns {Promise} - The promise which resolves to an object.
475
+ * The decoded operation object has result and metadata field to get information from.
476
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
477
+ * for more details and examples.
478
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.recrawl_uris.js</caption>
479
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_RecrawlUris_async
480
+ */
481
+ checkRecrawlUrisProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.RecrawlUrisResponse, protos.google.cloud.discoveryengine.v1.RecrawlUrisMetadata>>;
482
+ /**
483
+ * Verify target sites' ownership and validity.
484
+ * This API sends all the target sites under site search engine for
485
+ * verification.
486
+ *
487
+ * @param {Object} request
488
+ * The request object that will be sent.
489
+ * @param {string} request.parent
490
+ * Required. The parent resource shared by all TargetSites being verified.
491
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
492
+ * @param {object} [options]
493
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
494
+ * @returns {Promise} - The promise which resolves to an array.
495
+ * The first element of the array is an object representing
496
+ * a long running operation. Its `promise()` method returns a promise
497
+ * you can `await` for.
498
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
499
+ * for more details and examples.
500
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.batch_verify_target_sites.js</caption>
501
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_BatchVerifyTargetSites_async
502
+ */
503
+ batchVerifyTargetSites(request?: protos.google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesRequest, options?: CallOptions): Promise<[
504
+ LROperation<protos.google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesMetadata>,
505
+ protos.google.longrunning.IOperation | undefined,
506
+ {} | undefined
507
+ ]>;
508
+ batchVerifyTargetSites(request: protos.google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
509
+ batchVerifyTargetSites(request: protos.google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
510
+ /**
511
+ * Check the status of the long running operation returned by `batchVerifyTargetSites()`.
512
+ * @param {String} name
513
+ * The operation name that will be passed.
514
+ * @returns {Promise} - The promise which resolves to an object.
515
+ * The decoded operation object has result and metadata field to get information from.
516
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
517
+ * for more details and examples.
518
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.batch_verify_target_sites.js</caption>
519
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_BatchVerifyTargetSites_async
520
+ */
521
+ checkBatchVerifyTargetSitesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.BatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1.BatchVerifyTargetSitesMetadata>>;
522
+ /**
523
+ * Gets a list of {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}s.
524
+ *
525
+ * @param {Object} request
526
+ * The request object that will be sent.
527
+ * @param {string} request.parent
528
+ * Required. The parent site search engine resource name, such as
529
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
530
+ *
531
+ * If the caller does not have permission to list
532
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}s under this site
533
+ * search engine, regardless of whether or not this branch exists, a
534
+ * PERMISSION_DENIED error is returned.
535
+ * @param {number} request.pageSize
536
+ * Requested page size. Server may return fewer items than requested. If
537
+ * unspecified, server will pick an appropriate default. The maximum value is
538
+ * 1000; values above 1000 will be coerced to 1000.
539
+ *
540
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
541
+ * @param {string} request.pageToken
542
+ * A page token, received from a previous `ListTargetSites` call.
543
+ * Provide this to retrieve the subsequent page.
544
+ *
545
+ * When paginating, all other parameters provided to `ListTargetSites`
546
+ * must match the call that provided the page token.
547
+ * @param {object} [options]
548
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
549
+ * @returns {Promise} - The promise which resolves to an array.
550
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
551
+ * The client library will perform auto-pagination by default: it will call the API as many
552
+ * times as needed and will merge results from all the pages into this array.
553
+ * Note that it can affect your quota.
554
+ * We recommend using `listTargetSitesAsync()`
555
+ * method described below for async iteration which you can stop as needed.
556
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
557
+ * for more details and examples.
558
+ */
559
+ listTargetSites(request?: protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest, options?: CallOptions): Promise<[
560
+ protos.google.cloud.discoveryengine.v1.ITargetSite[],
561
+ protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest | null,
562
+ protos.google.cloud.discoveryengine.v1.IListTargetSitesResponse
563
+ ]>;
564
+ listTargetSites(request: protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest, protos.google.cloud.discoveryengine.v1.IListTargetSitesResponse | null | undefined, protos.google.cloud.discoveryengine.v1.ITargetSite>): void;
565
+ listTargetSites(request: protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest, protos.google.cloud.discoveryengine.v1.IListTargetSitesResponse | null | undefined, protos.google.cloud.discoveryengine.v1.ITargetSite>): void;
566
+ /**
567
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
568
+ * @param {Object} request
569
+ * The request object that will be sent.
570
+ * @param {string} request.parent
571
+ * Required. The parent site search engine resource name, such as
572
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
573
+ *
574
+ * If the caller does not have permission to list
575
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}s under this site
576
+ * search engine, regardless of whether or not this branch exists, a
577
+ * PERMISSION_DENIED error is returned.
578
+ * @param {number} request.pageSize
579
+ * Requested page size. Server may return fewer items than requested. If
580
+ * unspecified, server will pick an appropriate default. The maximum value is
581
+ * 1000; values above 1000 will be coerced to 1000.
582
+ *
583
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
584
+ * @param {string} request.pageToken
585
+ * A page token, received from a previous `ListTargetSites` call.
586
+ * Provide this to retrieve the subsequent page.
587
+ *
588
+ * When paginating, all other parameters provided to `ListTargetSites`
589
+ * must match the call that provided the page token.
590
+ * @param {object} [options]
591
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
592
+ * @returns {Stream}
593
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite} on 'data' event.
594
+ * The client library will perform auto-pagination by default: it will call the API as many
595
+ * times as needed. Note that it can affect your quota.
596
+ * We recommend using `listTargetSitesAsync()`
597
+ * method described below for async iteration which you can stop as needed.
598
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
599
+ * for more details and examples.
600
+ */
601
+ listTargetSitesStream(request?: protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest, options?: CallOptions): Transform;
602
+ /**
603
+ * Equivalent to `listTargetSites`, but returns an iterable object.
604
+ *
605
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
606
+ * @param {Object} request
607
+ * The request object that will be sent.
608
+ * @param {string} request.parent
609
+ * Required. The parent site search engine resource name, such as
610
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
611
+ *
612
+ * If the caller does not have permission to list
613
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}s under this site
614
+ * search engine, regardless of whether or not this branch exists, a
615
+ * PERMISSION_DENIED error is returned.
616
+ * @param {number} request.pageSize
617
+ * Requested page size. Server may return fewer items than requested. If
618
+ * unspecified, server will pick an appropriate default. The maximum value is
619
+ * 1000; values above 1000 will be coerced to 1000.
620
+ *
621
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
622
+ * @param {string} request.pageToken
623
+ * A page token, received from a previous `ListTargetSites` call.
624
+ * Provide this to retrieve the subsequent page.
625
+ *
626
+ * When paginating, all other parameters provided to `ListTargetSites`
627
+ * must match the call that provided the page token.
628
+ * @param {object} [options]
629
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
630
+ * @returns {Object}
631
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
632
+ * When you iterate the returned iterable, each element will be an object representing
633
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}. The API will be called under the hood as needed, once per the page,
634
+ * so you can stop the iteration when you don't need more results.
635
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
636
+ * for more details and examples.
637
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.list_target_sites.js</caption>
638
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_ListTargetSites_async
639
+ */
640
+ listTargetSitesAsync(request?: protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.ITargetSite>;
641
+ /**
642
+ * Returns list of target sites with its domain verification status.
643
+ * This method can only be called under data store with BASIC_SITE_SEARCH
644
+ * state at the moment.
645
+ *
646
+ * @param {Object} request
647
+ * The request object that will be sent.
648
+ * @param {string} request.siteSearchEngine
649
+ * Required. The site search engine resource under which we fetch all the
650
+ * domain verification status.
651
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
652
+ * @param {number} request.pageSize
653
+ * Requested page size. Server may return fewer items than requested. If
654
+ * unspecified, server will pick an appropriate default. The maximum value is
655
+ * 1000; values above 1000 will be coerced to 1000.
656
+ *
657
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
658
+ * @param {string} request.pageToken
659
+ * A page token, received from a previous `FetchDomainVerificationStatus`
660
+ * call. Provide this to retrieve the subsequent page.
661
+ *
662
+ * When paginating, all other parameters provided to
663
+ * `FetchDomainVerificationStatus` must match the call that provided the page
664
+ * token.
665
+ * @param {object} [options]
666
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
667
+ * @returns {Promise} - The promise which resolves to an array.
668
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
669
+ * The client library will perform auto-pagination by default: it will call the API as many
670
+ * times as needed and will merge results from all the pages into this array.
671
+ * Note that it can affect your quota.
672
+ * We recommend using `fetchDomainVerificationStatusAsync()`
673
+ * method described below for async iteration which you can stop as needed.
674
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
675
+ * for more details and examples.
676
+ */
677
+ fetchDomainVerificationStatus(request?: protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, options?: CallOptions): Promise<[
678
+ protos.google.cloud.discoveryengine.v1.ITargetSite[],
679
+ protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest | null,
680
+ protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusResponse
681
+ ]>;
682
+ fetchDomainVerificationStatus(request: protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusResponse | null | undefined, protos.google.cloud.discoveryengine.v1.ITargetSite>): void;
683
+ fetchDomainVerificationStatus(request: protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusResponse | null | undefined, protos.google.cloud.discoveryengine.v1.ITargetSite>): void;
684
+ /**
685
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
686
+ * @param {Object} request
687
+ * The request object that will be sent.
688
+ * @param {string} request.siteSearchEngine
689
+ * Required. The site search engine resource under which we fetch all the
690
+ * domain verification status.
691
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
692
+ * @param {number} request.pageSize
693
+ * Requested page size. Server may return fewer items than requested. If
694
+ * unspecified, server will pick an appropriate default. The maximum value is
695
+ * 1000; values above 1000 will be coerced to 1000.
696
+ *
697
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
698
+ * @param {string} request.pageToken
699
+ * A page token, received from a previous `FetchDomainVerificationStatus`
700
+ * call. Provide this to retrieve the subsequent page.
701
+ *
702
+ * When paginating, all other parameters provided to
703
+ * `FetchDomainVerificationStatus` must match the call that provided the page
704
+ * token.
705
+ * @param {object} [options]
706
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
707
+ * @returns {Stream}
708
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite} on 'data' event.
709
+ * The client library will perform auto-pagination by default: it will call the API as many
710
+ * times as needed. Note that it can affect your quota.
711
+ * We recommend using `fetchDomainVerificationStatusAsync()`
712
+ * method described below for async iteration which you can stop as needed.
713
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
714
+ * for more details and examples.
715
+ */
716
+ fetchDomainVerificationStatusStream(request?: protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, options?: CallOptions): Transform;
717
+ /**
718
+ * Equivalent to `fetchDomainVerificationStatus`, but returns an iterable object.
719
+ *
720
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
721
+ * @param {Object} request
722
+ * The request object that will be sent.
723
+ * @param {string} request.siteSearchEngine
724
+ * Required. The site search engine resource under which we fetch all the
725
+ * domain verification status.
726
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
727
+ * @param {number} request.pageSize
728
+ * Requested page size. Server may return fewer items than requested. If
729
+ * unspecified, server will pick an appropriate default. The maximum value is
730
+ * 1000; values above 1000 will be coerced to 1000.
731
+ *
732
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
733
+ * @param {string} request.pageToken
734
+ * A page token, received from a previous `FetchDomainVerificationStatus`
735
+ * call. Provide this to retrieve the subsequent page.
736
+ *
737
+ * When paginating, all other parameters provided to
738
+ * `FetchDomainVerificationStatus` must match the call that provided the page
739
+ * token.
740
+ * @param {object} [options]
741
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
742
+ * @returns {Object}
743
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
744
+ * When you iterate the returned iterable, each element will be an object representing
745
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}. The API will be called under the hood as needed, once per the page,
746
+ * so you can stop the iteration when you don't need more results.
747
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
748
+ * for more details and examples.
749
+ * @example <caption>include:samples/generated/v1/site_search_engine_service.fetch_domain_verification_status.js</caption>
750
+ * region_tag:discoveryengine_v1_generated_SiteSearchEngineService_FetchDomainVerificationStatus_async
751
+ */
752
+ fetchDomainVerificationStatusAsync(request?: protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.ITargetSite>;
753
+ /**
754
+ * Gets information about a location.
755
+ *
756
+ * @param {Object} request
757
+ * The request object that will be sent.
758
+ * @param {string} request.name
759
+ * Resource name for the location.
760
+ * @param {object} [options]
761
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
762
+ * @returns {Promise} - The promise which resolves to an array.
763
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
764
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
765
+ * for more details and examples.
766
+ * @example
767
+ * ```
768
+ * const [response] = await client.getLocation(request);
769
+ * ```
770
+ */
771
+ 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>;
772
+ /**
773
+ * Lists information about the supported locations for this service. Returns an iterable object.
774
+ *
775
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
776
+ * @param {Object} request
777
+ * The request object that will be sent.
778
+ * @param {string} request.name
779
+ * The resource that owns the locations collection, if applicable.
780
+ * @param {string} request.filter
781
+ * The standard list filter.
782
+ * @param {number} request.pageSize
783
+ * The standard list page size.
784
+ * @param {string} request.pageToken
785
+ * The standard list page token.
786
+ * @param {object} [options]
787
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
788
+ * @returns {Object}
789
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
790
+ * When you iterate the returned iterable, each element will be an object representing
791
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
792
+ * so you can stop the iteration when you don't need more results.
793
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
794
+ * for more details and examples.
795
+ * @example
796
+ * ```
797
+ * const iterable = client.listLocationsAsync(request);
798
+ * for await (const response of iterable) {
799
+ * // process response
800
+ * }
801
+ * ```
802
+ */
803
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
804
+ /**
805
+ * Gets the latest state of a long-running operation. Clients can use this
806
+ * method to poll the operation result at intervals as recommended by the API
807
+ * service.
808
+ *
809
+ * @param {Object} request - The request object that will be sent.
810
+ * @param {string} request.name - The name of the operation resource.
811
+ * @param {Object=} options
812
+ * Optional parameters. You can override the default settings for this call,
813
+ * e.g, timeout, retries, paginations, etc. See {@link
814
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
815
+ * for the details.
816
+ * @param {function(?Error, ?Object)=} callback
817
+ * The function which will be called with the result of the API call.
818
+ *
819
+ * The second parameter to the callback is an object representing
820
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
821
+ * @return {Promise} - The promise which resolves to an array.
822
+ * The first element of the array is an object representing
823
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
824
+ * The promise has a method named "cancel" which cancels the ongoing API call.
825
+ *
826
+ * @example
827
+ * ```
828
+ * const client = longrunning.operationsClient();
829
+ * const name = '';
830
+ * const [response] = await client.getOperation({name});
831
+ * // doThingsWith(response)
832
+ * ```
833
+ */
834
+ 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]>;
835
+ /**
836
+ * Lists operations that match the specified filter in the request. If the
837
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
838
+ *
839
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
840
+ *
841
+ * @param {Object} request - The request object that will be sent.
842
+ * @param {string} request.name - The name of the operation collection.
843
+ * @param {string} request.filter - The standard list filter.
844
+ * @param {number=} request.pageSize -
845
+ * The maximum number of resources contained in the underlying API
846
+ * response. If page streaming is performed per-resource, this
847
+ * parameter does not affect the return value. If page streaming is
848
+ * performed per-page, this determines the maximum number of
849
+ * resources in a page.
850
+ * @param {Object=} options
851
+ * Optional parameters. You can override the default settings for this call,
852
+ * e.g, timeout, retries, paginations, etc. See {@link
853
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
854
+ * details.
855
+ * @returns {Object}
856
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
857
+ *
858
+ * @example
859
+ * ```
860
+ * const client = longrunning.operationsClient();
861
+ * for await (const response of client.listOperationsAsync(request));
862
+ * // doThingsWith(response)
863
+ * ```
864
+ */
865
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
866
+ /**
867
+ * Starts asynchronous cancellation on a long-running operation. The server
868
+ * makes a best effort to cancel the operation, but success is not
869
+ * guaranteed. If the server doesn't support this method, it returns
870
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
871
+ * {@link Operations.GetOperation} or
872
+ * other methods to check whether the cancellation succeeded or whether the
873
+ * operation completed despite cancellation. On successful cancellation,
874
+ * the operation is not deleted; instead, it becomes an operation with
875
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
876
+ * 1, corresponding to `Code.CANCELLED`.
877
+ *
878
+ * @param {Object} request - The request object that will be sent.
879
+ * @param {string} request.name - The name of the operation resource to be cancelled.
880
+ * @param {Object=} options
881
+ * Optional parameters. You can override the default settings for this call,
882
+ * e.g, timeout, retries, paginations, etc. See {@link
883
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
884
+ * details.
885
+ * @param {function(?Error)=} callback
886
+ * The function which will be called with the result of the API call.
887
+ * @return {Promise} - The promise which resolves when API call finishes.
888
+ * The promise has a method named "cancel" which cancels the ongoing API
889
+ * call.
890
+ *
891
+ * @example
892
+ * ```
893
+ * const client = longrunning.operationsClient();
894
+ * await client.cancelOperation({name: ''});
895
+ * ```
896
+ */
897
+ 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>;
898
+ /**
899
+ * Deletes a long-running operation. This method indicates that the client is
900
+ * no longer interested in the operation result. It does not cancel the
901
+ * operation. If the server doesn't support this method, it returns
902
+ * `google.rpc.Code.UNIMPLEMENTED`.
903
+ *
904
+ * @param {Object} request - The request object that will be sent.
905
+ * @param {string} request.name - The name of the operation resource to be deleted.
906
+ * @param {Object=} options
907
+ * Optional parameters. You can override the default settings for this call,
908
+ * e.g, timeout, retries, paginations, etc. See {@link
909
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
910
+ * for the details.
911
+ * @param {function(?Error)=} callback
912
+ * The function which will be called with the result of the API call.
913
+ * @return {Promise} - The promise which resolves when API call finishes.
914
+ * The promise has a method named "cancel" which cancels the ongoing API
915
+ * call.
916
+ *
917
+ * @example
918
+ * ```
919
+ * const client = longrunning.operationsClient();
920
+ * await client.deleteOperation({name: ''});
921
+ * ```
922
+ */
923
+ 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>;
924
+ /**
925
+ * Return a fully-qualified engine resource name string.
926
+ *
927
+ * @param {string} project
928
+ * @param {string} location
929
+ * @param {string} collection
930
+ * @param {string} engine
931
+ * @returns {string} Resource name string.
932
+ */
933
+ enginePath(project: string, location: string, collection: string, engine: string): string;
934
+ /**
935
+ * Parse the project from Engine resource.
936
+ *
937
+ * @param {string} engineName
938
+ * A fully-qualified path representing Engine resource.
939
+ * @returns {string} A string representing the project.
940
+ */
941
+ matchProjectFromEngineName(engineName: string): string | number;
942
+ /**
943
+ * Parse the location from Engine resource.
944
+ *
945
+ * @param {string} engineName
946
+ * A fully-qualified path representing Engine resource.
947
+ * @returns {string} A string representing the location.
948
+ */
949
+ matchLocationFromEngineName(engineName: string): string | number;
950
+ /**
951
+ * Parse the collection from Engine resource.
952
+ *
953
+ * @param {string} engineName
954
+ * A fully-qualified path representing Engine resource.
955
+ * @returns {string} A string representing the collection.
956
+ */
957
+ matchCollectionFromEngineName(engineName: string): string | number;
958
+ /**
959
+ * Parse the engine from Engine resource.
960
+ *
961
+ * @param {string} engineName
962
+ * A fully-qualified path representing Engine resource.
963
+ * @returns {string} A string representing the engine.
964
+ */
965
+ matchEngineFromEngineName(engineName: string): string | number;
966
+ /**
967
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
968
+ *
969
+ * @param {string} project
970
+ * @param {string} location
971
+ * @param {string} collection
972
+ * @param {string} data_store
973
+ * @returns {string} Resource name string.
974
+ */
975
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
976
+ /**
977
+ * Parse the project from ProjectLocationCollectionDataStore resource.
978
+ *
979
+ * @param {string} projectLocationCollectionDataStoreName
980
+ * A fully-qualified path representing project_location_collection_data_store resource.
981
+ * @returns {string} A string representing the project.
982
+ */
983
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
984
+ /**
985
+ * Parse the location from ProjectLocationCollectionDataStore resource.
986
+ *
987
+ * @param {string} projectLocationCollectionDataStoreName
988
+ * A fully-qualified path representing project_location_collection_data_store resource.
989
+ * @returns {string} A string representing the location.
990
+ */
991
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
992
+ /**
993
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
994
+ *
995
+ * @param {string} projectLocationCollectionDataStoreName
996
+ * A fully-qualified path representing project_location_collection_data_store resource.
997
+ * @returns {string} A string representing the collection.
998
+ */
999
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
1000
+ /**
1001
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
1002
+ *
1003
+ * @param {string} projectLocationCollectionDataStoreName
1004
+ * A fully-qualified path representing project_location_collection_data_store resource.
1005
+ * @returns {string} A string representing the data_store.
1006
+ */
1007
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
1008
+ /**
1009
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
1010
+ *
1011
+ * @param {string} project
1012
+ * @param {string} location
1013
+ * @param {string} collection
1014
+ * @param {string} data_store
1015
+ * @param {string} branch
1016
+ * @param {string} document
1017
+ * @returns {string} Resource name string.
1018
+ */
1019
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
1020
+ /**
1021
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
1022
+ *
1023
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1024
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1025
+ * @returns {string} A string representing the project.
1026
+ */
1027
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
1028
+ /**
1029
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
1030
+ *
1031
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1032
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1033
+ * @returns {string} A string representing the location.
1034
+ */
1035
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
1036
+ /**
1037
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
1038
+ *
1039
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1040
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1041
+ * @returns {string} A string representing the collection.
1042
+ */
1043
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
1044
+ /**
1045
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
1046
+ *
1047
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1048
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1049
+ * @returns {string} A string representing the data_store.
1050
+ */
1051
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
1052
+ /**
1053
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
1054
+ *
1055
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1056
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1057
+ * @returns {string} A string representing the branch.
1058
+ */
1059
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
1060
+ /**
1061
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
1062
+ *
1063
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1064
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1065
+ * @returns {string} A string representing the document.
1066
+ */
1067
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
1068
+ /**
1069
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
1070
+ *
1071
+ * @param {string} project
1072
+ * @param {string} location
1073
+ * @param {string} collection
1074
+ * @param {string} data_store
1075
+ * @param {string} conversation
1076
+ * @returns {string} Resource name string.
1077
+ */
1078
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
1079
+ /**
1080
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
1081
+ *
1082
+ * @param {string} projectLocationCollectionDataStoreConversationName
1083
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1084
+ * @returns {string} A string representing the project.
1085
+ */
1086
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
1087
+ /**
1088
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
1089
+ *
1090
+ * @param {string} projectLocationCollectionDataStoreConversationName
1091
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1092
+ * @returns {string} A string representing the location.
1093
+ */
1094
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
1095
+ /**
1096
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
1097
+ *
1098
+ * @param {string} projectLocationCollectionDataStoreConversationName
1099
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1100
+ * @returns {string} A string representing the collection.
1101
+ */
1102
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
1103
+ /**
1104
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
1105
+ *
1106
+ * @param {string} projectLocationCollectionDataStoreConversationName
1107
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1108
+ * @returns {string} A string representing the data_store.
1109
+ */
1110
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
1111
+ /**
1112
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
1113
+ *
1114
+ * @param {string} projectLocationCollectionDataStoreConversationName
1115
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1116
+ * @returns {string} A string representing the conversation.
1117
+ */
1118
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
1119
+ /**
1120
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
1121
+ *
1122
+ * @param {string} project
1123
+ * @param {string} location
1124
+ * @param {string} collection
1125
+ * @param {string} data_store
1126
+ * @param {string} schema
1127
+ * @returns {string} Resource name string.
1128
+ */
1129
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
1130
+ /**
1131
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
1132
+ *
1133
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1134
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1135
+ * @returns {string} A string representing the project.
1136
+ */
1137
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1138
+ /**
1139
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
1140
+ *
1141
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1142
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1143
+ * @returns {string} A string representing the location.
1144
+ */
1145
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1146
+ /**
1147
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
1148
+ *
1149
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1150
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1151
+ * @returns {string} A string representing the collection.
1152
+ */
1153
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1154
+ /**
1155
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
1156
+ *
1157
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1158
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1159
+ * @returns {string} A string representing the data_store.
1160
+ */
1161
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1162
+ /**
1163
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
1164
+ *
1165
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1166
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1167
+ * @returns {string} A string representing the schema.
1168
+ */
1169
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1170
+ /**
1171
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
1172
+ *
1173
+ * @param {string} project
1174
+ * @param {string} location
1175
+ * @param {string} collection
1176
+ * @param {string} data_store
1177
+ * @returns {string} Resource name string.
1178
+ */
1179
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
1180
+ /**
1181
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1182
+ *
1183
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1184
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1185
+ * @returns {string} A string representing the project.
1186
+ */
1187
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1188
+ /**
1189
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1190
+ *
1191
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1192
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1193
+ * @returns {string} A string representing the location.
1194
+ */
1195
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1196
+ /**
1197
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1198
+ *
1199
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1200
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1201
+ * @returns {string} A string representing the collection.
1202
+ */
1203
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1204
+ /**
1205
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1206
+ *
1207
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1208
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1209
+ * @returns {string} A string representing the data_store.
1210
+ */
1211
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1212
+ /**
1213
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1214
+ *
1215
+ * @param {string} project
1216
+ * @param {string} location
1217
+ * @param {string} collection
1218
+ * @param {string} data_store
1219
+ * @param {string} target_site
1220
+ * @returns {string} Resource name string.
1221
+ */
1222
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
1223
+ /**
1224
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1225
+ *
1226
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1227
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1228
+ * @returns {string} A string representing the project.
1229
+ */
1230
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1231
+ /**
1232
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1233
+ *
1234
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1235
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1236
+ * @returns {string} A string representing the location.
1237
+ */
1238
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1239
+ /**
1240
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1241
+ *
1242
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1243
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1244
+ * @returns {string} A string representing the collection.
1245
+ */
1246
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1247
+ /**
1248
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1249
+ *
1250
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1251
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1252
+ * @returns {string} A string representing the data_store.
1253
+ */
1254
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1255
+ /**
1256
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1257
+ *
1258
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1259
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1260
+ * @returns {string} A string representing the target_site.
1261
+ */
1262
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1263
+ /**
1264
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1265
+ *
1266
+ * @param {string} project
1267
+ * @param {string} location
1268
+ * @param {string} collection
1269
+ * @param {string} engine
1270
+ * @param {string} conversation
1271
+ * @returns {string} Resource name string.
1272
+ */
1273
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
1274
+ /**
1275
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1276
+ *
1277
+ * @param {string} projectLocationCollectionEngineConversationName
1278
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1279
+ * @returns {string} A string representing the project.
1280
+ */
1281
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1282
+ /**
1283
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1284
+ *
1285
+ * @param {string} projectLocationCollectionEngineConversationName
1286
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1287
+ * @returns {string} A string representing the location.
1288
+ */
1289
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1290
+ /**
1291
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1292
+ *
1293
+ * @param {string} projectLocationCollectionEngineConversationName
1294
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1295
+ * @returns {string} A string representing the collection.
1296
+ */
1297
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1298
+ /**
1299
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1300
+ *
1301
+ * @param {string} projectLocationCollectionEngineConversationName
1302
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1303
+ * @returns {string} A string representing the engine.
1304
+ */
1305
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1306
+ /**
1307
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1308
+ *
1309
+ * @param {string} projectLocationCollectionEngineConversationName
1310
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1311
+ * @returns {string} A string representing the conversation.
1312
+ */
1313
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1314
+ /**
1315
+ * Return a fully-qualified projectLocationDataStore resource name string.
1316
+ *
1317
+ * @param {string} project
1318
+ * @param {string} location
1319
+ * @param {string} data_store
1320
+ * @returns {string} Resource name string.
1321
+ */
1322
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
1323
+ /**
1324
+ * Parse the project from ProjectLocationDataStore resource.
1325
+ *
1326
+ * @param {string} projectLocationDataStoreName
1327
+ * A fully-qualified path representing project_location_data_store resource.
1328
+ * @returns {string} A string representing the project.
1329
+ */
1330
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
1331
+ /**
1332
+ * Parse the location from ProjectLocationDataStore resource.
1333
+ *
1334
+ * @param {string} projectLocationDataStoreName
1335
+ * A fully-qualified path representing project_location_data_store resource.
1336
+ * @returns {string} A string representing the location.
1337
+ */
1338
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
1339
+ /**
1340
+ * Parse the data_store from ProjectLocationDataStore resource.
1341
+ *
1342
+ * @param {string} projectLocationDataStoreName
1343
+ * A fully-qualified path representing project_location_data_store resource.
1344
+ * @returns {string} A string representing the data_store.
1345
+ */
1346
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
1347
+ /**
1348
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
1349
+ *
1350
+ * @param {string} project
1351
+ * @param {string} location
1352
+ * @param {string} data_store
1353
+ * @param {string} branch
1354
+ * @param {string} document
1355
+ * @returns {string} Resource name string.
1356
+ */
1357
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
1358
+ /**
1359
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
1360
+ *
1361
+ * @param {string} projectLocationDataStoreBranchDocumentName
1362
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1363
+ * @returns {string} A string representing the project.
1364
+ */
1365
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1366
+ /**
1367
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
1368
+ *
1369
+ * @param {string} projectLocationDataStoreBranchDocumentName
1370
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1371
+ * @returns {string} A string representing the location.
1372
+ */
1373
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1374
+ /**
1375
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
1376
+ *
1377
+ * @param {string} projectLocationDataStoreBranchDocumentName
1378
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1379
+ * @returns {string} A string representing the data_store.
1380
+ */
1381
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1382
+ /**
1383
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
1384
+ *
1385
+ * @param {string} projectLocationDataStoreBranchDocumentName
1386
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1387
+ * @returns {string} A string representing the branch.
1388
+ */
1389
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1390
+ /**
1391
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
1392
+ *
1393
+ * @param {string} projectLocationDataStoreBranchDocumentName
1394
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1395
+ * @returns {string} A string representing the document.
1396
+ */
1397
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1398
+ /**
1399
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
1400
+ *
1401
+ * @param {string} project
1402
+ * @param {string} location
1403
+ * @param {string} data_store
1404
+ * @param {string} conversation
1405
+ * @returns {string} Resource name string.
1406
+ */
1407
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
1408
+ /**
1409
+ * Parse the project from ProjectLocationDataStoreConversation resource.
1410
+ *
1411
+ * @param {string} projectLocationDataStoreConversationName
1412
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1413
+ * @returns {string} A string representing the project.
1414
+ */
1415
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1416
+ /**
1417
+ * Parse the location from ProjectLocationDataStoreConversation resource.
1418
+ *
1419
+ * @param {string} projectLocationDataStoreConversationName
1420
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1421
+ * @returns {string} A string representing the location.
1422
+ */
1423
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1424
+ /**
1425
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
1426
+ *
1427
+ * @param {string} projectLocationDataStoreConversationName
1428
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1429
+ * @returns {string} A string representing the data_store.
1430
+ */
1431
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1432
+ /**
1433
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
1434
+ *
1435
+ * @param {string} projectLocationDataStoreConversationName
1436
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1437
+ * @returns {string} A string representing the conversation.
1438
+ */
1439
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1440
+ /**
1441
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
1442
+ *
1443
+ * @param {string} project
1444
+ * @param {string} location
1445
+ * @param {string} data_store
1446
+ * @param {string} schema
1447
+ * @returns {string} Resource name string.
1448
+ */
1449
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
1450
+ /**
1451
+ * Parse the project from ProjectLocationDataStoreSchema resource.
1452
+ *
1453
+ * @param {string} projectLocationDataStoreSchemaName
1454
+ * A fully-qualified path representing project_location_data_store_schema resource.
1455
+ * @returns {string} A string representing the project.
1456
+ */
1457
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1458
+ /**
1459
+ * Parse the location from ProjectLocationDataStoreSchema resource.
1460
+ *
1461
+ * @param {string} projectLocationDataStoreSchemaName
1462
+ * A fully-qualified path representing project_location_data_store_schema resource.
1463
+ * @returns {string} A string representing the location.
1464
+ */
1465
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1466
+ /**
1467
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
1468
+ *
1469
+ * @param {string} projectLocationDataStoreSchemaName
1470
+ * A fully-qualified path representing project_location_data_store_schema resource.
1471
+ * @returns {string} A string representing the data_store.
1472
+ */
1473
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1474
+ /**
1475
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
1476
+ *
1477
+ * @param {string} projectLocationDataStoreSchemaName
1478
+ * A fully-qualified path representing project_location_data_store_schema resource.
1479
+ * @returns {string} A string representing the schema.
1480
+ */
1481
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1482
+ /**
1483
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1484
+ *
1485
+ * @param {string} project
1486
+ * @param {string} location
1487
+ * @param {string} data_store
1488
+ * @returns {string} Resource name string.
1489
+ */
1490
+ projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
1491
+ /**
1492
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1493
+ *
1494
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1495
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1496
+ * @returns {string} A string representing the project.
1497
+ */
1498
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1499
+ /**
1500
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1501
+ *
1502
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1503
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1504
+ * @returns {string} A string representing the location.
1505
+ */
1506
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1507
+ /**
1508
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1509
+ *
1510
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1511
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1512
+ * @returns {string} A string representing the data_store.
1513
+ */
1514
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1515
+ /**
1516
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1517
+ *
1518
+ * @param {string} project
1519
+ * @param {string} location
1520
+ * @param {string} data_store
1521
+ * @param {string} target_site
1522
+ * @returns {string} Resource name string.
1523
+ */
1524
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
1525
+ /**
1526
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1527
+ *
1528
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1529
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1530
+ * @returns {string} A string representing the project.
1531
+ */
1532
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1533
+ /**
1534
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1535
+ *
1536
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1537
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1538
+ * @returns {string} A string representing the location.
1539
+ */
1540
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1541
+ /**
1542
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1543
+ *
1544
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1545
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1546
+ * @returns {string} A string representing the data_store.
1547
+ */
1548
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1549
+ /**
1550
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1551
+ *
1552
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1553
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1554
+ * @returns {string} A string representing the target_site.
1555
+ */
1556
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1557
+ /**
1558
+ * Terminate the gRPC channel and close the client.
1559
+ *
1560
+ * The client will no longer be usable and all future behavior is undefined.
1561
+ * @returns {Promise} A promise that resolves when the client is closed.
1562
+ */
1563
+ close(): Promise<void>;
1564
+ }