Class google.cloud.scheduler.v1.CloudScheduler (2.1.1)

Represents a CloudScheduler

Inheritance

$protobuf.rpc.Service > google.cloud.scheduler.v1.CloudScheduler

Package

@google-cloud/scheduler!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new CloudScheduler service.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CloudScheduler;

Creates new CloudScheduler service using the specified rpc implementation.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Returns

Type	Description
CloudScheduler	RPC service. Useful where requests and/or responses are streamed.

createJob(request, callback)

public createJob(request: google.cloud.scheduler.v1.ICreateJobRequest, callback: google.cloud.scheduler.v1.CloudScheduler.CreateJobCallback): void;

Calls CreateJob.

Parameters

Name	Description
request	`ICreateJobRequest` CreateJobRequest message or plain object
callback	`google.cloud.scheduler.v1.CloudScheduler.CreateJobCallback` Node-style callback called with the error, if any, and Job

Returns

Type	Description
void

createJob(request)

public createJob(request: google.cloud.scheduler.v1.ICreateJobRequest): Promise<google.cloud.scheduler.v1.Job>;

Calls CreateJob.

Parameter

Name	Description
request	`ICreateJobRequest` CreateJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.scheduler.v1.Job>	Promise

deleteJob(request, callback)

public deleteJob(request: google.cloud.scheduler.v1.IDeleteJobRequest, callback: google.cloud.scheduler.v1.CloudScheduler.DeleteJobCallback): void;

Calls DeleteJob.

Parameters

Name	Description
request	`IDeleteJobRequest` DeleteJobRequest message or plain object
callback	`google.cloud.scheduler.v1.CloudScheduler.DeleteJobCallback` Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

deleteJob(request)

public deleteJob(request: google.cloud.scheduler.v1.IDeleteJobRequest): Promise<google.protobuf.Empty>;

Calls DeleteJob.

Parameter

Name	Description
request	`IDeleteJobRequest` DeleteJobRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

getJob(request, callback)

public getJob(request: google.cloud.scheduler.v1.IGetJobRequest, callback: google.cloud.scheduler.v1.CloudScheduler.GetJobCallback): void;

Calls GetJob.

Parameters

Name	Description
request	`IGetJobRequest` GetJobRequest message or plain object
callback	`google.cloud.scheduler.v1.CloudScheduler.GetJobCallback` Node-style callback called with the error, if any, and Job

Returns

Type	Description
void

getJob(request)

public getJob(request: google.cloud.scheduler.v1.IGetJobRequest): Promise<google.cloud.scheduler.v1.Job>;

Calls GetJob.

Parameter

Name	Description
request	`IGetJobRequest` GetJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.scheduler.v1.Job>	Promise

listJobs(request, callback)

public listJobs(request: google.cloud.scheduler.v1.IListJobsRequest, callback: google.cloud.scheduler.v1.CloudScheduler.ListJobsCallback): void;

Calls ListJobs.

Parameters

Name	Description
request	`IListJobsRequest` ListJobsRequest message or plain object
callback	`google.cloud.scheduler.v1.CloudScheduler.ListJobsCallback` Node-style callback called with the error, if any, and ListJobsResponse

Returns

Type	Description
void

listJobs(request)

public listJobs(request: google.cloud.scheduler.v1.IListJobsRequest): Promise<google.cloud.scheduler.v1.ListJobsResponse>;

Calls ListJobs.

Parameter

Name	Description
request	`IListJobsRequest` ListJobsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.scheduler.v1.ListJobsResponse>	Promise

pauseJob(request, callback)

public pauseJob(request: google.cloud.scheduler.v1.IPauseJobRequest, callback: google.cloud.scheduler.v1.CloudScheduler.PauseJobCallback): void;

Calls PauseJob.

Parameters

Name	Description
request	`IPauseJobRequest` PauseJobRequest message or plain object
callback	`google.cloud.scheduler.v1.CloudScheduler.PauseJobCallback` Node-style callback called with the error, if any, and Job

Returns

Type	Description
void

pauseJob(request)

public pauseJob(request: google.cloud.scheduler.v1.IPauseJobRequest): Promise<google.cloud.scheduler.v1.Job>;

Calls PauseJob.

Parameter

Name	Description
request	`IPauseJobRequest` PauseJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.scheduler.v1.Job>	Promise

resumeJob(request, callback)

public resumeJob(request: google.cloud.scheduler.v1.IResumeJobRequest, callback: google.cloud.scheduler.v1.CloudScheduler.ResumeJobCallback): void;

Calls ResumeJob.

Parameters

Name	Description
request	`IResumeJobRequest` ResumeJobRequest message or plain object
callback	`google.cloud.scheduler.v1.CloudScheduler.ResumeJobCallback` Node-style callback called with the error, if any, and Job

Returns

Type	Description
void

resumeJob(request)

public resumeJob(request: google.cloud.scheduler.v1.IResumeJobRequest): Promise<google.cloud.scheduler.v1.Job>;

Calls ResumeJob.

Parameter

Name	Description
request	`IResumeJobRequest` ResumeJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.scheduler.v1.Job>	Promise

runJob(request, callback)

public runJob(request: google.cloud.scheduler.v1.IRunJobRequest, callback: google.cloud.scheduler.v1.CloudScheduler.RunJobCallback): void;

Calls RunJob.

Parameters

Name	Description
request	`IRunJobRequest` RunJobRequest message or plain object
callback	`google.cloud.scheduler.v1.CloudScheduler.RunJobCallback` Node-style callback called with the error, if any, and Job

Returns

Type	Description
void

runJob(request)

public runJob(request: google.cloud.scheduler.v1.IRunJobRequest): Promise<google.cloud.scheduler.v1.Job>;

Calls RunJob.

Parameter

Name	Description
request	`IRunJobRequest` RunJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.scheduler.v1.Job>	Promise

updateJob(request, callback)

public updateJob(request: google.cloud.scheduler.v1.IUpdateJobRequest, callback: google.cloud.scheduler.v1.CloudScheduler.UpdateJobCallback): void;

Calls UpdateJob.

Parameters

Name	Description
request	`IUpdateJobRequest` UpdateJobRequest message or plain object
callback	`google.cloud.scheduler.v1.CloudScheduler.UpdateJobCallback` Node-style callback called with the error, if any, and Job

Returns

Type	Description
void

updateJob(request)

public updateJob(request: google.cloud.scheduler.v1.IUpdateJobRequest): Promise<google.cloud.scheduler.v1.Job>;

Calls UpdateJob.

Parameter

Name	Description
request	`IUpdateJobRequest` UpdateJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.scheduler.v1.Job>	Promise