Scheduler API
Google Cloud Scheduler wrapper for cron-based job scheduling.
What It Does
The Scheduler API provides a simplified interface for creating and managing scheduled jobs using Google Cloud Scheduler. It enables programmatic scheduling of tasks that publish messages to Pub/Sub topics on cron schedules.
Key Capabilities
- Cron Scheduling: Create jobs with standard cron expressions
- Pub/Sub Integration: Publish payloads to topics on schedule
- Job Management: Create and delete scheduled jobs
- Timezone Support: Configurable timezone for schedules
- Auto Project Resolution: Automatic GCP project ID detection
Main Component
SchedulerClient
class SchedulerClient {
constructor(options?: {locationId?: string})
async createTask(
topic: string,
payload: any,
cronExpression: string,
timeZone?: string,
jobName?: string
): Promise<string>
async deleteJob(jobId: string): Promise<void>
}Configuration
- Default Location: us-central1
- Default Timezone: America/Chicago
- Cron Format: Standard cron expressions
Common Use Cases
- Daily cleanup jobs
- Scheduled reports
- Periodic data synchronization
- Keep-alive/warmer tasks
- Batch processing schedules
Roadmap
Multi-Cloud Support
This API currently supports Google Cloud Platform. Future versions will add support for additional cloud providers and container-based deployment options, enabling greater flexibility in infrastructure choices.
What Customers Don’t Have to Build
- Cloud Scheduler integration
- Cron job management
- Pub/Sub topic publishing
- Project ID resolution
- Payload serialization
- Job lifecycle management
Last updated on