@datafire/google_cloudsearch

v3.0.0

Published

2 years ago

DataFire integration for Cloud Search API

Downloads

0High
0Medium
0Low

datafire

@datafire/google_cloudsearch

Client library for Cloud Search API

Installation and Usage

npm install --save @datafire/google_cloudsearch

let google_cloudsearch = require('@datafire/google_cloudsearch').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_cloudsearch.oauthCallback({
  "code": ""
}, context)

Input

input object
- code required string

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_cloudsearch.oauthRefresh(null, context)

Input

This action has no parameters

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

cloudsearch.debug.datasources.items.searchByViewUrl

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

google_cloudsearch.cloudsearch.debug.datasources.items.searchByViewUrl({
  "name": ""
}, context)

Input

input object
- name required string: Source name, format: datasources/{source_id}
- body SearchItemsByViewUrlRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output SearchItemsByViewUrlResponse

cloudsearch.debug.datasources.items.checkAccess

Checks whether an item is accessible by specified principal. Note: This API requires an admin account to execute.

google_cloudsearch.cloudsearch.debug.datasources.items.checkAccess({
  "name": ""
}, context)

Input

input object
- name required string: Item name, format: datasources/{source_id}/items/{item_id}
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- body Principal
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output CheckAccessResponse

cloudsearch.debug.identitysources.items.listForunmappedidentity

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

google_cloudsearch.cloudsearch.debug.identitysources.items.listForunmappedidentity({
  "parent": ""
}, context)

Input

input object
- parent required string: The name of the identity source, in the following format: identitysources/{source_id}}
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- groupResourceName string
- pageSize integer: Maximum number of items to fetch in a request. Defaults to 100.
- pageToken string: The next_page_token value returned from a previous List request, if any.
- userResourceName string
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output ListItemNamesForUnmappedIdentityResponse

cloudsearch.debug.identitysources.unmappedids.list

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

google_cloudsearch.cloudsearch.debug.identitysources.unmappedids.list({
  "parent": ""
}, context)

Input

input object
- parent required string: The name of the identity source, in the following format: identitysources/{source_id}
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- pageSize integer: Maximum number of items to fetch in a request. Defaults to 100.
- pageToken string: The next_page_token value returned from a previous List request, if any.
- resolutionStatusCode string (values: CODE_UNSPECIFIED, NOT_FOUND, IDENTITY_SOURCE_NOT_FOUND, IDENTITY_SOURCE_MISCONFIGURED, TOO_MANY_MAPPINGS_FOUND, INTERNAL_ERROR): Limit users selection to this status.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output ListUnmappedIdentitiesResponse

cloudsearch.indexing.datasources.items.delete

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.

google_cloudsearch.cloudsearch.indexing.datasources.items.delete({
  "name": ""
}, context)

Input

input object
- name required string: Required. Name of the item to delete. Format: datasources/{source_id}/items/{item_id}
- connectorName string: Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- mode string (values: UNSPECIFIED, SYNCHRONOUS, ASYNCHRONOUS): Required. The RequestMode for this request.
- version string: 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.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.indexing.datasources.items.get

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.

google_cloudsearch.cloudsearch.indexing.datasources.items.get({
  "name": ""
}, context)

Input

input object
- name required string: Name of the item to get info. Format: datasources/{source_id}/items/{item_id}
- connectorName string: Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Item

cloudsearch.indexing.datasources.items.list

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.

google_cloudsearch.cloudsearch.indexing.datasources.items.list({
  "name": ""
}, context)

Input

input object
- name required string: Name of the Data Source to list Items. Format: datasources/{source_id}
- brief boolean: When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, If this value is false, then all the fields are populated in Item.
- connectorName string: Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- pageSize integer: Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false. The default value is 10
- pageToken string: The next_page_token value returned from a previous List request, if any.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output ListItemsResponse

cloudsearch.indexing.datasources.items.deleteQueueItems

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.

google_cloudsearch.cloudsearch.indexing.datasources.items.deleteQueueItems({
  "name": ""
}, context)

Input

