Constructor
new CloudScheduler(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new CloudScheduler service.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Extends
- $protobuf.rpc.Service
Methods
createJob(request, callback) → {undefined}
Calls CreateJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.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 |
|---|---|
| undefined |
createJob(request) → {Promise.<google.cloud.scheduler.v1.Job>}
Calls CreateJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.ICreateJobRequest |
CreateJobRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.scheduler.v1.Job> |
Promise |
deleteJob(request, callback) → {undefined}
Calls DeleteJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.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 |
|---|---|
| undefined |
deleteJob(request) → {Promise.<google.protobuf.Empty>}
Calls DeleteJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.IDeleteJobRequest |
DeleteJobRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.protobuf.Empty> |
Promise |
getJob(request, callback) → {undefined}
Calls GetJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.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 |
|---|---|
| undefined |
getJob(request) → {Promise.<google.cloud.scheduler.v1.Job>}
Calls GetJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.IGetJobRequest |
GetJobRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.scheduler.v1.Job> |
Promise |
listJobs(request, callback) → {undefined}
Calls ListJobs.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.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 |
|---|---|
| undefined |
listJobs(request) → {Promise.<google.cloud.scheduler.v1.ListJobsResponse>}
Calls ListJobs.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.IListJobsRequest |
ListJobsRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.scheduler.v1.ListJobsResponse> |
Promise |
pauseJob(request, callback) → {undefined}
Calls PauseJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.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 |
|---|---|
| undefined |
pauseJob(request) → {Promise.<google.cloud.scheduler.v1.Job>}
Calls PauseJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.IPauseJobRequest |
PauseJobRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.scheduler.v1.Job> |
Promise |
resumeJob(request, callback) → {undefined}
Calls ResumeJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.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 |
|---|---|
| undefined |
resumeJob(request) → {Promise.<google.cloud.scheduler.v1.Job>}
Calls ResumeJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.IResumeJobRequest |
ResumeJobRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.scheduler.v1.Job> |
Promise |
runJob(request, callback) → {undefined}
Calls RunJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.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 |
|---|---|
| undefined |
runJob(request) → {Promise.<google.cloud.scheduler.v1.Job>}
Calls RunJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.IRunJobRequest |
RunJobRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.scheduler.v1.Job> |
Promise |
updateJob(request, callback) → {undefined}
Calls UpdateJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.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 |
|---|---|
| undefined |
updateJob(request) → {Promise.<google.cloud.scheduler.v1.Job>}
Calls UpdateJob.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.scheduler.v1.IUpdateJobRequest |
UpdateJobRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.scheduler.v1.Job> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {CloudScheduler}
Creates new CloudScheduler service using the specified rpc implementation.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Returns:
| Type | Description |
|---|---|
| CloudScheduler |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
CreateJobCallback(error, responseopt)
Callback as used by createJob.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.scheduler.v1.Job |
<optional> |
Job |
DeleteJobCallback(error, responseopt)
Callback as used by deleteJob.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.protobuf.Empty |
<optional> |
Empty |
GetJobCallback(error, responseopt)
Callback as used by getJob.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.scheduler.v1.Job |
<optional> |
Job |
ListJobsCallback(error, responseopt)
Callback as used by listJobs.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.scheduler.v1.ListJobsResponse |
<optional> |
ListJobsResponse |
PauseJobCallback(error, responseopt)
Callback as used by pauseJob.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.scheduler.v1.Job |
<optional> |
Job |
ResumeJobCallback(error, responseopt)
Callback as used by resumeJob.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.scheduler.v1.Job |
<optional> |
Job |
RunJobCallback(error, responseopt)
Callback as used by runJob.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.scheduler.v1.Job |
<optional> |
Job |
UpdateJobCallback(error, responseopt)
Callback as used by updateJob.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.scheduler.v1.Job |
<optional> |
Job |