Skip to main content

@swamp/gcp/cloudsearch

v2026.04.23.1

Google Cloud cloudsearch infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudcloudsearchcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/cloudsearch

@swamp/gcp/cloudsearch/debug-datasources-items-unmappedidsv2026.04.23.1debug_datasources_items_unmappedids.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
getGet a unmappedids
ArgumentTypeDescription
identifierstringThe name of the unmappedids
syncSync unmappedids state from GCP

Resources

state(infinite)— List all unmapped identities for a specific item. **Note:** This API requires...
@swamp/gcp/cloudsearch/debug-identitysources-unmappedidsv2026.04.23.1debug_identitysources_unmappedids.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
getGet a unmappedids
ArgumentTypeDescription
identifierstringThe name of the unmappedids
syncSync unmappedids state from GCP

Resources

state(infinite)— Lists unmapped user identities for an identity source. **Note:** This API req...
@swamp/gcp/cloudsearch/indexing-datasources-itemsv2026.04.23.1indexing_datasources_items.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a items
ArgumentTypeDescription
identifierstringThe name of the items
deleteDelete the items
ArgumentTypeDescription
identifierstringThe name of the items
syncSync items state from GCP
indexindex
ArgumentTypeDescription
connectorName?any
debugOptions?any
indexItemOptions?any
item?any
mode?any
pollpoll
ArgumentTypeDescription
connectorName?any
debugOptions?any
limit?any
queue?any
statusCodes?any
pushpush
ArgumentTypeDescription
connectorName?any
debugOptions?any
item?any
unreserveunreserve
ArgumentTypeDescription
connectorName?any
debugOptions?any
queue?any
uploadupload
ArgumentTypeDescription
connectorName?any
debugOptions?any

Resources

state(infinite)— Represents a single object that is an item in the search index, such as a fil...
@swamp/gcp/cloudsearch/query-sourcesv2026.04.23.1query_sources.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a sources
ArgumentTypeDescription
identifierstringThe name of the sources
syncSync sources state from GCP

Resources

state(infinite)— List of sources that the user can search using the query API.
@swamp/gcp/cloudsearch/settings-datasourcesv2026.04.23.1settings_datasources.ts

Global Arguments

ArgumentTypeDescription
disableModifications?booleanIf true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.
disableServing?booleanDisable serving any search or assist results.
displayName?stringRequired. Display name of the datasource The maximum length is 300 characters.
indexingServiceAccounts?arrayList of service accounts that have indexing access.
itemsVisibility?arrayThis field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
name?stringThe name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
operationIds?arrayIDs of the Long Running Operations (LROs) currently running for this schema.
returnThumbnailUrls?booleanCan a user request to get thumbnail URI for Items indexed in this data source.
shortName?stringA short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is ** then queries like *source:* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 3
debugOptions?objectShared request debug options for all cloudsearch RPC methods.
source?objectDatasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
updateMask?stringOnly 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
createCreate a datasources
getGet a datasources
ArgumentTypeDescription
identifierstringThe name of the datasources
updateUpdate datasources attributes
deleteDelete the datasources
ArgumentTypeDescription
identifierstringThe name of the datasources
syncSync datasources state from GCP

Resources

state(infinite)— Datasource is a logical namespace for items to be indexed. All items must bel...
@swamp/gcp/cloudsearch/settings-searchapplicationsv2026.04.23.1settings_searchapplications.ts

Global Arguments

ArgumentTypeDescription
dataSourceRestrictions?arrayRetrictions applied to the configurations. The maximum number of elements is 10.
defaultFacetOptions?arrayThe default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
defaultSortOptions?object
displayName?stringDisplay name of the Search Application. The maximum length is 300 characters.
enableAuditLog?booleanIndicates whether audit logging is on/off for requests made for the search application in query APIs.
name?stringThe name of the Search Application. Format: searchapplications/{application_id}.
queryInterpretationConfig?objectDefault options to interpret user query.
returnResultThumbnailUrls?booleanWith each result we should return the URI for its thumbnail (when applicable)
scoringConfig?objectScoring configurations for a source while processing a Search or Suggest request.
sourceConfig?arrayConfiguration for a sources specified in data_source_restrictions.
createCreate a searchapplications
getGet a searchapplications
ArgumentTypeDescription
identifierstringThe name of the searchapplications
updateUpdate searchapplications attributes
deleteDelete the searchapplications
ArgumentTypeDescription
identifierstringThe name of the searchapplications
syncSync searchapplications state from GCP
resetreset
ArgumentTypeDescription
debugOptions?any

Resources

state(infinite)— SearchApplication
@swamp/gcp/cloudsearch/stats-index-datasourcesv2026.04.23.1stats_index_datasources.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a datasources
ArgumentTypeDescription
identifierstringThe name of the datasources
syncSync datasources state from GCP

Resources

state(infinite)— Gets indexed item statistics for a single data source. **Note:** This API req...
@swamp/gcp/cloudsearch/stats-query-searchapplicationsv2026.04.23.1stats_query_searchapplications.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a searchapplications
ArgumentTypeDescription
identifierstringThe name of the searchapplications
syncSync searchapplications state from GCP

Resources

state(infinite)— Response format for getting query stats for a search application between give...
@swamp/gcp/cloudsearch/stats-session-searchapplicationsv2026.04.23.1stats_session_searchapplications.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a searchapplications
ArgumentTypeDescription
identifierstringThe name of the searchapplications
syncSync searchapplications state from GCP

Resources

state(infinite)— Get the # of search sessions, % of successful sessions with a click query sta...
@swamp/gcp/cloudsearch/stats-user-searchapplicationsv2026.04.23.1stats_user_searchapplications.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a searchapplications
ArgumentTypeDescription
identifierstringThe name of the searchapplications
syncSync searchapplications state from GCP

Resources

state(infinite)— Get the users statistics for search application. **Note:** This API requires ...