Google IDX icon

Google IDX

Google IDX
Join our community

Actions10

Overview

This node integrates with Google Cloud Workstations via the Google IDX API, enabling management and control of cloud-based development workstations. It supports operations such as initializing workstation data, starting/stopping workstations, generating access tokens, running commands remotely, and checking workstation statuses.

Typical use cases include automating workstation lifecycle management in CI/CD pipelines, monitoring workstation states for teams, or remotely executing commands on cloud workstations without manual intervention.

For example, a developer team lead could use this node to initialize all available workstations for their project, start or stop specific workstations on demand, or run diagnostic commands remotely to troubleshoot issues.

Properties

Name Meaning
Project ID Select or enter your Google Cloud project ID. This identifies the GCP project context for the operation.

Note: The node also internally uses an "operation" parameter (not listed here) to select the action to perform, such as "workstationInitialization", "startWorkstation", "stopWorkstation", etc.

Output

The node outputs JSON objects whose structure depends on the selected operation:

  • workstationInitialization: Outputs an object containing:

    • totalUsers: Number of unique users found.
    • totalItems: Total number of workstations discovered.
    • workspaces: A nested object mapping usernames to their workspace slugs and workstation details.

  • liveWorkstation: Outputs status information per workstation, indicating if it is running, stopped, or if the access token expired.

  • startWorkstation, stopWorkstation, generateAccessToken, getWorkstation: Outputs the raw response from the Google Workstations API for the respective action.

  • resetWorkstation: Outputs a simple status message confirming reset completion.

  • getStatusWorkstation: Outputs categorized lists of workstations by their state (STATE_STARTING, STATE_RUNNING, STATE_STOPPED).

  • manualWorkstation: Outputs results of manually specified commands/actions on workstations.

  • runCommandWorkstation: Outputs detailed command execution results including timestamps, exit codes, stdout, stderr, and related metadata.

The node does not output binary data.

Dependencies

  • Requires an OAuth2 API credential configured for Google IDX API access.
  • Uses Google Cloud Workstations API endpoints.
  • Depends on the presence of the gcloud CLI and optionally Docker (for running commands inside containers).
  • Requires network access to Google APIs and the target workstations.
  • Uses internal helper methods for OAuth2 requests and concurrency limiting.

Troubleshooting

  • Missing or invalid Project ID: Operations that require a project ID will fail if it is not provided or invalid. Ensure the Project ID input is correctly set.

  • Authentication errors: If OAuth2 credentials are missing, expired, or invalid, API calls will fail. Refresh or reconfigure the API authentication token.

  • Unsupported operation error: Selecting an operation not implemented by the node will throw an error. Verify the operation name is correct.

  • Command execution failures: When running commands via the runCommandWorkstation operation, errors may occur if the gcloud CLI or Docker container is misconfigured or inaccessible. Check that the CLI is installed and the container name is correct.

  • API rate limits or transient errors: The node retries some API calls on HTTP 503/504 errors with exponential backoff. Persistent failures may indicate quota exhaustion or network issues.

  • Invalid manual command format: The manualWorkstation operation expects commands in a strict format. Invalid inputs will cause errors; ensure commands follow the documented syntax.

Links and References

Discussion