Gcp/devicerun
@swamp/gcp/devicerunv2026.10.23.1
01README
Google Cloud devicerun infrastructure models
02Release Notes
- Updated: locations, devices, sessions, softwareversions
03Behaviors
@swamp/gcp/devicerun/devicesv2026.10.23.1devices.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. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a devices
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the devices |
fn sync(identifier?: string)
Sync devices state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific devices by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List devices resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. An AIP-160 (https://google.aip.dev/160) filter expression restricting which devices are returned. An empty filter returns all devices. Filtering is supported over the `Device` fields, including nested fields via dot-path. Enum and string values must be double-quoted. Examples: * `platform = "ANDROID"` * `platform = "ANDROID" AND os_version = "34"` * `hardware_type = "PHYSICAL" AND form_factor = "PHONE"` * `android_details.build_type = "userdebug"` * `availability.capacity = "HIGH"` |
| pageSize? | number | Optional. The maximum number of devices to return. The server may return fewer items than this value. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A single routable device configuration in the catalog.
@swamp/gcp/devicerun/locationsv2026.10.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| name | string | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/devicerun/sessionsv2026.10.23.1sessions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| name? | string | Identifier. The resource name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}`. |
| sessionConfig? | object | Required. Configuration used to create the session. |
| requestId? | string | Optional. A unique identifier for this request. This request is only idempotent if a `request_id` is provided, i.e. if a request with the same `request_id` is received, then the previous result will be returned. The server will guarantee that for at least 60 minutes after the first request. The value must be a UUID (e.g., 123e4567-e89b-12d3-a456-426655440000). See github.com/google/uuid for more details. |
| sessionId? | string | Optional. The ID to use for the session, which will become the final component of the resource name. If not provided, the server will generate a value for this field. When provided, this value must be between 4 and 63 characters, and match the following regex: ^a-z{2,61}[a-z0-9]$. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a sessions
fn get(identifier: string)
Get a sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn delete(identifier: string)
Delete the sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn sync(identifier?: string)
Sync sessions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessions by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)
List sessions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The raw filter text to constrain the results. |
| orderBy? | string | Optional. The order to sort results by. Supported values: `name`, `name desc`, `create_time`, `create_time desc`. Values must use the snake_case field name; `createTime` is not accepted. Ordering by `create_time` is not supported when listing across all locations (`locations/-`). If unspecified, results are returned in an unspecified order. |
| pageSize? | number | Optional. The maximum number of sessions to return. The server may return fewer items than this value. If unspecified, at most 500 sessions will be returned. The maximum value is 1000, values above will be coerced to 1000. |
| view? | string | Optional. The view of the sessions to return. If not set, the `FULL` view will be returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn batch_get(names?: any)
batch get
| Argument | Type | Description |
|---|---|---|
| names? | any |
fn cancel()
cancel
Resources
state(infinite)— A session resource in the AutomationSession API. At a high level, `Session` d...
@swamp/gcp/devicerun/softwareversionsv2026.10.23.1softwareversions.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. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a softwareVersions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the softwareVersions |
fn sync(identifier?: string)
Sync softwareVersions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific softwareVersions by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List softwareVersions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. An AIP-160 (https://google.aip.dev/160) filter expression restricting which software versions are returned. An empty filter returns all software versions. Filtering is supported over the `SoftwareVersion` fields, including nested fields via dot-path. Enum and string values must be double-quoted. Examples: * `software_type = "ANDROIDX_TEST_ORCHESTRATOR"` * `software_type = "ANDROIDX_TEST_ORCHESTRATOR" AND is_default = true` * `lifecycle.state = "ACTIVE"` * `version = "1.4.1"` |
| pageSize? | number | Optional. The maximum number of software versions to return. The server may return fewer items than this value. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A single software version in the catalog.
04Previous Versions
2026.10.20.1AGPL-3.0-or-later
- Updated: sessions
2026.10.14.1AGPL-3.0-or-later(was none)
- Updated: sessions
2026.10.13.1
- Updated: locations, devices, sessions, softwareversions
Modified 1 behaviors
2026.10.02.1
- Updated: sessions
2026.09.24.1
- Added: locations, devices, sessions, softwareversions
05Stats
A
100 / 100
Downloads
39
Archive size
39.4 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
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels