SDK Reference
Java: Runs
Overview
Start validation runs, poll status, and stream logs from CI pipelines.
Supports cancellation, artifact download, and webhook-driven completion instead of aggressive polling.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
Prerequisites
- Java runtime installed
- Organization API key
When to use this workflow
- CI pipeline gate before deploy
- Scheduled smoke from internal cron
- Post-deploy verification webhook handler
Step-by-step procedure
Confirm access
Verify organization membership and role permissions in Admin Center.
Confirm API key or SSO session is scoped to the correct tenant.
Apply this guidance
Follow Console navigation paths and API examples in this document.
Use staging project and environment IDs for first-time integration tests.
Verify outcomes
Check Operate → Runs, Quality areas, or API responses for expected results.
Update team runbooks when your stack requires environment-specific variations.
Key concepts
- Organization scope
- All Zof Console and API operations are isolated to your authenticated tenant.
- Governed execution
- Agent output and remediation follow policy packs with human approval when configured.
Best practices
- Use waitUntilComplete with timeout aligned to suite size
- Pass explicit testCaseIds for fast PR gates
Example
const run = await client.runs.create({ projectId: 'proj_abc', environment: 'staging', testCaseIds: ['tc_001'] });
const status = await client.runs.retrieve(run.id);Was this page helpful?
