@maxim_mazurok/gapi.client.cloudsearch-v1 0.2.20250106 → 0.2.20260114
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.
- package/index.d.ts +25 -79
- package/package.json +1 -1
- package/readme.md +5 -10
package/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/* Type definitions for non-npm package Cloud Search API v1 0.0 */
|
|
2
|
-
// Project: https://developers.google.com/cloud-search/docs/guides/
|
|
2
|
+
// Project: https://developers.google.com/workspace/cloud-search/docs/guides/
|
|
3
3
|
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
4
|
// Nick Amoscato <https://github.com/namoscato>
|
|
5
5
|
// Declan Vong <https://github.com/declanvong>
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://cloudsearch.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260114
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -202,14 +202,6 @@ declare namespace gapi.client {
|
|
|
202
202
|
/** If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */
|
|
203
203
|
enableDebugging?: boolean;
|
|
204
204
|
}
|
|
205
|
-
interface DebugResponse {
|
|
206
|
-
/** Serialized string of GenericSearchRequest. */
|
|
207
|
-
gsrRequest?: string;
|
|
208
|
-
/** Serialized string of GenericSearchResponse. */
|
|
209
|
-
gsrResponse?: string;
|
|
210
|
-
/** Search response. */
|
|
211
|
-
searchResponse?: SearchResponse;
|
|
212
|
-
}
|
|
213
205
|
interface DeleteQueueItemsRequest {
|
|
214
206
|
/** The name of connector making this call. Format: datasources/{source_id}/connectors/{ID} */
|
|
215
207
|
connectorName?: string;
|
|
@@ -974,7 +966,7 @@ declare namespace gapi.client {
|
|
|
974
966
|
status?: ItemStatus;
|
|
975
967
|
/** The structured data for the item that should conform to a registered object definition in the schema for the data source. */
|
|
976
968
|
structuredData?: ItemStructuredData;
|
|
977
|
-
/** Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). */
|
|
969
|
+
/** Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations). */
|
|
978
970
|
version?: string;
|
|
979
971
|
}
|
|
980
972
|
interface ItemAcl {
|
|
@@ -1068,6 +1060,8 @@ declare namespace gapi.client {
|
|
|
1068
1060
|
nextPageToken?: string;
|
|
1069
1061
|
/** A list of operations that matches the specified filter in the request. */
|
|
1070
1062
|
operations?: Operation[];
|
|
1063
|
+
/** Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */
|
|
1064
|
+
unreachable?: string[];
|
|
1071
1065
|
}
|
|
1072
1066
|
interface ListQuerySourcesResponse {
|
|
1073
1067
|
nextPageToken?: string;
|
|
@@ -1345,7 +1339,7 @@ declare namespace gapi.client {
|
|
|
1345
1339
|
isSortable?: boolean;
|
|
1346
1340
|
/** Indicates that the property can be used for generating query suggestions. */
|
|
1347
1341
|
isSuggestable?: boolean;
|
|
1348
|
-
/** Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/cloud-search/docs/guides/schema-guide#properties) */
|
|
1342
|
+
/** Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/workspace/cloud-search/docs/guides/schema-guide#properties) */
|
|
1349
1343
|
isWildcardSearchable?: boolean;
|
|
1350
1344
|
/** The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters. */
|
|
1351
1345
|
name?: string;
|
|
@@ -1394,6 +1388,10 @@ declare namespace gapi.client {
|
|
|
1394
1388
|
interpretationType?: string;
|
|
1395
1389
|
/** The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY. */
|
|
1396
1390
|
interpretedQuery?: string;
|
|
1391
|
+
/** The actual number of results returned by the interpreted query. */
|
|
1392
|
+
interpretedQueryActualResultCount?: number;
|
|
1393
|
+
/** The estimated number of results returned by the interpreted query. */
|
|
1394
|
+
interpretedQueryEstimatedResultCount?: string;
|
|
1397
1395
|
/** The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE. */
|
|
1398
1396
|
reason?: string;
|
|
1399
1397
|
}
|
|
@@ -1823,7 +1821,7 @@ declare namespace gapi.client {
|
|
|
1823
1821
|
/** Common debug options. */
|
|
1824
1822
|
debugOptions?: DebugOptions;
|
|
1825
1823
|
source?: DataSource;
|
|
1826
|
-
/** Only applies to [`settings.datasources.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
1824
|
+
/** Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
1827
1825
|
updateMask?: string;
|
|
1828
1826
|
}
|
|
1829
1827
|
interface UpdateSchemaRequest {
|
|
@@ -2136,7 +2134,7 @@ declare namespace gapi.client {
|
|
|
2136
2134
|
upload_protocol?: string;
|
|
2137
2135
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2138
2136
|
uploadType?: string;
|
|
2139
|
-
/** Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). */
|
|
2137
|
+
/** Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/workspace/cloud-search/docs/guides/operations). */
|
|
2140
2138
|
version?: string;
|
|
2141
2139
|
}): Request<Operation>;
|
|
2142
2140
|
/** Deletes all items in a queue. This method is useful for deleting stale items. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. */
|
|
@@ -2679,7 +2677,7 @@ declare namespace gapi.client {
|
|
|
2679
2677
|
datasources: DatasourcesResource;
|
|
2680
2678
|
}
|
|
2681
2679
|
interface MediaResource {
|
|
2682
|
-
/** Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute. */
|
|
2680
|
+
/** Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/workspace/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute. */
|
|
2683
2681
|
upload(request: {
|
|
2684
2682
|
/** V1 error format. */
|
|
2685
2683
|
'$.xgafv'?: string;
|
|
@@ -2767,6 +2765,8 @@ declare namespace gapi.client {
|
|
|
2767
2765
|
prettyPrint?: boolean;
|
|
2768
2766
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2769
2767
|
quotaUser?: string;
|
|
2768
|
+
/** When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */
|
|
2769
|
+
returnPartialSuccess?: boolean;
|
|
2770
2770
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2771
2771
|
upload_protocol?: string;
|
|
2772
2772
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2804,7 +2804,7 @@ declare namespace gapi.client {
|
|
|
2804
2804
|
lro: LroResource;
|
|
2805
2805
|
}
|
|
2806
2806
|
interface SourcesResource {
|
|
2807
|
-
/** Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). */
|
|
2807
|
+
/** Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/). */
|
|
2808
2808
|
list(request?: {
|
|
2809
2809
|
/** V1 error format. */
|
|
2810
2810
|
'$.xgafv'?: string;
|
|
@@ -2841,61 +2841,7 @@ declare namespace gapi.client {
|
|
|
2841
2841
|
}): Request<ListQuerySourcesResponse>;
|
|
2842
2842
|
}
|
|
2843
2843
|
interface QueryResource {
|
|
2844
|
-
/**
|
|
2845
|
-
debugSearch(request: {
|
|
2846
|
-
/** V1 error format. */
|
|
2847
|
-
'$.xgafv'?: string;
|
|
2848
|
-
/** OAuth access token. */
|
|
2849
|
-
access_token?: string;
|
|
2850
|
-
/** Data format for response. */
|
|
2851
|
-
alt?: string;
|
|
2852
|
-
/** JSONP */
|
|
2853
|
-
callback?: string;
|
|
2854
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
2855
|
-
fields?: string;
|
|
2856
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2857
|
-
key?: string;
|
|
2858
|
-
/** OAuth 2.0 token for the current user. */
|
|
2859
|
-
oauth_token?: string;
|
|
2860
|
-
/** Returns response with indentations and line breaks. */
|
|
2861
|
-
prettyPrint?: boolean;
|
|
2862
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2863
|
-
quotaUser?: string;
|
|
2864
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2865
|
-
upload_protocol?: string;
|
|
2866
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2867
|
-
uploadType?: string;
|
|
2868
|
-
/** Request body */
|
|
2869
|
-
resource: SearchRequest;
|
|
2870
|
-
}): Request<DebugResponse>;
|
|
2871
|
-
debugSearch(
|
|
2872
|
-
request: {
|
|
2873
|
-
/** V1 error format. */
|
|
2874
|
-
'$.xgafv'?: string;
|
|
2875
|
-
/** OAuth access token. */
|
|
2876
|
-
access_token?: string;
|
|
2877
|
-
/** Data format for response. */
|
|
2878
|
-
alt?: string;
|
|
2879
|
-
/** JSONP */
|
|
2880
|
-
callback?: string;
|
|
2881
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
2882
|
-
fields?: string;
|
|
2883
|
-
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2884
|
-
key?: string;
|
|
2885
|
-
/** OAuth 2.0 token for the current user. */
|
|
2886
|
-
oauth_token?: string;
|
|
2887
|
-
/** Returns response with indentations and line breaks. */
|
|
2888
|
-
prettyPrint?: boolean;
|
|
2889
|
-
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2890
|
-
quotaUser?: string;
|
|
2891
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2892
|
-
upload_protocol?: string;
|
|
2893
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2894
|
-
uploadType?: string;
|
|
2895
|
-
},
|
|
2896
|
-
body: SearchRequest,
|
|
2897
|
-
): Request<DebugResponse>;
|
|
2898
|
-
/** Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). */
|
|
2844
|
+
/** Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/). */
|
|
2899
2845
|
removeActivity(request: {
|
|
2900
2846
|
/** V1 error format. */
|
|
2901
2847
|
'$.xgafv'?: string;
|
|
@@ -2949,7 +2895,7 @@ declare namespace gapi.client {
|
|
|
2949
2895
|
},
|
|
2950
2896
|
body: RemoveActivityRequest,
|
|
2951
2897
|
): Request<{}>;
|
|
2952
|
-
/** The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). */
|
|
2898
|
+
/** The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/). */
|
|
2953
2899
|
search(request: {
|
|
2954
2900
|
/** V1 error format. */
|
|
2955
2901
|
'$.xgafv'?: string;
|
|
@@ -3003,7 +2949,7 @@ declare namespace gapi.client {
|
|
|
3003
2949
|
},
|
|
3004
2950
|
body: SearchRequest,
|
|
3005
2951
|
): Request<SearchResponse>;
|
|
3006
|
-
/** Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). */
|
|
2952
|
+
/** Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/). */
|
|
3007
2953
|
suggest(request: {
|
|
3008
2954
|
/** V1 error format. */
|
|
3009
2955
|
'$.xgafv'?: string;
|
|
@@ -3227,7 +3173,7 @@ declare namespace gapi.client {
|
|
|
3227
3173
|
prettyPrint?: boolean;
|
|
3228
3174
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3229
3175
|
quotaUser?: string;
|
|
3230
|
-
/** Only applies to [`settings.datasources.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3176
|
+
/** Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3231
3177
|
updateMask?: string;
|
|
3232
3178
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3233
3179
|
upload_protocol?: string;
|
|
@@ -3260,7 +3206,7 @@ declare namespace gapi.client {
|
|
|
3260
3206
|
prettyPrint?: boolean;
|
|
3261
3207
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3262
3208
|
quotaUser?: string;
|
|
3263
|
-
/** Only applies to [`settings.datasources.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3209
|
+
/** Only applies to [`settings.datasources.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3264
3210
|
updateMask?: string;
|
|
3265
3211
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3266
3212
|
upload_protocol?: string;
|
|
@@ -3494,7 +3440,7 @@ declare namespace gapi.client {
|
|
|
3494
3440
|
prettyPrint?: boolean;
|
|
3495
3441
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3496
3442
|
quotaUser?: string;
|
|
3497
|
-
/** Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3443
|
+
/** Only applies to [`settings.searchapplications.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3498
3444
|
updateMask?: string;
|
|
3499
3445
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3500
3446
|
upload_protocol?: string;
|
|
@@ -3525,7 +3471,7 @@ declare namespace gapi.client {
|
|
|
3525
3471
|
prettyPrint?: boolean;
|
|
3526
3472
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3527
3473
|
quotaUser?: string;
|
|
3528
|
-
/** Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3474
|
+
/** Only applies to [`settings.searchapplications.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3529
3475
|
updateMask?: string;
|
|
3530
3476
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3531
3477
|
upload_protocol?: string;
|
|
@@ -3614,7 +3560,7 @@ declare namespace gapi.client {
|
|
|
3614
3560
|
prettyPrint?: boolean;
|
|
3615
3561
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3616
3562
|
quotaUser?: string;
|
|
3617
|
-
/** Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3563
|
+
/** Only applies to [`settings.searchapplications.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3618
3564
|
updateMask?: string;
|
|
3619
3565
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3620
3566
|
upload_protocol?: string;
|
|
@@ -3645,7 +3591,7 @@ declare namespace gapi.client {
|
|
|
3645
3591
|
prettyPrint?: boolean;
|
|
3646
3592
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
3647
3593
|
quotaUser?: string;
|
|
3648
|
-
/** Only applies to [`settings.searchapplications.patch`](https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3594
|
+
/** Only applies to [`settings.searchapplications.patch`](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated. */
|
|
3649
3595
|
updateMask?: string;
|
|
3650
3596
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3651
3597
|
upload_protocol?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# TypeScript typings for Cloud Search API v1
|
|
2
2
|
|
|
3
3
|
Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.
|
|
4
|
-
For detailed description please check [documentation](https://developers.google.com/cloud-search/docs/guides/).
|
|
4
|
+
For detailed description please check [documentation](https://developers.google.com/workspace/cloud-search/docs/guides/).
|
|
5
5
|
|
|
6
6
|
## Installing
|
|
7
7
|
|
|
@@ -94,7 +94,7 @@ After that you can use Cloud Search API resources: <!-- TODO: make this work for
|
|
|
94
94
|
|
|
95
95
|
```typescript
|
|
96
96
|
/*
|
|
97
|
-
Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.
|
|
97
|
+
Uploads media for indexing. The upload endpoint supports direct and resumable upload protocols and is intended for large items that can not be [inlined during index requests](https://developers.google.com/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. For additional information, see [Create a content connector using the REST API](https://developers.google.com/workspace/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.
|
|
98
98
|
*/
|
|
99
99
|
await gapi.client.cloudsearch.media.upload({resourceName: 'resourceName'});
|
|
100
100
|
|
|
@@ -104,22 +104,17 @@ Gets the latest state of a long-running operation. Clients can use this method t
|
|
|
104
104
|
await gapi.client.cloudsearch.operations.get({name: 'name'});
|
|
105
105
|
|
|
106
106
|
/*
|
|
107
|
-
|
|
108
|
-
*/
|
|
109
|
-
await gapi.client.cloudsearch.query.debugSearch({});
|
|
110
|
-
|
|
111
|
-
/*
|
|
112
|
-
Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
|
|
107
|
+
Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).
|
|
113
108
|
*/
|
|
114
109
|
await gapi.client.cloudsearch.query.removeActivity({});
|
|
115
110
|
|
|
116
111
|
/*
|
|
117
|
-
The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
|
|
112
|
+
The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).
|
|
118
113
|
*/
|
|
119
114
|
await gapi.client.cloudsearch.query.search({});
|
|
120
115
|
|
|
121
116
|
/*
|
|
122
|
-
Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
|
|
117
|
+
Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/workspace/cloud-search/docs/guides/delegation/).
|
|
123
118
|
*/
|
|
124
119
|
await gapi.client.cloudsearch.query.suggest({});
|
|
125
120
|
|