Google IDX Action icon

Google IDX Action

Perform an action using a selected Google OAuth2 credential

Actions5

Stop Workstation

AI-generated

Overview

This node, named "Google IDX Action," is designed to perform actions on Google Workstations using selected Google OAuth2 credentials. It supports operations such as stopping a workstation, starting it, getting its status, generating access tokens, or running custom commands on the workstation.

Typical use cases include automating management of Google Cloud workstations within workflows, such as programmatically stopping or starting development environments, retrieving their status, or executing commands remotely. For example, a user might automate shutting down multiple workstations after work hours or trigger specific commands on a workstation as part of a CI/CD pipeline.

Properties

Name Meaning
Is List Boolean flag indicating whether the input is a list of workstations or a single workstation.
Credentinals Name Select or enter your Google Cloud project credential. Options: select from a list or enter name manually.
Project ID Select or enter your Google Cloud project ID. Only shown if "Is List" is false. Options: select from a list of projects.

Output

The node outputs JSON data representing the result of the requested operation on the workstation(s). The output structure corresponds to the response from the underlying Google IDX API calls executed via a sub-workflow. Each item in the output array contains:

  • json: The JSON response from the Google IDX API for the performed action.
  • pairedItem: Metadata linking the output to the corresponding input item.

If multiple workstations are processed (when "Is List" is true), the node aggregates results accordingly.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential with Google OAuth2 authentication configured for accessing Google IDX services.
  • Uses internal helper functions and a sub-workflow template (subWorkflowTemplate.json) to execute Google IDX API requests.
  • Needs proper configuration of Google Cloud projects and workstations accessible via the provided credentials.
  • The node depends on n8n's HTTP request capabilities and workflow execution methods.

Troubleshooting

  • Invalid Input Format Error: The node expects input strings matching the pattern /[run|start|stop|status|token] -a USER -ws SLUG[,SLUG2] [-c COMMAND]. If this format is not met, an error will be thrown. Ensure inputs follow this exact syntax.
  • Missing or Invalid Input: If required parameters like credentials or workspace slugs are missing or malformed, the node will throw errors. Verify that all necessary inputs are correctly set.
  • No Workspace Found: If no matching workspace is found for the given slug(s), the node throws an error indicating no workspace was found. Confirm that the workspace identifiers are correct and accessible.
  • Credential Issues: Errors related to authentication or authorization may occur if the provided credentials lack necessary permissions or are invalid. Check the API key and OAuth2 token validity.
  • Execution Workflow Errors: Since the node uses a sub-workflow to perform actions, any failure in that workflow will propagate as an error. Review the sub-workflow configuration and logs for details.

Links and References

Discussion