Gcp/datastore
@swamp/gcp/datastorev2026.08.25.1
01README
Google Cloud datastore infrastructure models
02Release Notes
- Updated: indexes
03Models
@swamp/gcp/datastore/indexesv2026.08.25.1indexes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| ancestor? | enum | Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. |
| projectId? | string | Output only. Project ID. |
| properties? | array | Required. An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties. |
fn create(waitForReady?: boolean)
Create a indexes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a indexes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the indexes |
fn delete(identifier: string)
Delete the indexes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the indexes |
fn sync(identifier?: string)
Sync indexes state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific indexes by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List indexes resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | |
| pageSize? | number | The maximum number of items to return. If zero, then all results will be returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Datastore composite index definition.
04Previous Versions
2026.08.12.2
- Updated: indexes
2026.07.29.1
- Updated: indexes
2026.07.21.3
- Updated: indexes
2026.07.21.1
- Updated: indexes
2026.07.20.1
- Updated: indexes
2026.07.19.1
- Updated: indexes
2026.07.18.2
- Updated: indexes
Added 1, removed 1 models
2026.06.08.2
- Updated: indexes
2026.06.07.1
- Updated: indexes
2026.05.25.2
- Updated: indexes
Modified 1 models
2026.05.24.1
- Updated: indexes
2026.05.21.2
- Updated: indexes
2026.05.21.1
2026.05.19.2
2026.05.19.1
2026.04.23.1
2026.04.03.3
- Updated: indexes
2026.04.03.1
- Updated: indexes
2026.04.02.2
05Stats
A
100 / 100
Downloads
0
Archive size
23.7 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels