CloudScheduler

import { CloudScheduler } from "https://googleapis.deno.dev/v1/cloudscheduler:v1.ts";

Creates and manages jobs run on a regular recurring schedule.

class CloudScheduler {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsJobsCreate(parent: string, req: Job): Promise<Job>;

async projectsLocationsJobsDelete(name: string): Promise<Empty>;

async projectsLocationsJobsGet(name: string): Promise<Job>;

async projectsLocationsJobsList(parent: string, opts?: ProjectsLocationsJobsListOptions): Promise<ListJobsResponse>;

async projectsLocationsJobsPatch(

name: string,

req: Job,

opts?: ProjectsLocationsJobsPatchOptions,

): Promise<Job>;

async projectsLocationsJobsPause(name: string, req: PauseJobRequest): Promise<Job>;

async projectsLocationsJobsResume(name: string, req: ResumeJobRequest): Promise<Job>;

async projectsLocationsJobsRun(name: string, req: RunJobRequest): Promise<Job>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

}

§Constructors

new CloudScheduler(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsJobsCreate(parent: string, req: Job): Promise<Job>

[src]

Creates a job.

@param parent

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

projectsLocationsJobsDelete(name: string): Promise<Empty>

[src]

Deletes a job.

@param name

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

projectsLocationsJobsGet(name: string): Promise<Job>

[src]

Gets a job.

@param name

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

projectsLocationsJobsList(parent: string, opts?: ProjectsLocationsJobsListOptions): Promise<ListJobsResponse>

[src]

Lists jobs.

@param parent

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

projectsLocationsJobsPatch(name: string, req: Job, opts?: ProjectsLocationsJobsPatchOptions): Promise<Job>

[src]

Updates a job. If successful, the updated Job is returned. If the job does not exist, NOT_FOUND is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

@param name

Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID. * PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects * LOCATION_ID is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * JOB_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.

projectsLocationsJobsPause(name: string, req: PauseJobRequest): Promise<Job>

[src]

Pauses a job. If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

@param name

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

projectsLocationsJobsResume(name: string, req: ResumeJobRequest): Promise<Job>

[src]

Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.

@param name

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

projectsLocationsJobsRun(name: string, req: RunJobRequest): Promise<Job>

[src]

Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

@param name

Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.