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