input object
- name required string: Name of the Data Source to delete items in a queue. Format: datasources/{source_id}
- body DeleteQueueItemsRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.indexing.datasources.items.poll

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.

google_cloudsearch.cloudsearch.indexing.datasources.items.poll({
  "name": ""
}, context)

Input

input object
- name required string: Name of the Data Source to poll items. Format: datasources/{source_id}
- body PollItemsRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output PollItemsResponse

cloudsearch.indexing.datasources.items.unreserve

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.

google_cloudsearch.cloudsearch.indexing.datasources.items.unreserve({
  "name": ""
}, context)

Input

input object
- name required string: Name of the Data Source to unreserve all items. Format: datasources/{source_id}
- body UnreserveItemsRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.indexing.datasources.deleteSchema

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

google_cloudsearch.cloudsearch.indexing.datasources.deleteSchema({
  "name": ""
}, context)

Input

input object
- name required string: Name of the data source to delete Schema. Format: datasources/{source_id}
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.indexing.datasources.getSchema

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

google_cloudsearch.cloudsearch.indexing.datasources.getSchema({
  "name": ""
}, context)

Input

input object
- name required string: Name of the data source to get Schema. Format: datasources/{source_id}
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Schema

cloudsearch.indexing.datasources.updateSchema

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.

google_cloudsearch.cloudsearch.indexing.datasources.updateSchema({
  "name": ""
}, context)

Input

input object
- name required string: Name of the data source to update Schema. Format: datasources/{source_id}
- body UpdateSchemaRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.indexing.datasources.items.index

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.

google_cloudsearch.cloudsearch.indexing.datasources.items.index({
  "name": ""
}, context)

Input

input object
- name required string: Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
- body IndexItemRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.indexing.datasources.items.push

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.

google_cloudsearch.cloudsearch.indexing.datasources.items.push({
  "name": ""
}, context)

Input

input object
- name required string: Name of the item to push into the indexing queue. Format: datasources/{source_id}/items/{ID} This is a required field. The maximum length is 1536 characters.
- body PushItemRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Item

cloudsearch.indexing.datasources.items.upload

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.

google_cloudsearch.cloudsearch.indexing.datasources.items.upload({
  "name": ""
}, context)

Input

input object
- name required string: Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. The maximum length is 1536 bytes.
- body StartUploadItemRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output UploadItemRef

cloudsearch.media.upload

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.

google_cloudsearch.cloudsearch.media.upload({
  "resourceName": ""
}, context)

Input

input object
- resourceName required string: Name of the media that is being downloaded. See ReadRequest.resource_name.
- body Media
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Media

cloudsearch.query.search

The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite 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 G Suite domain-wide delegation of authority.

google_cloudsearch.cloudsearch.query.search({}, context)

Input

input object
- body SearchRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output SearchResponse

cloudsearch.query.sources.list

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 G Suite domain-wide delegation of authority.

google_cloudsearch.cloudsearch.query.sources.list({}, context)

Input

input object
- pageToken string: Number of sources to return in the response.
- requestOptions.debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- requestOptions.languageCode string: The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The suggest API does not use this parameter. Instead, suggest autocompletes only based on characters in the query.
- requestOptions.searchApplicationId string: The ID generated when you create a search application using the admin console.
- requestOptions.timeZone string: Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by Unicode Common Locale Data Repository (CLDR) project, and currently available in the file timezone.xml. This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output ListQuerySourcesResponse

cloudsearch.query.suggest

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 G Suite domain-wide delegation of authority.

google_cloudsearch.cloudsearch.query.suggest({}, context)

Input

input object
- body SuggestRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output SuggestResponse

cloudsearch.settings.datasources.list

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

google_cloudsearch.cloudsearch.settings.datasources.list({}, context)

Input

input object
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- pageSize integer: Maximum number of datasources to fetch in a request. The max value is 100. The default value is 10
- pageToken string: Starting index of the results.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output ListDataSourceResponse

cloudsearch.settings.datasources.create

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

google_cloudsearch.cloudsearch.settings.datasources.create({}, context)

