happygapi.cloudsearch.indexing — happygapi 0.4.2

Cloud Search API: indexing. 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. See: https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing

datasources-deleteSchema$ clj

(datasources-deleteSchema$ auth parameters)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/deleteSchema

Required parameters: name

Optional parameters: debugOptions.enableDebugging

Deletes the schema of a data source.

Note: This API requires an admin or service account to execute.

datasources-getSchema$ clj

(datasources-getSchema$ auth parameters)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/getSchema

Required parameters: name

Optional parameters: debugOptions.enableDebugging

Gets the schema of a data source.

Note: This API requires an admin or service account to execute.

datasources-items-delete$ clj

(datasources-items-delete$ auth parameters)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/items/delete

Required parameters: name

Optional parameters: connectorName, version, debugOptions.enableDebugging, mode

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.

datasources-items-deleteQueueItems$ clj

(datasources-items-deleteQueueItems$ auth parameters body)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/items/deleteQueueItems

Required parameters: name

Optional parameters: none

Body:

{:debugOptions {:enableDebugging boolean}, :connectorName string, :queue string}

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.

datasources-items-get$ clj

(datasources-items-get$ auth parameters)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/items/get

Required parameters: name

Optional parameters: debugOptions.enableDebugging, connectorName

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.

datasources-items-index$ clj

(datasources-items-index$ auth parameters body)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/items/index

Required parameters: name

Optional parameters: none

Body:

{:debugOptions {:enableDebugging boolean}, :item {:payload string, :queue string, :content ItemContent, :name string, :status ItemStatus, :acl ItemAcl, :itemType string, :version string, :structuredData ItemStructuredData, :metadata ItemMetadata}, :connectorName string, :indexItemOptions {:allowUnknownGsuitePrincipals boolean}, :mode string}

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.

datasources-items-list$ clj

(datasources-items-list$ auth parameters)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/items/list

Required parameters: name

Optional parameters: connectorName, brief, pageToken, pageSize, debugOptions.enableDebugging

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.

datasources-items-poll$ clj

(datasources-items-poll$ auth parameters body)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/items/poll

Required parameters: name

Optional parameters: none

Body:

{:queue string, :limit integer, :statusCodes [string], :debugOptions {:enableDebugging boolean}, :connectorName string}

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: <br /> ERROR <br /> MODIFIED <br /> NEW_ITEM <br /> ACCEPTED <br /> 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.

datasources-items-push$ clj

(datasources-items-push$ auth parameters body)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/items/push

Required parameters: name

Optional parameters: none

Body:

{:debugOptions {:enableDebugging boolean}, :item {:contentHash string, :metadataHash string, :payload string, :repositoryError RepositoryError, :type string, :queue string, :structuredDataHash string}, :connectorName string}

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.

datasources-items-unreserve$ clj

(datasources-items-unreserve$ auth parameters body)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/items/unreserve

Required parameters: name

Optional parameters: none

Body:

{:connectorName string, :queue string, :debugOptions {:enableDebugging boolean}}

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.

datasources-items-upload$ clj

(datasources-items-upload$ auth parameters body)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/items/upload

Required parameters: name

Optional parameters: none

Body:

{:debugOptions {:enableDebugging boolean}, :connectorName string}

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.

datasources-updateSchema$ clj

(datasources-updateSchema$ auth parameters body)

https://developers.google.com/cloud-search/docs/guides/api/reference/rest/v1/indexing/datasources/updateSchema

Required parameters: name

Optional parameters: none

Body:

{:schema {:operationIds [string], :objectDefinitions [ObjectDefinition]}, :debugOptions {:enableDebugging boolean}, :validateOnly boolean}

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.