CloudScheduler

google.cloud.scheduler.v1beta1. CloudScheduler

Represents a CloudScheduler

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

(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

createJob(request, callback) → {undefined}

Calls CreateJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.ICreateJobRequest

CreateJobRequest message or plain object

callback google.cloud.scheduler.v1beta1.CloudScheduler.CreateJobCallback

Node-style callback called with the error, if any, and Job

createJob(request) → {Promise.<google.cloud.scheduler.v1beta1.Job>}

Calls CreateJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.ICreateJobRequest

CreateJobRequest message or plain object

deleteJob(request, callback) → {undefined}

Calls DeleteJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IDeleteJobRequest

DeleteJobRequest message or plain object

callback google.cloud.scheduler.v1beta1.CloudScheduler.DeleteJobCallback

Node-style callback called with the error, if any, and Empty

deleteJob(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IDeleteJobRequest

DeleteJobRequest message or plain object

getJob(request, callback) → {undefined}

Calls GetJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IGetJobRequest

GetJobRequest message or plain object

callback google.cloud.scheduler.v1beta1.CloudScheduler.GetJobCallback

Node-style callback called with the error, if any, and Job

getJob(request) → {Promise.<google.cloud.scheduler.v1beta1.Job>}

Calls GetJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IGetJobRequest

GetJobRequest message or plain object

listJobs(request, callback) → {undefined}

Calls ListJobs.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IListJobsRequest

ListJobsRequest message or plain object

callback google.cloud.scheduler.v1beta1.CloudScheduler.ListJobsCallback

Node-style callback called with the error, if any, and ListJobsResponse

listJobs(request) → {Promise.<google.cloud.scheduler.v1beta1.ListJobsResponse>}

Calls ListJobs.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IListJobsRequest

ListJobsRequest message or plain object

pauseJob(request, callback) → {undefined}

Calls PauseJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IPauseJobRequest

PauseJobRequest message or plain object

callback google.cloud.scheduler.v1beta1.CloudScheduler.PauseJobCallback

Node-style callback called with the error, if any, and Job

pauseJob(request) → {Promise.<google.cloud.scheduler.v1beta1.Job>}

Calls PauseJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IPauseJobRequest

PauseJobRequest message or plain object

resumeJob(request, callback) → {undefined}

Calls ResumeJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IResumeJobRequest

ResumeJobRequest message or plain object

callback google.cloud.scheduler.v1beta1.CloudScheduler.ResumeJobCallback

Node-style callback called with the error, if any, and Job

resumeJob(request) → {Promise.<google.cloud.scheduler.v1beta1.Job>}

Calls ResumeJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IResumeJobRequest

ResumeJobRequest message or plain object

runJob(request, callback) → {undefined}

Calls RunJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IRunJobRequest

RunJobRequest message or plain object

callback google.cloud.scheduler.v1beta1.CloudScheduler.RunJobCallback

Node-style callback called with the error, if any, and Job

runJob(request) → {Promise.<google.cloud.scheduler.v1beta1.Job>}

Calls RunJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IRunJobRequest

RunJobRequest message or plain object

updateJob(request, callback) → {undefined}

Calls UpdateJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IUpdateJobRequest

UpdateJobRequest message or plain object

callback google.cloud.scheduler.v1beta1.CloudScheduler.UpdateJobCallback

Node-style callback called with the error, if any, and Job

updateJob(request) → {Promise.<google.cloud.scheduler.v1beta1.Job>}

Calls UpdateJob.

Parameters:
Name Type Description
request google.cloud.scheduler.v1beta1.IUpdateJobRequest

UpdateJobRequest message or plain object

Type Definitions

CreateJobCallback(error, responseopt)

Callback as used by google.cloud.scheduler.v1beta1.CloudScheduler#createJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.scheduler.v1beta1.Job <optional>

Job

DeleteJobCallback(error, responseopt)

Callback as used by google.cloud.scheduler.v1beta1.CloudScheduler#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 google.cloud.scheduler.v1beta1.CloudScheduler#getJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.scheduler.v1beta1.Job <optional>

Job

ListJobsCallback(error, responseopt)

Callback as used by google.cloud.scheduler.v1beta1.CloudScheduler#listJobs.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.scheduler.v1beta1.ListJobsResponse <optional>

ListJobsResponse

PauseJobCallback(error, responseopt)

Callback as used by google.cloud.scheduler.v1beta1.CloudScheduler#pauseJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.scheduler.v1beta1.Job <optional>

Job

ResumeJobCallback(error, responseopt)

Callback as used by google.cloud.scheduler.v1beta1.CloudScheduler#resumeJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.scheduler.v1beta1.Job <optional>

Job

RunJobCallback(error, responseopt)

Callback as used by google.cloud.scheduler.v1beta1.CloudScheduler#runJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.scheduler.v1beta1.Job <optional>

Job

UpdateJobCallback(error, responseopt)

Callback as used by google.cloud.scheduler.v1beta1.CloudScheduler#updateJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.scheduler.v1beta1.Job <optional>

Job