Input

input object
- body DataSource
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.settings.searchapplications.list

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

google_cloudsearch.cloudsearch.settings.searchapplications.list({}, context)

Input

input object
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- pageSize integer: The maximum number of items to return.
- pageToken string: The next_page_token value returned from a previous List request, if any. The default value is 10
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output ListSearchApplicationsResponse

cloudsearch.settings.searchapplications.create

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

google_cloudsearch.cloudsearch.settings.searchapplications.create({}, context)

Input

input object
- body SearchApplication
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.settings.searchapplications.delete

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

google_cloudsearch.cloudsearch.settings.searchapplications.delete({
  "name": ""
}, context)

Input

input object
- name required string: The name of the search application to be deleted. Format: applications/{application_id}.
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.settings.searchapplications.get

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

google_cloudsearch.cloudsearch.settings.searchapplications.get({
  "name": ""
}, context)

Input

input object
- name required string: Name of the search application. Format: searchapplications/{application_id}.
- debugOptions.enableDebugging boolean: If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output SearchApplication

cloudsearch.settings.searchapplications.update

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

google_cloudsearch.cloudsearch.settings.searchapplications.update({
  "name": ""
}, context)

Input

input object
- name required string: Name of the Search Application. Format: searchapplications/{application_id}.
- body SearchApplication
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.settings.searchapplications.reset

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

google_cloudsearch.cloudsearch.settings.searchapplications.reset({
  "name": ""
}, context)

Input

input object
- name required string: The name of the search application to be reset. Format: applications/{application_id}.
- body ResetSearchApplicationRequest
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output Operation

cloudsearch.stats.getIndex

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.

google_cloudsearch.cloudsearch.stats.getIndex({}, context)

Input

input object
- fromDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- fromDate.month integer: Month of date. Must be from 1 to 12.
- fromDate.year integer: Year of date. Must be from 1 to 9999.
- toDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- toDate.month integer: Month of date. Must be from 1 to 12.
- toDate.year integer: Year of date. Must be from 1 to 9999.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output GetCustomerIndexStatsResponse

cloudsearch.stats.index.datasources.get

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

google_cloudsearch.cloudsearch.stats.index.datasources.get({
  "name": ""
}, context)

Input

input object
- name required string: The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}"
- fromDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- fromDate.month integer: Month of date. Must be from 1 to 12.
- fromDate.year integer: Year of date. Must be from 1 to 9999.
- toDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- toDate.month integer: Month of date. Must be from 1 to 12.
- toDate.year integer: Year of date. Must be from 1 to 9999.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output GetDataSourceIndexStatsResponse

cloudsearch.stats.getQuery

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

google_cloudsearch.cloudsearch.stats.getQuery({}, context)

Input

input object
- fromDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- fromDate.month integer: Month of date. Must be from 1 to 12.
- fromDate.year integer: Year of date. Must be from 1 to 9999.
- toDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- toDate.month integer: Month of date. Must be from 1 to 12.
- toDate.year integer: Year of date. Must be from 1 to 9999.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output GetCustomerQueryStatsResponse

cloudsearch.stats.query.searchapplications.get

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

google_cloudsearch.cloudsearch.stats.query.searchapplications.get({
  "name": ""
}, context)

Input

input object
- name required string: The resource id of the search application query stats, in the following format: searchapplications/{application_id}
- fromDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- fromDate.month integer: Month of date. Must be from 1 to 12.
- fromDate.year integer: Year of date. Must be from 1 to 9999.
- toDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- toDate.month integer: Month of date. Must be from 1 to 12.
- toDate.year integer: Year of date. Must be from 1 to 9999.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output GetSearchApplicationQueryStatsResponse

cloudsearch.stats.getSession

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.

google_cloudsearch.cloudsearch.stats.getSession({}, context)

Input

input object
- fromDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- fromDate.month integer: Month of date. Must be from 1 to 12.
- fromDate.year integer: Year of date. Must be from 1 to 9999.
- toDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- toDate.month integer: Month of date. Must be from 1 to 12.
- toDate.year integer: Year of date. Must be from 1 to 9999.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output GetCustomerSessionStatsResponse

cloudsearch.stats.session.searchapplications.get

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.

google_cloudsearch.cloudsearch.stats.session.searchapplications.get({
  "name": ""
}, context)

Input

input object
- name required string: The resource id of the search application session stats, in the following format: searchapplications/{application_id}
- fromDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- fromDate.month integer: Month of date. Must be from 1 to 12.
- fromDate.year integer: Year of date. Must be from 1 to 9999.
- toDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- toDate.month integer: Month of date. Must be from 1 to 12.
- toDate.year integer: Year of date. Must be from 1 to 9999.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output GetSearchApplicationSessionStatsResponse

cloudsearch.stats.getUser

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

google_cloudsearch.cloudsearch.stats.getUser({}, context)

Input

input object
- fromDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- fromDate.month integer: Month of date. Must be from 1 to 12.
- fromDate.year integer: Year of date. Must be from 1 to 9999.
- toDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- toDate.month integer: Month of date. Must be from 1 to 12.
- toDate.year integer: Year of date. Must be from 1 to 9999.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output GetCustomerUserStatsResponse

cloudsearch.stats.user.searchapplications.get

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

google_cloudsearch.cloudsearch.stats.user.searchapplications.get({
  "name": ""
}, context)

Input

input object
- name required string: The resource id of the search application session stats, in the following format: searchapplications/{application_id}
- fromDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- fromDate.month integer: Month of date. Must be from 1 to 12.
- fromDate.year integer: Year of date. Must be from 1 to 9999.
- toDate.day integer: Day of month. Must be from 1 to 31 and valid for the year and month.
- toDate.month integer: Month of date. Must be from 1 to 12.
- toDate.year integer: Year of date. Must be from 1 to 9999.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string: 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.
- oauth_token string: OAuth 2.0 token for the current user.
- prettyPrint boolean: Returns response with indentations and line breaks.
- quotaUser string: 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.
- upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
- uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

output GetSearchApplicationUserStatsResponse

cloudsearch.operations.get

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.

google_cloudsearch.cloudsearch.operations.get({
  "name": ""
}, context)

Input

input object
- name required string: The name of the operation resource.
- $.xgafv string (values: 1, 2): V1 error format.
- access_token string: OAuth access token.
- alt string (values: json, media, proto): Data format for response.
- callback string: JSONP
- fields string: Selector specifying which fields to include in a partial response.
- key string:

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@datafire/google_cloudsearch

Installation and Usage

Description

Actions

oauthCallback

Input

Output

oauthRefresh

Input

Output

cloudsearch.debug.datasources.items.searchByViewUrl

Input

Output

cloudsearch.debug.datasources.items.checkAccess

Input

Output

cloudsearch.debug.identitysources.items.listForunmappedidentity

Input

Output

cloudsearch.debug.identitysources.unmappedids.list

Input

Output

cloudsearch.indexing.datasources.items.delete

Input

Output

cloudsearch.indexing.datasources.items.get

Input

Output

cloudsearch.indexing.datasources.items.list

Input

Output

cloudsearch.indexing.datasources.items.deleteQueueItems

Input

Output

cloudsearch.indexing.datasources.items.poll

Input

Output

cloudsearch.indexing.datasources.items.unreserve

Input

Output

cloudsearch.indexing.datasources.deleteSchema

Input

Output

cloudsearch.indexing.datasources.getSchema

Input

Output

cloudsearch.indexing.datasources.updateSchema

Input

Output

cloudsearch.indexing.datasources.items.index

Input

Output

cloudsearch.indexing.datasources.items.push

Input

Output

cloudsearch.indexing.datasources.items.upload

Input

Output

cloudsearch.media.upload

Input

Output

cloudsearch.query.search

Input

Output

cloudsearch.query.sources.list

Input

Output

cloudsearch.query.suggest

Input

Output

cloudsearch.settings.datasources.list

Input

Output

cloudsearch.settings.datasources.create