@google-cloud/discoveryengine 1.0.0 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +20 -0
- package/README.md +33 -1
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +30 -2
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +15 -2
- package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +114 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +303 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +8 -5
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +4 -3
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +27 -23
- package/build/protos/google/cloud/discoveryengine/v1/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +428 -20
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +48 -39
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +155 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +134 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +138 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +121 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +318 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +343 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +159 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +221 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +312 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +260 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +851 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +152 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +475 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +154 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +6 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +9 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +25 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +115 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
- package/build/protos/protos.d.ts +22864 -6680
- package/build/protos/protos.js +57205 -16191
- package/build/protos/protos.json +5548 -1224
- package/build/src/index.d.ts +6 -1
- package/build/src/index.js +7 -1
- package/build/src/v1/completion_service_client.d.ts +156 -6
- package/build/src/v1/completion_service_client.js +188 -4
- package/build/src/v1/conversational_search_service_client.d.ts +947 -0
- package/build/src/v1/conversational_search_service_client.js +1205 -0
- package/build/src/v1/conversational_search_service_client_config.json +68 -0
- package/build/src/v1/document_service_client.d.ts +165 -18
- package/build/src/v1/document_service_client.js +215 -11
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +3 -1
- package/build/src/v1/schema_service_client.d.ts +148 -4
- package/build/src/v1/schema_service_client.js +207 -5
- package/build/src/v1/search_service_client.d.ts +238 -28
- package/build/src/v1/search_service_client.js +248 -20
- package/build/src/v1/user_event_service_client.d.ts +153 -9
- package/build/src/v1/user_event_service_client.js +207 -5
- package/build/src/v1alpha/completion_service_client.d.ts +603 -0
- package/build/src/v1alpha/completion_service_client.js +843 -0
- package/build/src/v1alpha/completion_service_client_config.json +43 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +998 -0
- package/build/src/v1alpha/conversational_search_service_client.js +1275 -0
- package/build/src/v1alpha/conversational_search_service_client_config.json +68 -0
- package/build/src/v1alpha/document_service_client.d.ts +1140 -0
- package/build/src/v1alpha/document_service_client.js +1393 -0
- package/build/src/v1alpha/document_service_client_config.json +82 -0
- package/build/src/v1alpha/index.d.ts +8 -0
- package/build/src/v1alpha/index.js +37 -0
- package/build/src/v1alpha/recommendation_service_client.d.ts +735 -0
- package/build/src/v1alpha/recommendation_service_client.js +938 -0
- package/build/src/v1alpha/recommendation_service_client_config.json +43 -0
- package/build/src/v1alpha/schema_service_client.d.ts +935 -0
- package/build/src/v1alpha/schema_service_client.js +1327 -0
- package/build/src/v1alpha/schema_service_client_config.json +63 -0
- package/build/src/v1alpha/search_service_client.d.ts +1208 -0
- package/build/src/v1alpha/search_service_client.js +1432 -0
- package/build/src/v1alpha/search_service_client_config.json +43 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +704 -0
- package/build/src/v1alpha/site_search_engine_service_client.js +1087 -0
- package/build/src/v1alpha/site_search_engine_service_client_config.json +30 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +853 -0
- package/build/src/v1alpha/user_event_service_client.js +1174 -0
- package/build/src/v1alpha/user_event_service_client_config.json +67 -0
- package/build/src/v1beta/completion_service_client.d.ts +55 -4
- package/build/src/v1beta/completion_service_client.js +60 -4
- package/build/src/v1beta/conversational_search_service_client.d.ts +75 -4
- package/build/src/v1beta/conversational_search_service_client.js +60 -4
- package/build/src/v1beta/document_service_client.d.ts +55 -4
- package/build/src/v1beta/document_service_client.js +61 -5
- package/build/src/v1beta/recommendation_service_client.d.ts +55 -4
- package/build/src/v1beta/recommendation_service_client.js +60 -4
- package/build/src/v1beta/schema_service_client.d.ts +55 -4
- package/build/src/v1beta/schema_service_client.js +61 -5
- package/build/src/v1beta/search_service_client.d.ts +142 -4
- package/build/src/v1beta/search_service_client.js +118 -4
- package/build/src/v1beta/user_event_service_client.d.ts +55 -4
- package/build/src/v1beta/user_event_service_client.js +61 -5
- package/package.json +5 -5
@@ -0,0 +1,853 @@
|
|
1
|
+
import type * as gax from 'google-gax';
|
2
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, LocationsClient, LocationProtos } from 'google-gax';
|
3
|
+
import * as protos from '../../protos/protos';
|
4
|
+
/**
|
5
|
+
* Service for ingesting end user actions on a website to Discovery Engine API.
|
6
|
+
* @class
|
7
|
+
* @memberof v1alpha
|
8
|
+
*/
|
9
|
+
export declare class UserEventServiceClient {
|
10
|
+
private _terminated;
|
11
|
+
private _opts;
|
12
|
+
private _providedCustomServicePath;
|
13
|
+
private _gaxModule;
|
14
|
+
private _gaxGrpc;
|
15
|
+
private _protos;
|
16
|
+
private _defaults;
|
17
|
+
auth: gax.GoogleAuth;
|
18
|
+
descriptors: Descriptors;
|
19
|
+
warn: (code: string, message: string, warnType?: string) => void;
|
20
|
+
innerApiCalls: {
|
21
|
+
[name: string]: Function;
|
22
|
+
};
|
23
|
+
locationsClient: LocationsClient;
|
24
|
+
pathTemplates: {
|
25
|
+
[name: string]: gax.PathTemplate;
|
26
|
+
};
|
27
|
+
operationsClient: gax.OperationsClient;
|
28
|
+
userEventServiceStub?: Promise<{
|
29
|
+
[name: string]: Function;
|
30
|
+
}>;
|
31
|
+
/**
|
32
|
+
* Construct an instance of UserEventServiceClient.
|
33
|
+
*
|
34
|
+
* @param {object} [options] - The configuration object.
|
35
|
+
* The options accepted by the constructor are described in detail
|
36
|
+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
|
37
|
+
* The common options are:
|
38
|
+
* @param {object} [options.credentials] - Credentials object.
|
39
|
+
* @param {string} [options.credentials.client_email]
|
40
|
+
* @param {string} [options.credentials.private_key]
|
41
|
+
* @param {string} [options.email] - Account email address. Required when
|
42
|
+
* using a .pem or .p12 keyFilename.
|
43
|
+
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
|
44
|
+
* .p12 key downloaded from the Google Developers Console. If you provide
|
45
|
+
* a path to a JSON file, the projectId option below is not necessary.
|
46
|
+
* NOTE: .pem and .p12 require you to specify options.email as well.
|
47
|
+
* @param {number} [options.port] - The port on which to connect to
|
48
|
+
* the remote host.
|
49
|
+
* @param {string} [options.projectId] - The project ID from the Google
|
50
|
+
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
51
|
+
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
52
|
+
* app is running in an environment which supports
|
53
|
+
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
|
54
|
+
* your project ID will be detected automatically.
|
55
|
+
* @param {string} [options.apiEndpoint] - The domain name of the
|
56
|
+
* API remote host.
|
57
|
+
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
58
|
+
* Follows the structure of {@link gapicConfig}.
|
59
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
60
|
+
* For more information, please check the
|
61
|
+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
62
|
+
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
63
|
+
* need to avoid loading the default gRPC version and want to use the fallback
|
64
|
+
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
65
|
+
* ```
|
66
|
+
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
67
|
+
* const client = new UserEventServiceClient({fallback: true}, gax);
|
68
|
+
* ```
|
69
|
+
*/
|
70
|
+
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
71
|
+
/**
|
72
|
+
* Initialize the client.
|
73
|
+
* Performs asynchronous operations (such as authentication) and prepares the client.
|
74
|
+
* This function will be called automatically when any class method is called for the
|
75
|
+
* first time, but if you need to initialize it before calling an actual method,
|
76
|
+
* feel free to call initialize() directly.
|
77
|
+
*
|
78
|
+
* You can await on this method if you want to make sure the client is initialized.
|
79
|
+
*
|
80
|
+
* @returns {Promise} A promise that resolves to an authenticated service stub.
|
81
|
+
*/
|
82
|
+
initialize(): Promise<{
|
83
|
+
[name: string]: Function;
|
84
|
+
}>;
|
85
|
+
/**
|
86
|
+
* The DNS address for this API service.
|
87
|
+
* @returns {string} The DNS address for this service.
|
88
|
+
*/
|
89
|
+
static get servicePath(): string;
|
90
|
+
/**
|
91
|
+
* The DNS address for this API service - same as servicePath(),
|
92
|
+
* exists for compatibility reasons.
|
93
|
+
* @returns {string} The DNS address for this service.
|
94
|
+
*/
|
95
|
+
static get apiEndpoint(): string;
|
96
|
+
/**
|
97
|
+
* The port for this API service.
|
98
|
+
* @returns {number} The default port for this service.
|
99
|
+
*/
|
100
|
+
static get port(): number;
|
101
|
+
/**
|
102
|
+
* The scopes needed to make gRPC calls for every method defined
|
103
|
+
* in this service.
|
104
|
+
* @returns {string[]} List of default scopes.
|
105
|
+
*/
|
106
|
+
static get scopes(): string[];
|
107
|
+
getProjectId(): Promise<string>;
|
108
|
+
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
109
|
+
/**
|
110
|
+
* Writes a single user event.
|
111
|
+
*
|
112
|
+
* @param {Object} request
|
113
|
+
* The request object that will be sent.
|
114
|
+
* @param {string} request.parent
|
115
|
+
* Required. The parent DataStore resource name, such as
|
116
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
117
|
+
* @param {google.cloud.discoveryengine.v1alpha.UserEvent} request.userEvent
|
118
|
+
* Required. User event to write.
|
119
|
+
* @param {object} [options]
|
120
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
121
|
+
* @returns {Promise} - The promise which resolves to an array.
|
122
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent|UserEvent}.
|
123
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
124
|
+
* for more details and examples.
|
125
|
+
* @example <caption>include:samples/generated/v1alpha/user_event_service.write_user_event.js</caption>
|
126
|
+
* region_tag:discoveryengine_v1alpha_generated_UserEventService_WriteUserEvent_async
|
127
|
+
*/
|
128
|
+
writeUserEvent(request?: protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest, options?: CallOptions): Promise<[
|
129
|
+
protos.google.cloud.discoveryengine.v1alpha.IUserEvent,
|
130
|
+
(protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest | undefined),
|
131
|
+
{} | undefined
|
132
|
+
]>;
|
133
|
+
writeUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IUserEvent, protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
|
134
|
+
writeUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IUserEvent, protos.google.cloud.discoveryengine.v1alpha.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
|
135
|
+
/**
|
136
|
+
* Writes a single user event from the browser. This uses a GET request to
|
137
|
+
* due to browser restriction of POST-ing to a third-party domain.
|
138
|
+
*
|
139
|
+
* This method is used only by the Discovery Engine API JavaScript pixel and
|
140
|
+
* Google Tag Manager. Users should not call this method directly.
|
141
|
+
*
|
142
|
+
* @param {Object} request
|
143
|
+
* The request object that will be sent.
|
144
|
+
* @param {string} request.parent
|
145
|
+
* Required. The parent DataStore resource name, such as
|
146
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
147
|
+
* @param {string} request.userEvent
|
148
|
+
* Required. URL encoded UserEvent proto with a length limit of 2,000,000
|
149
|
+
* characters.
|
150
|
+
* @param {string} request.uri
|
151
|
+
* The URL including cgi-parameters but excluding the hash fragment with a
|
152
|
+
* length limit of 5,000 characters. This is often more useful than the
|
153
|
+
* referer URL, because many browsers only send the domain for third-party
|
154
|
+
* requests.
|
155
|
+
* @param {number} request.ets
|
156
|
+
* The event timestamp in milliseconds. This prevents browser caching of
|
157
|
+
* otherwise identical get requests. The name is abbreviated to reduce the
|
158
|
+
* payload bytes.
|
159
|
+
* @param {object} [options]
|
160
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
161
|
+
* @returns {Promise} - The promise which resolves to an array.
|
162
|
+
* The first element of the array is an object representing {@link protos.google.api.HttpBody|HttpBody}.
|
163
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
164
|
+
* for more details and examples.
|
165
|
+
* @example <caption>include:samples/generated/v1alpha/user_event_service.collect_user_event.js</caption>
|
166
|
+
* region_tag:discoveryengine_v1alpha_generated_UserEventService_CollectUserEvent_async
|
167
|
+
*/
|
168
|
+
collectUserEvent(request?: protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest, options?: CallOptions): Promise<[
|
169
|
+
protos.google.api.IHttpBody,
|
170
|
+
(protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest | undefined),
|
171
|
+
{} | undefined
|
172
|
+
]>;
|
173
|
+
collectUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
|
174
|
+
collectUserEvent(request: protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1alpha.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
|
175
|
+
/**
|
176
|
+
* Deletes permanently all user events specified by the filter provided.
|
177
|
+
* Depending on the number of events specified by the filter, this operation
|
178
|
+
* could take hours or days to complete. To test a filter, use the list
|
179
|
+
* command first.
|
180
|
+
*
|
181
|
+
* @param {Object} request
|
182
|
+
* The request object that will be sent.
|
183
|
+
* @param {string} request.parent
|
184
|
+
* Required. The resource name of the catalog under which the events are
|
185
|
+
* created. The format is
|
186
|
+
* `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
|
187
|
+
* @param {string} request.filter
|
188
|
+
* Required. The filter string to specify the events to be deleted with a
|
189
|
+
* length limit of 5,000 characters. The eligible fields for filtering are:
|
190
|
+
*
|
191
|
+
* * `eventType`: Double quoted
|
192
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.event_type|UserEvent.event_type}
|
193
|
+
* string.
|
194
|
+
* * `eventTime`: in ISO 8601 "zulu" format.
|
195
|
+
* * `userPseudoId`: Double quoted string. Specifying this will delete all
|
196
|
+
* events associated with a visitor.
|
197
|
+
* * `userId`: Double quoted string. Specifying this will delete all events
|
198
|
+
* associated with a user.
|
199
|
+
*
|
200
|
+
* Examples:
|
201
|
+
*
|
202
|
+
* * Deleting all events in a time range:
|
203
|
+
* `eventTime > "2012-04-23T18:25:43.511Z"
|
204
|
+
* eventTime < "2012-04-23T18:30:43.511Z"`
|
205
|
+
* * Deleting specific eventType:
|
206
|
+
* `eventType = "search"`
|
207
|
+
* * Deleting all events for a specific visitor:
|
208
|
+
* `userPseudoId = "visitor1024"`
|
209
|
+
* * Deleting all events inside a DataStore:
|
210
|
+
* `*`
|
211
|
+
*
|
212
|
+
* The filtering fields are assumed to have an implicit AND.
|
213
|
+
* @param {boolean} request.force
|
214
|
+
* The `force` field is currently not supported. Purge user event requests
|
215
|
+
* will permanently delete all purgeable events. Once the development is
|
216
|
+
* complete:
|
217
|
+
* If `force` is set to false, the method will return the expected
|
218
|
+
* purge count without deleting any user events. This field will default to
|
219
|
+
* false if not included in the request.
|
220
|
+
* @param {object} [options]
|
221
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
222
|
+
* @returns {Promise} - The promise which resolves to an array.
|
223
|
+
* The first element of the array is an object representing
|
224
|
+
* a long running operation. Its `promise()` method returns a promise
|
225
|
+
* you can `await` for.
|
226
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
227
|
+
* for more details and examples.
|
228
|
+
* @example <caption>include:samples/generated/v1alpha/user_event_service.purge_user_events.js</caption>
|
229
|
+
* region_tag:discoveryengine_v1alpha_generated_UserEventService_PurgeUserEvents_async
|
230
|
+
*/
|
231
|
+
purgeUserEvents(request?: protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsRequest, options?: CallOptions): Promise<[
|
232
|
+
LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsMetadata>,
|
233
|
+
protos.google.longrunning.IOperation | undefined,
|
234
|
+
{} | undefined
|
235
|
+
]>;
|
236
|
+
purgeUserEvents(request: protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
237
|
+
purgeUserEvents(request: protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
238
|
+
/**
|
239
|
+
* Check the status of the long running operation returned by `purgeUserEvents()`.
|
240
|
+
* @param {String} name
|
241
|
+
* The operation name that will be passed.
|
242
|
+
* @returns {Promise} - The promise which resolves to an object.
|
243
|
+
* The decoded operation object has result and metadata field to get information from.
|
244
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
245
|
+
* for more details and examples.
|
246
|
+
* @example <caption>include:samples/generated/v1alpha/user_event_service.purge_user_events.js</caption>
|
247
|
+
* region_tag:discoveryengine_v1alpha_generated_UserEventService_PurgeUserEvents_async
|
248
|
+
*/
|
249
|
+
checkPurgeUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.PurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.PurgeUserEventsMetadata>>;
|
250
|
+
/**
|
251
|
+
* Bulk import of User events. Request processing might be
|
252
|
+
* synchronous. Events that already exist are skipped.
|
253
|
+
* Use this method for backfilling historical user events.
|
254
|
+
*
|
255
|
+
* Operation.response is of type ImportResponse. Note that it is
|
256
|
+
* possible for a subset of the items to be successfully inserted.
|
257
|
+
* Operation.metadata is of type ImportMetadata.
|
258
|
+
*
|
259
|
+
* @param {Object} request
|
260
|
+
* The request object that will be sent.
|
261
|
+
* @param {google.cloud.discoveryengine.v1alpha.ImportUserEventsRequest.InlineSource} request.inlineSource
|
262
|
+
* The Inline source for the input content for UserEvents.
|
263
|
+
* @param {google.cloud.discoveryengine.v1alpha.GcsSource} request.gcsSource
|
264
|
+
* Cloud Storage location for the input content.
|
265
|
+
* @param {google.cloud.discoveryengine.v1alpha.BigQuerySource} request.bigquerySource
|
266
|
+
* BigQuery input source.
|
267
|
+
* @param {string} request.parent
|
268
|
+
* Required. Parent DataStore resource name, of the form
|
269
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
|
270
|
+
* @param {google.cloud.discoveryengine.v1alpha.ImportErrorConfig} request.errorConfig
|
271
|
+
* The desired location of errors incurred during the Import. Cannot be set
|
272
|
+
* for inline user event imports.
|
273
|
+
* @param {object} [options]
|
274
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
275
|
+
* @returns {Promise} - The promise which resolves to an array.
|
276
|
+
* The first element of the array is an object representing
|
277
|
+
* a long running operation. Its `promise()` method returns a promise
|
278
|
+
* you can `await` for.
|
279
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
280
|
+
* for more details and examples.
|
281
|
+
* @example <caption>include:samples/generated/v1alpha/user_event_service.import_user_events.js</caption>
|
282
|
+
* region_tag:discoveryengine_v1alpha_generated_UserEventService_ImportUserEvents_async
|
283
|
+
*/
|
284
|
+
importUserEvents(request?: protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsRequest, options?: CallOptions): Promise<[
|
285
|
+
LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsMetadata>,
|
286
|
+
protos.google.longrunning.IOperation | undefined,
|
287
|
+
{} | undefined
|
288
|
+
]>;
|
289
|
+
importUserEvents(request: protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
290
|
+
importUserEvents(request: protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.IImportUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
|
291
|
+
/**
|
292
|
+
* Check the status of the long running operation returned by `importUserEvents()`.
|
293
|
+
* @param {String} name
|
294
|
+
* The operation name that will be passed.
|
295
|
+
* @returns {Promise} - The promise which resolves to an object.
|
296
|
+
* The decoded operation object has result and metadata field to get information from.
|
297
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
298
|
+
* for more details and examples.
|
299
|
+
* @example <caption>include:samples/generated/v1alpha/user_event_service.import_user_events.js</caption>
|
300
|
+
* region_tag:discoveryengine_v1alpha_generated_UserEventService_ImportUserEvents_async
|
301
|
+
*/
|
302
|
+
checkImportUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.ImportUserEventsResponse, protos.google.cloud.discoveryengine.v1alpha.ImportUserEventsMetadata>>;
|
303
|
+
/**
|
304
|
+
* Gets information about a location.
|
305
|
+
*
|
306
|
+
* @param {Object} request
|
307
|
+
* The request object that will be sent.
|
308
|
+
* @param {string} request.name
|
309
|
+
* Resource name for the location.
|
310
|
+
* @param {object} [options]
|
311
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
312
|
+
* @returns {Promise} - The promise which resolves to an array.
|
313
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
314
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
315
|
+
* for more details and examples.
|
316
|
+
* @example
|
317
|
+
* ```
|
318
|
+
* const [response] = await client.getLocation(request);
|
319
|
+
* ```
|
320
|
+
*/
|
321
|
+
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>;
|
322
|
+
/**
|
323
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
324
|
+
*
|
325
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
326
|
+
* @param {Object} request
|
327
|
+
* The request object that will be sent.
|
328
|
+
* @param {string} request.name
|
329
|
+
* The resource that owns the locations collection, if applicable.
|
330
|
+
* @param {string} request.filter
|
331
|
+
* The standard list filter.
|
332
|
+
* @param {number} request.pageSize
|
333
|
+
* The standard list page size.
|
334
|
+
* @param {string} request.pageToken
|
335
|
+
* The standard list page token.
|
336
|
+
* @param {object} [options]
|
337
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
338
|
+
* @returns {Object}
|
339
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
340
|
+
* When you iterate the returned iterable, each element will be an object representing
|
341
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
342
|
+
* so you can stop the iteration when you don't need more results.
|
343
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
344
|
+
* for more details and examples.
|
345
|
+
* @example
|
346
|
+
* ```
|
347
|
+
* const iterable = client.listLocationsAsync(request);
|
348
|
+
* for await (const response of iterable) {
|
349
|
+
* // process response
|
350
|
+
* }
|
351
|
+
* ```
|
352
|
+
*/
|
353
|
+
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
354
|
+
/**
|
355
|
+
* Gets the latest state of a long-running operation. Clients can use this
|
356
|
+
* method to poll the operation result at intervals as recommended by the API
|
357
|
+
* service.
|
358
|
+
*
|
359
|
+
* @param {Object} request - The request object that will be sent.
|
360
|
+
* @param {string} request.name - The name of the operation resource.
|
361
|
+
* @param {Object=} options
|
362
|
+
* Optional parameters. You can override the default settings for this call,
|
363
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
364
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
365
|
+
* for the details.
|
366
|
+
* @param {function(?Error, ?Object)=} callback
|
367
|
+
* The function which will be called with the result of the API call.
|
368
|
+
*
|
369
|
+
* The second parameter to the callback is an object representing
|
370
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
371
|
+
* @return {Promise} - The promise which resolves to an array.
|
372
|
+
* The first element of the array is an object representing
|
373
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
374
|
+
* The promise has a method named "cancel" which cancels the ongoing API call.
|
375
|
+
*
|
376
|
+
* @example
|
377
|
+
* ```
|
378
|
+
* const client = longrunning.operationsClient();
|
379
|
+
* const name = '';
|
380
|
+
* const [response] = await client.getOperation({name});
|
381
|
+
* // doThingsWith(response)
|
382
|
+
* ```
|
383
|
+
*/
|
384
|
+
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]>;
|
385
|
+
/**
|
386
|
+
* Lists operations that match the specified filter in the request. If the
|
387
|
+
* server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
|
388
|
+
*
|
389
|
+
* For-await-of syntax is used with the iterable to recursively get response element on-demand.
|
390
|
+
*
|
391
|
+
* @param {Object} request - The request object that will be sent.
|
392
|
+
* @param {string} request.name - The name of the operation collection.
|
393
|
+
* @param {string} request.filter - The standard list filter.
|
394
|
+
* @param {number=} request.pageSize -
|
395
|
+
* The maximum number of resources contained in the underlying API
|
396
|
+
* response. If page streaming is performed per-resource, this
|
397
|
+
* parameter does not affect the return value. If page streaming is
|
398
|
+
* performed per-page, this determines the maximum number of
|
399
|
+
* resources in a page.
|
400
|
+
* @param {Object=} options
|
401
|
+
* Optional parameters. You can override the default settings for this call,
|
402
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
403
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
|
404
|
+
* details.
|
405
|
+
* @returns {Object}
|
406
|
+
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
|
407
|
+
*
|
408
|
+
* @example
|
409
|
+
* ```
|
410
|
+
* const client = longrunning.operationsClient();
|
411
|
+
* for await (const response of client.listOperationsAsync(request));
|
412
|
+
* // doThingsWith(response)
|
413
|
+
* ```
|
414
|
+
*/
|
415
|
+
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
|
416
|
+
/**
|
417
|
+
* Starts asynchronous cancellation on a long-running operation. The server
|
418
|
+
* makes a best effort to cancel the operation, but success is not
|
419
|
+
* guaranteed. If the server doesn't support this method, it returns
|
420
|
+
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
421
|
+
* {@link Operations.GetOperation} or
|
422
|
+
* other methods to check whether the cancellation succeeded or whether the
|
423
|
+
* operation completed despite cancellation. On successful cancellation,
|
424
|
+
* the operation is not deleted; instead, it becomes an operation with
|
425
|
+
* an {@link Operation.error} value with a {@link google.rpc.Status.code} of
|
426
|
+
* 1, corresponding to `Code.CANCELLED`.
|
427
|
+
*
|
428
|
+
* @param {Object} request - The request object that will be sent.
|
429
|
+
* @param {string} request.name - The name of the operation resource to be cancelled.
|
430
|
+
* @param {Object=} options
|
431
|
+
* Optional parameters. You can override the default settings for this call,
|
432
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
433
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
|
434
|
+
* details.
|
435
|
+
* @param {function(?Error)=} callback
|
436
|
+
* The function which will be called with the result of the API call.
|
437
|
+
* @return {Promise} - The promise which resolves when API call finishes.
|
438
|
+
* The promise has a method named "cancel" which cancels the ongoing API
|
439
|
+
* call.
|
440
|
+
*
|
441
|
+
* @example
|
442
|
+
* ```
|
443
|
+
* const client = longrunning.operationsClient();
|
444
|
+
* await client.cancelOperation({name: ''});
|
445
|
+
* ```
|
446
|
+
*/
|
447
|
+
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>;
|
448
|
+
/**
|
449
|
+
* Deletes a long-running operation. This method indicates that the client is
|
450
|
+
* no longer interested in the operation result. It does not cancel the
|
451
|
+
* operation. If the server doesn't support this method, it returns
|
452
|
+
* `google.rpc.Code.UNIMPLEMENTED`.
|
453
|
+
*
|
454
|
+
* @param {Object} request - The request object that will be sent.
|
455
|
+
* @param {string} request.name - The name of the operation resource to be deleted.
|
456
|
+
* @param {Object=} options
|
457
|
+
* Optional parameters. You can override the default settings for this call,
|
458
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
459
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
460
|
+
* for the details.
|
461
|
+
* @param {function(?Error)=} callback
|
462
|
+
* The function which will be called with the result of the API call.
|
463
|
+
* @return {Promise} - The promise which resolves when API call finishes.
|
464
|
+
* The promise has a method named "cancel" which cancels the ongoing API
|
465
|
+
* call.
|
466
|
+
*
|
467
|
+
* @example
|
468
|
+
* ```
|
469
|
+
* const client = longrunning.operationsClient();
|
470
|
+
* await client.deleteOperation({name: ''});
|
471
|
+
* ```
|
472
|
+
*/
|
473
|
+
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>;
|
474
|
+
/**
|
475
|
+
* Return a fully-qualified projectLocationCollectionDataStore resource name string.
|
476
|
+
*
|
477
|
+
* @param {string} project
|
478
|
+
* @param {string} location
|
479
|
+
* @param {string} collection
|
480
|
+
* @param {string} data_store
|
481
|
+
* @returns {string} Resource name string.
|
482
|
+
*/
|
483
|
+
projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
|
484
|
+
/**
|
485
|
+
* Parse the project from ProjectLocationCollectionDataStore resource.
|
486
|
+
*
|
487
|
+
* @param {string} projectLocationCollectionDataStoreName
|
488
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
489
|
+
* @returns {string} A string representing the project.
|
490
|
+
*/
|
491
|
+
matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
492
|
+
/**
|
493
|
+
* Parse the location from ProjectLocationCollectionDataStore resource.
|
494
|
+
*
|
495
|
+
* @param {string} projectLocationCollectionDataStoreName
|
496
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
497
|
+
* @returns {string} A string representing the location.
|
498
|
+
*/
|
499
|
+
matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
500
|
+
/**
|
501
|
+
* Parse the collection from ProjectLocationCollectionDataStore resource.
|
502
|
+
*
|
503
|
+
* @param {string} projectLocationCollectionDataStoreName
|
504
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
505
|
+
* @returns {string} A string representing the collection.
|
506
|
+
*/
|
507
|
+
matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
508
|
+
/**
|
509
|
+
* Parse the data_store from ProjectLocationCollectionDataStore resource.
|
510
|
+
*
|
511
|
+
* @param {string} projectLocationCollectionDataStoreName
|
512
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
513
|
+
* @returns {string} A string representing the data_store.
|
514
|
+
*/
|
515
|
+
matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
516
|
+
/**
|
517
|
+
* Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
|
518
|
+
*
|
519
|
+
* @param {string} project
|
520
|
+
* @param {string} location
|
521
|
+
* @param {string} collection
|
522
|
+
* @param {string} data_store
|
523
|
+
* @param {string} branch
|
524
|
+
* @param {string} document
|
525
|
+
* @returns {string} Resource name string.
|
526
|
+
*/
|
527
|
+
projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
|
528
|
+
/**
|
529
|
+
* Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
|
530
|
+
*
|
531
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
532
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
533
|
+
* @returns {string} A string representing the project.
|
534
|
+
*/
|
535
|
+
matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
536
|
+
/**
|
537
|
+
* Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
|
538
|
+
*
|
539
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
540
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
541
|
+
* @returns {string} A string representing the location.
|
542
|
+
*/
|
543
|
+
matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
544
|
+
/**
|
545
|
+
* Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
|
546
|
+
*
|
547
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
548
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
549
|
+
* @returns {string} A string representing the collection.
|
550
|
+
*/
|
551
|
+
matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
552
|
+
/**
|
553
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
|
554
|
+
*
|
555
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
556
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
557
|
+
* @returns {string} A string representing the data_store.
|
558
|
+
*/
|
559
|
+
matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
560
|
+
/**
|
561
|
+
* Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
|
562
|
+
*
|
563
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
564
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
565
|
+
* @returns {string} A string representing the branch.
|
566
|
+
*/
|
567
|
+
matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
568
|
+
/**
|
569
|
+
* Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
|
570
|
+
*
|
571
|
+
* @param {string} projectLocationCollectionDataStoreBranchDocumentName
|
572
|
+
* A fully-qualified path representing project_location_collection_data_store_branch_document resource.
|
573
|
+
* @returns {string} A string representing the document.
|
574
|
+
*/
|
575
|
+
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
576
|
+
/**
|
577
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
578
|
+
*
|
579
|
+
* @param {string} project
|
580
|
+
* @param {string} location
|
581
|
+
* @param {string} collection
|
582
|
+
* @param {string} data_store
|
583
|
+
* @param {string} conversation
|
584
|
+
* @returns {string} Resource name string.
|
585
|
+
*/
|
586
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
587
|
+
/**
|
588
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
589
|
+
*
|
590
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
591
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
592
|
+
* @returns {string} A string representing the project.
|
593
|
+
*/
|
594
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
595
|
+
/**
|
596
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
597
|
+
*
|
598
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
599
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
600
|
+
* @returns {string} A string representing the location.
|
601
|
+
*/
|
602
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
603
|
+
/**
|
604
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
605
|
+
*
|
606
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
607
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
608
|
+
* @returns {string} A string representing the collection.
|
609
|
+
*/
|
610
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
611
|
+
/**
|
612
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
613
|
+
*
|
614
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
615
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
616
|
+
* @returns {string} A string representing the data_store.
|
617
|
+
*/
|
618
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
619
|
+
/**
|
620
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
621
|
+
*
|
622
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
623
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
624
|
+
* @returns {string} A string representing the conversation.
|
625
|
+
*/
|
626
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
627
|
+
/**
|
628
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
629
|
+
*
|
630
|
+
* @param {string} project
|
631
|
+
* @param {string} location
|
632
|
+
* @param {string} collection
|
633
|
+
* @param {string} data_store
|
634
|
+
* @param {string} schema
|
635
|
+
* @returns {string} Resource name string.
|
636
|
+
*/
|
637
|
+
projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
|
638
|
+
/**
|
639
|
+
* Parse the project from ProjectLocationCollectionDataStoreSchema resource.
|
640
|
+
*
|
641
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
642
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
643
|
+
* @returns {string} A string representing the project.
|
644
|
+
*/
|
645
|
+
matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
646
|
+
/**
|
647
|
+
* Parse the location from ProjectLocationCollectionDataStoreSchema resource.
|
648
|
+
*
|
649
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
650
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
651
|
+
* @returns {string} A string representing the location.
|
652
|
+
*/
|
653
|
+
matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
654
|
+
/**
|
655
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
|
656
|
+
*
|
657
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
658
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
659
|
+
* @returns {string} A string representing the collection.
|
660
|
+
*/
|
661
|
+
matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
662
|
+
/**
|
663
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
|
664
|
+
*
|
665
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
666
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
667
|
+
* @returns {string} A string representing the data_store.
|
668
|
+
*/
|
669
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
670
|
+
/**
|
671
|
+
* Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
|
672
|
+
*
|
673
|
+
* @param {string} projectLocationCollectionDataStoreSchemaName
|
674
|
+
* A fully-qualified path representing project_location_collection_data_store_schema resource.
|
675
|
+
* @returns {string} A string representing the schema.
|
676
|
+
*/
|
677
|
+
matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
|
678
|
+
/**
|
679
|
+
* Return a fully-qualified projectLocationDataStore resource name string.
|
680
|
+
*
|
681
|
+
* @param {string} project
|
682
|
+
* @param {string} location
|
683
|
+
* @param {string} data_store
|
684
|
+
* @returns {string} Resource name string.
|
685
|
+
*/
|
686
|
+
projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
|
687
|
+
/**
|
688
|
+
* Parse the project from ProjectLocationDataStore resource.
|
689
|
+
*
|
690
|
+
* @param {string} projectLocationDataStoreName
|
691
|
+
* A fully-qualified path representing project_location_data_store resource.
|
692
|
+
* @returns {string} A string representing the project.
|
693
|
+
*/
|
694
|
+
matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
695
|
+
/**
|
696
|
+
* Parse the location from ProjectLocationDataStore resource.
|
697
|
+
*
|
698
|
+
* @param {string} projectLocationDataStoreName
|
699
|
+
* A fully-qualified path representing project_location_data_store resource.
|
700
|
+
* @returns {string} A string representing the location.
|
701
|
+
*/
|
702
|
+
matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
703
|
+
/**
|
704
|
+
* Parse the data_store from ProjectLocationDataStore resource.
|
705
|
+
*
|
706
|
+
* @param {string} projectLocationDataStoreName
|
707
|
+
* A fully-qualified path representing project_location_data_store resource.
|
708
|
+
* @returns {string} A string representing the data_store.
|
709
|
+
*/
|
710
|
+
matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
711
|
+
/**
|
712
|
+
* Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
|
713
|
+
*
|
714
|
+
* @param {string} project
|
715
|
+
* @param {string} location
|
716
|
+
* @param {string} data_store
|
717
|
+
* @param {string} branch
|
718
|
+
* @param {string} document
|
719
|
+
* @returns {string} Resource name string.
|
720
|
+
*/
|
721
|
+
projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
|
722
|
+
/**
|
723
|
+
* Parse the project from ProjectLocationDataStoreBranchDocument resource.
|
724
|
+
*
|
725
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
726
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
727
|
+
* @returns {string} A string representing the project.
|
728
|
+
*/
|
729
|
+
matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
730
|
+
/**
|
731
|
+
* Parse the location from ProjectLocationDataStoreBranchDocument resource.
|
732
|
+
*
|
733
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
734
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
735
|
+
* @returns {string} A string representing the location.
|
736
|
+
*/
|
737
|
+
matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
738
|
+
/**
|
739
|
+
* Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
|
740
|
+
*
|
741
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
742
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
743
|
+
* @returns {string} A string representing the data_store.
|
744
|
+
*/
|
745
|
+
matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
746
|
+
/**
|
747
|
+
* Parse the branch from ProjectLocationDataStoreBranchDocument resource.
|
748
|
+
*
|
749
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
750
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
751
|
+
* @returns {string} A string representing the branch.
|
752
|
+
*/
|
753
|
+
matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
754
|
+
/**
|
755
|
+
* Parse the document from ProjectLocationDataStoreBranchDocument resource.
|
756
|
+
*
|
757
|
+
* @param {string} projectLocationDataStoreBranchDocumentName
|
758
|
+
* A fully-qualified path representing project_location_data_store_branch_document resource.
|
759
|
+
* @returns {string} A string representing the document.
|
760
|
+
*/
|
761
|
+
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
762
|
+
/**
|
763
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
764
|
+
*
|
765
|
+
* @param {string} project
|
766
|
+
* @param {string} location
|
767
|
+
* @param {string} data_store
|
768
|
+
* @param {string} conversation
|
769
|
+
* @returns {string} Resource name string.
|
770
|
+
*/
|
771
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
772
|
+
/**
|
773
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
774
|
+
*
|
775
|
+
* @param {string} projectLocationDataStoreConversationName
|
776
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
777
|
+
* @returns {string} A string representing the project.
|
778
|
+
*/
|
779
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
780
|
+
/**
|
781
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
782
|
+
*
|
783
|
+
* @param {string} projectLocationDataStoreConversationName
|
784
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
785
|
+
* @returns {string} A string representing the location.
|
786
|
+
*/
|
787
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
788
|
+
/**
|
789
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
790
|
+
*
|
791
|
+
* @param {string} projectLocationDataStoreConversationName
|
792
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
793
|
+
* @returns {string} A string representing the data_store.
|
794
|
+
*/
|
795
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
796
|
+
/**
|
797
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
798
|
+
*
|
799
|
+
* @param {string} projectLocationDataStoreConversationName
|
800
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
801
|
+
* @returns {string} A string representing the conversation.
|
802
|
+
*/
|
803
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
804
|
+
/**
|
805
|
+
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
806
|
+
*
|
807
|
+
* @param {string} project
|
808
|
+
* @param {string} location
|
809
|
+
* @param {string} data_store
|
810
|
+
* @param {string} schema
|
811
|
+
* @returns {string} Resource name string.
|
812
|
+
*/
|
813
|
+
projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
|
814
|
+
/**
|
815
|
+
* Parse the project from ProjectLocationDataStoreSchema resource.
|
816
|
+
*
|
817
|
+
* @param {string} projectLocationDataStoreSchemaName
|
818
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
819
|
+
* @returns {string} A string representing the project.
|
820
|
+
*/
|
821
|
+
matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
822
|
+
/**
|
823
|
+
* Parse the location from ProjectLocationDataStoreSchema resource.
|
824
|
+
*
|
825
|
+
* @param {string} projectLocationDataStoreSchemaName
|
826
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
827
|
+
* @returns {string} A string representing the location.
|
828
|
+
*/
|
829
|
+
matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
830
|
+
/**
|
831
|
+
* Parse the data_store from ProjectLocationDataStoreSchema resource.
|
832
|
+
*
|
833
|
+
* @param {string} projectLocationDataStoreSchemaName
|
834
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
835
|
+
* @returns {string} A string representing the data_store.
|
836
|
+
*/
|
837
|
+
matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
838
|
+
/**
|
839
|
+
* Parse the schema from ProjectLocationDataStoreSchema resource.
|
840
|
+
*
|
841
|
+
* @param {string} projectLocationDataStoreSchemaName
|
842
|
+
* A fully-qualified path representing project_location_data_store_schema resource.
|
843
|
+
* @returns {string} A string representing the schema.
|
844
|
+
*/
|
845
|
+
matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
|
846
|
+
/**
|
847
|
+
* Terminate the gRPC channel and close the client.
|
848
|
+
*
|
849
|
+
* The client will no longer be usable and all future behavior is undefined.
|
850
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
851
|
+
*/
|
852
|
+
close(): Promise<void>;
|
853
|
+
}
|