Show / Hide Table of Contents

Namespace Google.Apis.CloudSearch.v1

Classes

CloudSearchBaseServiceRequest<TResponse>

A base abstract class for CloudSearch requests.

CloudSearchService

The CloudSearch Service.

CloudSearchService.Scope

Available OAuth 2.0 scopes for use with the Cloud Search API.

CloudSearchService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Cloud Search API.

DebugResource

The "debug" collection of methods.

DebugResource.DatasourcesResource

The "datasources" collection of methods.

DebugResource.DatasourcesResource.ItemsResource

The "items" collection of methods.

DebugResource.DatasourcesResource.ItemsResource.CheckAccessRequest

Checks whether an item is accessible by specified principal. Principal must be a user; groups and domain values aren't supported. Note: This API requires an admin account to execute.

DebugResource.DatasourcesResource.ItemsResource.SearchByViewUrlRequest

Fetches the item whose viewUrl exactly matches that of the URL provided in the request. Note: This API requires an admin account to execute.

DebugResource.DatasourcesResource.ItemsResource.UnmappedidsResource

The "unmappedids" collection of methods.

DebugResource.DatasourcesResource.ItemsResource.UnmappedidsResource.ListRequest

List all unmapped identities for a specific item. Note: This API requires an admin account to execute.

DebugResource.IdentitysourcesResource

The "identitysources" collection of methods.

DebugResource.IdentitysourcesResource.ItemsResource

The "items" collection of methods.

DebugResource.IdentitysourcesResource.ItemsResource.ListForunmappedidentityRequest

Lists names of items associated with an unmapped identity. Note: This API requires an admin account to execute.

DebugResource.IdentitysourcesResource.UnmappedidsResource

The "unmappedids" collection of methods.

DebugResource.IdentitysourcesResource.UnmappedidsResource.ListRequest

Lists unmapped user identities for an identity source. Note: This API requires an admin account to execute.

IndexingResource

The "indexing" collection of methods.

IndexingResource.DatasourcesResource

The "datasources" collection of methods.

IndexingResource.DatasourcesResource.DeleteSchemaRequest

Deletes the schema of a data source. Note: This API requires an admin or service account to execute.

IndexingResource.DatasourcesResource.GetSchemaRequest

Gets the schema of a data source. Note: This API requires an admin or service account to execute.

IndexingResource.DatasourcesResource.ItemsResource

The "items" collection of methods.

IndexingResource.DatasourcesResource.ItemsResource.DeleteQueueItemsRequest

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.

IndexingResource.DatasourcesResource.ItemsResource.DeleteRequest

Deletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

IndexingResource.DatasourcesResource.ItemsResource.GetRequest

Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

IndexingResource.DatasourcesResource.ItemsResource.IndexRequest

Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

IndexingResource.DatasourcesResource.ItemsResource.ListRequest

Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

IndexingResource.DatasourcesResource.ItemsResource.PollRequest

Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

IndexingResource.DatasourcesResource.ItemsResource.PushRequest

Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

IndexingResource.DatasourcesResource.ItemsResource.UnreserveRequest

Unreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been restarted. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

IndexingResource.DatasourcesResource.ItemsResource.UploadRequest

Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

IndexingResource.DatasourcesResource.UpdateSchemaRequest

Updates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the entire schema. Note: This API requires an admin or service account to execute.

MediaResource

The "media" collection of methods.

MediaResource.UploadMediaUpload

Upload media upload which supports resumable upload.

MediaResource.UploadRequest

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. 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 with the UploadItemRef from step 1. For additional information, see Create a content connector using the REST API. Note: This API requires a service account to execute.

OperationsResource

The "operations" collection of methods.

OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

OperationsResource.LroResource

The "lro" collection of methods.

OperationsResource.LroResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

QueryResource

The "query" collection of methods.

QueryResource.DebugSearchRequest

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.

QueryResource.RemoveActivityRequest

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.

QueryResource.SearchRequest

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.

QueryResource.SourcesResource

The "sources" collection of methods.

QueryResource.SourcesResource.ListRequest

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.

QueryResource.SuggestRequest

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.

SettingsResource

The "settings" collection of methods.

SettingsResource.DatasourcesResource

The "datasources" collection of methods.

SettingsResource.DatasourcesResource.CreateRequest

Creates a datasource. Note: This API requires an admin account to execute.

