GCP.CloudSearch reference

SettingsDatasource

Source: src/GCP/CloudSearch/SettingsDatasource.ts

A Cloud Search datasource.

Cloud Search datasources have no labels field, so without state Alchemy finds one by displayName and reports it unowned unless the name is generated. The server-assigned datasource id is identity — changing datasourceId replaces the source. Display name, short name, serving flags, indexing accounts, and visibility update in place. Admin credentials are required.

SettingsDatasource: Creating a Datasource

Generated name

const source = yield* GCP.CloudSearch.SettingsDatasource("Wiki", {});

Explicit display name and short name

const source = yield* GCP.CloudSearch.SettingsDatasource("Wiki", {
  displayName: "Wiki",
  shortName: "wiki",
  returnThumbnailUrls: true,
});

SettingsDatasource: Updating a Datasource

Change props on the same logical id; the engine keeps the physical id.

const source = yield* GCP.CloudSearch.SettingsDatasource("Wiki", {
  displayName: "Knowledge base",
  shortName: "wiki",
  disableServing: true,
});

SettingsSearchapplication

Source: src/GCP/CloudSearch/SettingsSearchapplication.ts

A Cloud Search search application.

Search applications have no labels field, so without state Alchemy finds one by displayName and reports it unowned unless the name is generated. The server-assigned application id is identity — changing searchApplicationId replaces the application. Display name, audit logging, sources, scoring, and facet options update in place. Admin credentials are required.

SettingsSearchapplication: Creating a Search Application

Generated name

const app = yield* GCP.CloudSearch.SettingsSearchapplication(
  "Intranet",
  {},
);

Named application with audit logging

const app = yield* GCP.CloudSearch.SettingsSearchapplication(
  "Intranet",
  {
    displayName: "Intranet",
    enableAuditLog: true,
  },
);

SettingsSearchapplication: Updating a Search Application

Change props on the same logical id; the engine keeps the physical id.

const app = yield* GCP.CloudSearch.SettingsSearchapplication(
  "Intranet",
  {
    displayName: "Company search",
    returnResultThumbnailUrls: true,
  },
);