Class v1.CloudSchedulerClient (2.2.6)

The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs. v1

Package

@google-cloud/scheduler!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of CloudSchedulerClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

cloudSchedulerStub

cloudSchedulerStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createJob(request, options)

createJob(request?: protos.google.cloud.scheduler.v1.ICreateJobRequest, options?: CallOptions): Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.ICreateJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.ICreateJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.ICreateJobRequest | undefined, {} | undefined]>

createJob(request, options, callback)

createJob(request: protos.google.cloud.scheduler.v1.ICreateJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.ICreateJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.ICreateJobRequest
options CallOptions
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.ICreateJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createJob(request, callback)

createJob(request: protos.google.cloud.scheduler.v1.ICreateJobRequest, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.ICreateJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.ICreateJobRequest
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.ICreateJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteJob(request, options)

deleteJob(request?: protos.google.cloud.scheduler.v1.IDeleteJobRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.scheduler.v1.IDeleteJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IDeleteJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.scheduler.v1.IDeleteJobRequest | undefined, {} | undefined]>

deleteJob(request, options, callback)

deleteJob(request: protos.google.cloud.scheduler.v1.IDeleteJobRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.scheduler.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IDeleteJobRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.scheduler.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteJob(request, callback)

deleteJob(request: protos.google.cloud.scheduler.v1.IDeleteJobRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.scheduler.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IDeleteJobRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.scheduler.v1.IDeleteJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getJob(request, options)

getJob(request?: protos.google.cloud.scheduler.v1.IGetJobRequest, options?: CallOptions): Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IGetJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IGetJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IGetJobRequest | undefined, {} | undefined]>

getJob(request, options, callback)

getJob(request: protos.google.cloud.scheduler.v1.IGetJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IGetJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IGetJobRequest
options CallOptions
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IGetJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getJob(request, callback)

getJob(request: protos.google.cloud.scheduler.v1.IGetJobRequest, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IGetJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IGetJobRequest
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IGetJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

jobPath(project, location, job)

jobPath(project: string, location: string, job: string): string;

Return a fully-qualified job resource name string.

Parameters
Name Description
project string
location string
job string
Returns
Type Description
string

{string} Resource name string.

listJobs(request, options)

listJobs(request?: protos.google.cloud.scheduler.v1.IListJobsRequest, options?: CallOptions): Promise<[protos.google.cloud.scheduler.v1.IJob[], protos.google.cloud.scheduler.v1.IListJobsRequest | null, protos.google.cloud.scheduler.v1.IListJobsResponse]>;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IListJobsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.scheduler.v1.IJob[], protos.google.cloud.scheduler.v1.IListJobsRequest | null, protos.google.cloud.scheduler.v1.IListJobsResponse]>

listJobs(request, options, callback)

listJobs(request: protos.google.cloud.scheduler.v1.IListJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.scheduler.v1.IListJobsRequest, protos.google.cloud.scheduler.v1.IListJobsResponse | null | undefined, protos.google.cloud.scheduler.v1.IJob>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IListJobsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.scheduler.v1.IListJobsRequest, protos.google.cloud.scheduler.v1.IListJobsResponse | null | undefined, protos.google.cloud.scheduler.v1.IJob>
Returns
Type Description
void

listJobs(request, callback)

listJobs(request: protos.google.cloud.scheduler.v1.IListJobsRequest, callback: PaginationCallback<protos.google.cloud.scheduler.v1.IListJobsRequest, protos.google.cloud.scheduler.v1.IListJobsResponse | null | undefined, protos.google.cloud.scheduler.v1.IJob>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IListJobsRequest
callback PaginationCallback<protos.google.cloud.scheduler.v1.IListJobsRequest, protos.google.cloud.scheduler.v1.IListJobsResponse | null | undefined, protos.google.cloud.scheduler.v1.IJob>
Returns
Type Description
void

listJobsAsync(request, options)

listJobsAsync(request?: protos.google.cloud.scheduler.v1.IListJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.scheduler.v1.IJob>;

Equivalent to listJobs, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.scheduler.v1.IListJobsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.scheduler.v1.IJob>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Job]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listJobsStream(request, options)

listJobsStream(request?: protos.google.cloud.scheduler.v1.IListJobsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.scheduler.v1.IListJobsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Job] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listJobsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchJobFromJobName(jobName)

matchJobFromJobName(jobName: string): string | number;

Parse the job from Job resource.

Parameter
Name Description
jobName string

A fully-qualified path representing Job resource.
Returns
Type Description
string | number

{string} A string representing the job.

matchLocationFromJobName(jobName)

matchLocationFromJobName(jobName: string): string | number;

Parse the location from Job resource.

Parameter
Name Description
jobName string

A fully-qualified path representing Job resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchProjectFromJobName(jobName)

matchProjectFromJobName(jobName: string): string | number;

Parse the project from Job resource.

Parameter
Name Description
jobName string

A fully-qualified path representing Job resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

pauseJob(request, options)

pauseJob(request?: protos.google.cloud.scheduler.v1.IPauseJobRequest, options?: CallOptions): Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IPauseJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IPauseJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IPauseJobRequest | undefined, {} | undefined]>

pauseJob(request, options, callback)

pauseJob(request: protos.google.cloud.scheduler.v1.IPauseJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IPauseJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IPauseJobRequest
options CallOptions
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IPauseJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

pauseJob(request, callback)

pauseJob(request: protos.google.cloud.scheduler.v1.IPauseJobRequest, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IPauseJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IPauseJobRequest
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IPauseJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

resumeJob(request, options)

resumeJob(request?: protos.google.cloud.scheduler.v1.IResumeJobRequest, options?: CallOptions): Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IResumeJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IResumeJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IResumeJobRequest | undefined, {} | undefined]>

resumeJob(request, options, callback)

resumeJob(request: protos.google.cloud.scheduler.v1.IResumeJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IResumeJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IResumeJobRequest
options CallOptions
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IResumeJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

resumeJob(request, callback)

resumeJob(request: protos.google.cloud.scheduler.v1.IResumeJobRequest, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IResumeJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IResumeJobRequest
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IResumeJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

runJob(request, options)

runJob(request?: protos.google.cloud.scheduler.v1.IRunJobRequest, options?: CallOptions): Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IRunJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IRunJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IRunJobRequest | undefined, {} | undefined]>

runJob(request, options, callback)

runJob(request: protos.google.cloud.scheduler.v1.IRunJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IRunJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IRunJobRequest
options CallOptions
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IRunJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

runJob(request, callback)

runJob(request: protos.google.cloud.scheduler.v1.IRunJobRequest, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IRunJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IRunJobRequest
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IRunJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateJob(request, options)

updateJob(request?: protos.google.cloud.scheduler.v1.IUpdateJobRequest, options?: CallOptions): Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IUpdateJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IUpdateJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IUpdateJobRequest | undefined, {} | undefined]>

updateJob(request, options, callback)

updateJob(request: protos.google.cloud.scheduler.v1.IUpdateJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IUpdateJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IUpdateJobRequest
options CallOptions
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IUpdateJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateJob(request, callback)

updateJob(request: protos.google.cloud.scheduler.v1.IUpdateJobRequest, callback: Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IUpdateJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.scheduler.v1.IUpdateJobRequest
callback Callback<protos.google.cloud.scheduler.v1.IJob, protos.google.cloud.scheduler.v1.IUpdateJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void