SettingsResource.DatasourcesResource.DeleteRequest

Deletes a datasource. Note: This API requires an admin account to execute.

SettingsResource.DatasourcesResource.GetRequest

Gets a datasource. Note: This API requires an admin account to execute.

SettingsResource.DatasourcesResource.ListRequest

Lists datasources. Note: This API requires an admin account to execute.

SettingsResource.DatasourcesResource.PatchRequest

Updates a datasource. Note: This API requires an admin account to execute.

SettingsResource.DatasourcesResource.UpdateRequest

Updates a datasource. Note: This API requires an admin account to execute.

SettingsResource.GetCustomerRequest

Get customer settings. Note: This API requires an admin account to execute.

SettingsResource.SearchapplicationsResource

The "searchapplications" collection of methods.

SettingsResource.SearchapplicationsResource.CreateRequest

Creates a search application. Note: This API requires an admin account to execute.

SettingsResource.SearchapplicationsResource.DeleteRequest

Deletes a search application. Note: This API requires an admin account to execute.

SettingsResource.SearchapplicationsResource.GetRequest

Gets the specified search application. Note: This API requires an admin account to execute.

SettingsResource.SearchapplicationsResource.ListRequest

Lists all search applications. Note: This API requires an admin account to execute.

SettingsResource.SearchapplicationsResource.PatchRequest

Updates a search application. Note: This API requires an admin account to execute.

SettingsResource.SearchapplicationsResource.ResetRequest

Resets a search application to default settings. This will return an empty response. Note: This API requires an admin account to execute.

SettingsResource.SearchapplicationsResource.UpdateRequest

Updates a search application. Note: This API requires an admin account to execute.

SettingsResource.UpdateCustomerRequest

Update customer settings. Note: This API requires an admin account to execute.

StatsResource

The "stats" collection of methods.

StatsResource.GetIndexRequest

Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. Note: This API requires a standard end user account to execute.

StatsResource.GetQueryRequest

Get the query statistics for customer. Note: This API requires a standard end user account to execute.

StatsResource.GetSearchapplicationRequest

Get search application stats for customer. Note: This API requires a standard end user account to execute.

StatsResource.GetSessionRequest

Get the # of search sessions, % of successful sessions with a click query statistics for customer. Note: This API requires a standard end user account to execute.

StatsResource.GetUserRequest

Get the users statistics for customer. Note: This API requires a standard end user account to execute.

StatsResource.IndexResource

The "index" collection of methods.

StatsResource.IndexResource.DatasourcesResource

The "datasources" collection of methods.

StatsResource.IndexResource.DatasourcesResource.GetRequest

Gets indexed item statistics for a single data source. Note: This API requires a standard end user account to execute.

StatsResource.QueryResource

The "query" collection of methods.

StatsResource.QueryResource.SearchapplicationsResource

The "searchapplications" collection of methods.

StatsResource.QueryResource.SearchapplicationsResource.GetRequest

Get the query statistics for search application. Note: This API requires a standard end user account to execute.

StatsResource.SessionResource

The "session" collection of methods.

StatsResource.SessionResource.SearchapplicationsResource

The "searchapplications" collection of methods.

StatsResource.SessionResource.SearchapplicationsResource.GetRequest

Get the # of search sessions, % of successful sessions with a click query statistics for search application. Note: This API requires a standard end user account to execute.

StatsResource.UserResource

The "user" collection of methods.

StatsResource.UserResource.SearchapplicationsResource

The "searchapplications" collection of methods.

StatsResource.UserResource.SearchapplicationsResource.GetRequest

Get the users statistics for search application. Note: This API requires a standard end user account to execute.

V1Resource

The "v1" collection of methods.

V1Resource.InitializeCustomerRequest

Enables third party support in Google Cloud Search. Note: This API requires an admin account to execute.

Enums

CloudSearchBaseServiceRequest<TResponse>.AltEnum

Data format for response.

CloudSearchBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

DebugResource.IdentitysourcesResource.UnmappedidsResource.ListRequest.ResolutionStatusCodeEnum

Limit users selection to this status.

IndexingResource.DatasourcesResource.ItemsResource.DeleteRequest.ModeEnum

Required. The RequestMode for this request.

MediaResource.UploadMediaUpload.AltEnum

Data format for response.

MediaResource.UploadMediaUpload.XgafvEnum

V1 error format.

In this article
Back to top Generated by DocFX