@maxim_mazurok/gapi.client.cloudsearch-v1 0.2.20250106 → 0.2.20260107
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 +26 -18
- package/package.json +1 -1
- package/readme.md +6 -6
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: 20260107
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -974,7 +974,7 @@ declare namespace gapi.client {
|
|
|
974
974
|
status?: ItemStatus;
|
|
975
975
|
/** The structured data for the item that should conform to a registered object definition in the schema for the data source. */
|
|
976
976
|
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). */
|
|
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/workspace/cloud-search/docs/guides/operations). */
|
|
978
978
|
version?: string;
|
|
979
979
|
}
|
|
980
980
|
interface ItemAcl {
|
|
@@ -1068,6 +1068,8 @@ declare namespace gapi.client {
|
|
|
1068
1068
|
nextPageToken?: string;
|
|
1069
1069
|
/** A list of operations that matches the specified filter in the request. */
|
|
1070
1070
|
operations?: Operation[];
|
|
1071
|
+
/** 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. */
|
|
1072
|
+
unreachable?: string[];
|
|
1071
1073
|
}
|
|
1072
1074
|
interface ListQuerySourcesResponse {
|
|
1073
1075
|
nextPageToken?: string;
|
|
@@ -1345,7 +1347,7 @@ declare namespace gapi.client {
|
|
|
1345
1347
|
isSortable?: boolean;
|
|
1346
1348
|
/** Indicates that the property can be used for generating query suggestions. */
|
|
1347
1349
|
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) */
|
|
1350
|
+
/** 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
1351
|
isWildcardSearchable?: boolean;
|
|
1350
1352
|
/** 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
1353
|
name?: string;
|
|
@@ -1394,6 +1396,10 @@ declare namespace gapi.client {
|
|
|
1394
1396
|
interpretationType?: string;
|
|
1395
1397
|
/** 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
1398
|
interpretedQuery?: string;
|
|
1399
|
+
/** The actual number of results returned by the interpreted query. */
|
|
1400
|
+
interpretedQueryActualResultCount?: number;
|
|
1401
|
+
/** The estimated number of results returned by the interpreted query. */
|
|
1402
|
+
interpretedQueryEstimatedResultCount?: string;
|
|
1397
1403
|
/** The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE. */
|
|
1398
1404
|
reason?: string;
|
|
1399
1405
|
}
|
|
@@ -1823,7 +1829,7 @@ declare namespace gapi.client {
|
|
|
1823
1829
|
/** Common debug options. */
|
|
1824
1830
|
debugOptions?: DebugOptions;
|
|
1825
1831
|
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. */
|
|
1832
|
+
/** 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
1833
|
updateMask?: string;
|
|
1828
1834
|
}
|
|
1829
1835
|
interface UpdateSchemaRequest {
|
|
@@ -2136,7 +2142,7 @@ declare namespace gapi.client {
|
|
|
2136
2142
|
upload_protocol?: string;
|
|
2137
2143
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2138
2144
|
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). */
|
|
2145
|
+
/** 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
2146
|
version?: string;
|
|
2141
2147
|
}): Request<Operation>;
|
|
2142
2148
|
/** 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 +2685,7 @@ declare namespace gapi.client {
|
|
|
2679
2685
|
datasources: DatasourcesResource;
|
|
2680
2686
|
}
|
|
2681
2687
|
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. */
|
|
2688
|
+
/** 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
2689
|
upload(request: {
|
|
2684
2690
|
/** V1 error format. */
|
|
2685
2691
|
'$.xgafv'?: string;
|
|
@@ -2767,6 +2773,8 @@ declare namespace gapi.client {
|
|
|
2767
2773
|
prettyPrint?: boolean;
|
|
2768
2774
|
/** 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
2775
|
quotaUser?: string;
|
|
2776
|
+
/** 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. */
|
|
2777
|
+
returnPartialSuccess?: boolean;
|
|
2770
2778
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2771
2779
|
upload_protocol?: string;
|
|
2772
2780
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -2804,7 +2812,7 @@ declare namespace gapi.client {
|
|
|
2804
2812
|
lro: LroResource;
|
|
2805
2813
|
}
|
|
2806
2814
|
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/). */
|
|
2815
|
+
/** 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
2816
|
list(request?: {
|
|
2809
2817
|
/** V1 error format. */
|
|
2810
2818
|
'$.xgafv'?: string;
|
|
@@ -2841,7 +2849,7 @@ declare namespace gapi.client {
|
|
|
2841
2849
|
}): Request<ListQuerySourcesResponse>;
|
|
2842
2850
|
}
|
|
2843
2851
|
interface QueryResource {
|
|
2844
|
-
/** Returns Debug information for Cloud Search Query API provides the search method. **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/). */
|
|
2852
|
+
/** Returns Debug information for Cloud Search Query API provides the search method. **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/). */
|
|
2845
2853
|
debugSearch(request: {
|
|
2846
2854
|
/** V1 error format. */
|
|
2847
2855
|
'$.xgafv'?: string;
|
|
@@ -2895,7 +2903,7 @@ declare namespace gapi.client {
|
|
|
2895
2903
|
},
|
|
2896
2904
|
body: SearchRequest,
|
|
2897
2905
|
): 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/). */
|
|
2906
|
+
/** 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
2907
|
removeActivity(request: {
|
|
2900
2908
|
/** V1 error format. */
|
|
2901
2909
|
'$.xgafv'?: string;
|
|
@@ -2949,7 +2957,7 @@ declare namespace gapi.client {
|
|
|
2949
2957
|
},
|
|
2950
2958
|
body: RemoveActivityRequest,
|
|
2951
2959
|
): 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/). */
|
|
2960
|
+
/** 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
2961
|
search(request: {
|
|
2954
2962
|
/** V1 error format. */
|
|
2955
2963
|
'$.xgafv'?: string;
|
|
@@ -3003,7 +3011,7 @@ declare namespace gapi.client {
|
|
|
3003
3011
|
},
|
|
3004
3012
|
body: SearchRequest,
|
|
3005
3013
|
): 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/). */
|
|
3014
|
+
/** 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
3015
|
suggest(request: {
|
|
3008
3016
|
/** V1 error format. */
|
|
3009
3017
|
'$.xgafv'?: string;
|
|
@@ -3227,7 +3235,7 @@ declare namespace gapi.client {
|
|
|
3227
3235
|
prettyPrint?: boolean;
|
|
3228
3236
|
/** 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
3237
|
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. */
|
|
3238
|
+
/** 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
3239
|
updateMask?: string;
|
|
3232
3240
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3233
3241
|
upload_protocol?: string;
|
|
@@ -3260,7 +3268,7 @@ declare namespace gapi.client {
|
|
|
3260
3268
|
prettyPrint?: boolean;
|
|
3261
3269
|
/** 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
3270
|
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. */
|
|
3271
|
+
/** 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
3272
|
updateMask?: string;
|
|
3265
3273
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3266
3274
|
upload_protocol?: string;
|
|
@@ -3494,7 +3502,7 @@ declare namespace gapi.client {
|
|
|
3494
3502
|
prettyPrint?: boolean;
|
|
3495
3503
|
/** 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
3504
|
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. */
|
|
3505
|
+
/** 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
3506
|
updateMask?: string;
|
|
3499
3507
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3500
3508
|
upload_protocol?: string;
|
|
@@ -3525,7 +3533,7 @@ declare namespace gapi.client {
|
|
|
3525
3533
|
prettyPrint?: boolean;
|
|
3526
3534
|
/** 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
3535
|
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. */
|
|
3536
|
+
/** 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
3537
|
updateMask?: string;
|
|
3530
3538
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3531
3539
|
upload_protocol?: string;
|
|
@@ -3614,7 +3622,7 @@ declare namespace gapi.client {
|
|
|
3614
3622
|
prettyPrint?: boolean;
|
|
3615
3623
|
/** 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
3624
|
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. */
|
|
3625
|
+
/** 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
3626
|
updateMask?: string;
|
|
3619
3627
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3620
3628
|
upload_protocol?: string;
|
|
@@ -3645,7 +3653,7 @@ declare namespace gapi.client {
|
|
|
3645
3653
|
prettyPrint?: boolean;
|
|
3646
3654
|
/** 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
3655
|
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. */
|
|
3656
|
+
/** 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
3657
|
updateMask?: string;
|
|
3650
3658
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3651
3659
|
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,22 @@ 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
|
-
Returns Debug information for Cloud Search Query API provides the search method. **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/).
|
|
107
|
+
Returns Debug information for Cloud Search Query API provides the search method. **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/).
|
|
108
108
|
*/
|
|
109
109
|
await gapi.client.cloudsearch.query.debugSearch({});
|
|
110
110
|
|
|
111
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/).
|
|
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/workspace/cloud-search/docs/guides/delegation/).
|
|
113
113
|
*/
|
|
114
114
|
await gapi.client.cloudsearch.query.removeActivity({});
|
|
115
115
|
|
|
116
116
|
/*
|
|
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/).
|
|
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/workspace/cloud-search/docs/guides/delegation/).
|
|
118
118
|
*/
|
|
119
119
|
await gapi.client.cloudsearch.query.search({});
|
|
120
120
|
|
|
121
121
|
/*
|
|
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/).
|
|
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/workspace/cloud-search/docs/guides/delegation/).
|
|
123
123
|
*/
|
|
124
124
|
await gapi.client.cloudsearch.query.suggest({});
|
|
125
125
|
|