Class v2.JobsClient (1.0.2)

Cloud Run Job Control Plane API. v2

Package

@google-cloud/run

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of JobsClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new JobsClient({fallback: true}, gax); ```

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

jobsStub

jobsStub?: Promise<{
        [name: string]: Function;
    }>;

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
NameDescription
request CancelOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateJobProgress(name)

checkCreateJobProgress(name: string): Promise<LROperation<protos.google.cloud.run.v2.Job, protos.google.cloud.run.v2.Job>>;

Check the status of the long running operation returned by createJob().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.run.v2.Job, protos.google.cloud.run.v2.Job>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location and project in which this Job should be created.
   *  Format: projects/{project}/locations/{location}, where {project} can be
   *  project id or number.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Job instance to create.
   */
  // const job = {}
  /**
   *  Required. The unique identifier for the Job. The name of the job becomes
   *  {parent}/jobs/{job_id}.
   */
  // const jobId = 'abc123'
  /**
   *  Indicates that the request should be validated and default values
   *  populated, without persisting the request or creating any resources.
   */
  // const validateOnly = true

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callCreateJob() {
    // Construct request
    const request = {
      parent,
      job,
      jobId,
    };

    // Run request
    const [operation] = await runClient.createJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateJob();

checkDeleteJobProgress(name)

checkDeleteJobProgress(name: string): Promise<LROperation<protos.google.cloud.run.v2.Job, protos.google.cloud.run.v2.Job>>;

Check the status of the long running operation returned by deleteJob().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.run.v2.Job, protos.google.cloud.run.v2.Job>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The full name of the Job.
   *  Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
   *  can be project id or number.
   */
  // const name = 'abc123'
  /**
   *  Indicates that the request should be validated without actually
   *  deleting any resources.
   */
  // const validateOnly = true
  /**
   *  A system-generated fingerprint for this version of the
   *  resource. May be used to detect modification conflict during updates.
   */
  // const etag = 'abc123'

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callDeleteJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await runClient.deleteJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteJob();

checkRunJobProgress(name)

checkRunJobProgress(name: string): Promise<LROperation<protos.google.cloud.run.v2.Execution, protos.google.cloud.run.v2.Execution>>;

Check the status of the long running operation returned by runJob().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.run.v2.Execution, protos.google.cloud.run.v2.Execution>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The full name of the Job.
   *  Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
   *  can be project id or number.
   */
  // const name = 'abc123'
  /**
   *  Indicates that the request should be validated without actually
   *  deleting any resources.
   */
  // const validateOnly = true
  /**
   *  A system-generated fingerprint for this version of the
   *  resource. May be used to detect modification conflict during updates.
   */
  // const etag = 'abc123'
  /**
   *  Overrides specification for a given execution of a job. If provided,
   *  overrides will be applied to update the execution or task spec.
   */
  // const overrides = {}

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callRunJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await runClient.runJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRunJob();

checkUpdateJobProgress(name)

checkUpdateJobProgress(name: string): Promise<LROperation<protos.google.cloud.run.v2.Job, protos.google.cloud.run.v2.Job>>;

Check the status of the long running operation returned by updateJob().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.run.v2.Job, protos.google.cloud.run.v2.Job>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Job to be updated.
   */
  // const job = {}
  /**
   *  Indicates that the request should be validated and default values
   *  populated, without persisting the request or updating any resources.
   */
  // const validateOnly = true
  /**
   *  If set to true, and if the Job does not exist, it will create a new
   *  one. Caller must have both create and update permissions for this call if
   *  this is set to true.
   */
  // const allowMissing = true

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callUpdateJob() {
    // Construct request
    const request = {
      job,
    };

    // Run request
    const [operation] = await runClient.updateJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateJob();

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
TypeDescription
Promise<void>

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

createJob(request, options)

createJob(request?: protos.google.cloud.run.v2.ICreateJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a Job.

Parameters
NameDescription
request ICreateJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location and project in which this Job should be created.
   *  Format: projects/{project}/locations/{location}, where {project} can be
   *  project id or number.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Job instance to create.
   */
  // const job = {}
  /**
   *  Required. The unique identifier for the Job. The name of the job becomes
   *  {parent}/jobs/{job_id}.
   */
  // const jobId = 'abc123'
  /**
   *  Indicates that the request should be validated and default values
   *  populated, without persisting the request or creating any resources.
   */
  // const validateOnly = true

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callCreateJob() {
    // Construct request
    const request = {
      parent,
      job,
      jobId,
    };

    // Run request
    const [operation] = await runClient.createJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateJob();

createJob(request, options, callback)

createJob(request: protos.google.cloud.run.v2.ICreateJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateJobRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createJob(request, callback)

createJob(request: protos.google.cloud.run.v2.ICreateJobRequest, callback: Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateJobRequest
callback Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteJob(request, options)

deleteJob(request?: protos.google.cloud.run.v2.IDeleteJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a Job.

Parameters
NameDescription
request IDeleteJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The full name of the Job.
   *  Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
   *  can be project id or number.
   */
  // const name = 'abc123'
  /**
   *  Indicates that the request should be validated without actually
   *  deleting any resources.
   */
  // const validateOnly = true
  /**
   *  A system-generated fingerprint for this version of the
   *  resource. May be used to detect modification conflict during updates.
   */
  // const etag = 'abc123'

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callDeleteJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await runClient.deleteJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteJob();

deleteJob(request, options, callback)

deleteJob(request: protos.google.cloud.run.v2.IDeleteJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteJobRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteJob(request, callback)

deleteJob(request: protos.google.cloud.run.v2.IDeleteJobRequest, callback: Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteJobRequest
callback Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
NameDescription
request DeleteOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

executionPath(project, location, job, execution)

executionPath(project: string, location: string, job: string, execution: string): string;

Return a fully-qualified execution resource name string.

Parameters
NameDescription
project string
location string
job string
execution string
Returns
TypeDescription
string

{string} Resource name string.

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.IGetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.

Parameters
NameDescription
request IGetIamPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  OPTIONAL: A `GetPolicyOptions` object for specifying options to
   *  `GetIamPolicy`.
   */
  // const options = {}

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callGetIamPolicy() {
    // Construct request
    const request = {
      resource,
    };

    // Run request
    const response = await runClient.getIamPolicy(request);
    console.log(response);
  }

  callGetIamPolicy();

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getJob(request, options)

getJob(request?: protos.google.cloud.run.v2.IGetJobRequest, options?: CallOptions): Promise<[
        protos.google.cloud.run.v2.IJob,
        protos.google.cloud.run.v2.IGetJobRequest | undefined,
        {} | undefined
    ]>;

Gets information about a Job.

Parameters
NameDescription
request IGetJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IGetJobRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Job. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The full name of the Job.
   *  Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
   *  can be project id or number.
   */
  // const name = 'abc123'

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callGetJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await runClient.getJob(request);
    console.log(response);
  }

  callGetJob();

getJob(request, options, callback)

getJob(request: protos.google.cloud.run.v2.IGetJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IGetJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetJobRequest
options CallOptions
callback Callback<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IGetJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getJob(request, callback)

getJob(request: protos.google.cloud.run.v2.IGetJobRequest, callback: Callback<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IGetJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetJobRequest
callback Callback<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IGetJobRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

const [response] = await client.getLocation(request);

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
NameDescription
request GetOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
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
NameDescription
project string
location string
job string
Returns
TypeDescription
string

{string} Resource name string.

listJobs(request, options)

listJobs(request?: protos.google.cloud.run.v2.IListJobsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.run.v2.IJob[],
        protos.google.cloud.run.v2.IListJobsRequest | null,
        protos.google.cloud.run.v2.IListJobsResponse
    ]>;

Lists Jobs.

Parameters
NameDescription
request IListJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.run.v2.IJob[], protos.google.cloud.run.v2.IListJobsRequest | null, protos.google.cloud.run.v2.IListJobsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Job. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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 for more details and examples.

listJobs(request, options, callback)

listJobs(request: protos.google.cloud.run.v2.IListJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.run.v2.IListJobsRequest, protos.google.cloud.run.v2.IListJobsResponse | null | undefined, protos.google.cloud.run.v2.IJob>): void;
Parameters
NameDescription
request IListJobsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.run.v2.IListJobsRequest, protos.google.cloud.run.v2.IListJobsResponse | null | undefined, protos.google.cloud.run.v2.IJob>
Returns
TypeDescription
void

listJobs(request, callback)

listJobs(request: protos.google.cloud.run.v2.IListJobsRequest, callback: PaginationCallback<protos.google.cloud.run.v2.IListJobsRequest, protos.google.cloud.run.v2.IListJobsResponse | null | undefined, protos.google.cloud.run.v2.IJob>): void;
Parameters
NameDescription
request IListJobsRequest
callback PaginationCallback<protos.google.cloud.run.v2.IListJobsRequest, protos.google.cloud.run.v2.IListJobsResponse | null | undefined, protos.google.cloud.run.v2.IJob>
Returns
TypeDescription
void

listJobsAsync(request, options)

listJobsAsync(request?: protos.google.cloud.run.v2.IListJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.run.v2.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
NameDescription
request IListJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.run.v2.IJob>

{Object} An iterable Object that allows async iteration. 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location and project to list resources on.
   *  Format: projects/{project}/locations/{location}, where {project} can be
   *  project id or number.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of Jobs to return in this call.
   */
  // const pageSize = 1234
  /**
   *  A page token received from a previous call to ListJobs.
   *  All other parameters must match.
   */
  // const pageToken = 'abc123'
  /**
   *  If true, returns deleted (but unexpired) resources along with active ones.
   */
  // const showDeleted = true

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callListJobs() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await runClient.listJobsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListJobs();

listJobsStream(request, options)

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

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

Parameters
NameDescription
request IListJobsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
NameDescription
request ListOperationsRequest

The request object that will be sent.

options CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchExecutionFromExecutionName(executionName)

matchExecutionFromExecutionName(executionName: string): string | number;

Parse the execution from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the execution.

matchExecutionFromTaskName(taskName)

matchExecutionFromTaskName(taskName: string): string | number;

Parse the execution from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the execution.

matchJobFromExecutionName(executionName)

matchJobFromExecutionName(executionName: string): string | number;

Parse the job from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the job.

matchJobFromJobName(jobName)

matchJobFromJobName(jobName: string): string | number;

Parse the job from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the job.

matchJobFromTaskName(taskName)

matchJobFromTaskName(taskName: string): string | number;

Parse the job from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the job.

matchLocationFromExecutionName(executionName)

matchLocationFromExecutionName(executionName: string): string | number;

Parse the location from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromJobName(jobName)

matchLocationFromJobName(jobName: string): string | number;

Parse the location from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromRevisionName(revisionName)

matchLocationFromRevisionName(revisionName: string): string | number;

Parse the location from Revision resource.

Parameter
NameDescription
revisionName string

A fully-qualified path representing Revision resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromServiceName(serviceName)

matchLocationFromServiceName(serviceName: string): string | number;

Parse the location from Service resource.

Parameter
NameDescription
serviceName string

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTaskName(taskName)

matchLocationFromTaskName(taskName: string): string | number;

Parse the location from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromExecutionName(executionName)

matchProjectFromExecutionName(executionName: string): string | number;

Parse the project from Execution resource.

Parameter
NameDescription
executionName string

A fully-qualified path representing Execution resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromJobName(jobName)

matchProjectFromJobName(jobName: string): string | number;

Parse the project from Job resource.

Parameter
NameDescription
jobName string

A fully-qualified path representing Job resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromRevisionName(revisionName)

matchProjectFromRevisionName(revisionName: string): string | number;

Parse the project from Revision resource.

Parameter
NameDescription
revisionName string

A fully-qualified path representing Revision resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromServiceName(serviceName)

matchProjectFromServiceName(serviceName: string): string | number;

Parse the project from Service resource.

Parameter
NameDescription
serviceName string

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromTaskName(taskName)

matchProjectFromTaskName(taskName: string): string | number;

Parse the project from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchRevisionFromRevisionName(revisionName)

matchRevisionFromRevisionName(revisionName: string): string | number;

Parse the revision from Revision resource.

Parameter
NameDescription
revisionName string

A fully-qualified path representing Revision resource.

Returns
TypeDescription
string | number

{string} A string representing the revision.

matchServiceFromRevisionName(revisionName)

matchServiceFromRevisionName(revisionName: string): string | number;

Parse the service from Revision resource.

Parameter
NameDescription
revisionName string

A fully-qualified path representing Revision resource.

Returns
TypeDescription
string | number

{string} A string representing the service.

matchServiceFromServiceName(serviceName)

matchServiceFromServiceName(serviceName: string): string | number;

Parse the service from Service resource.

Parameter
NameDescription
serviceName string

A fully-qualified path representing Service resource.

Returns
TypeDescription
string | number

{string} A string representing the service.

matchTaskFromTaskName(taskName)

matchTaskFromTaskName(taskName: string): string | number;

Parse the task from Task resource.

Parameter
NameDescription
taskName string

A fully-qualified path representing Task resource.

Returns
TypeDescription
string | number

{string} A string representing the task.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

revisionPath(project, location, service, revision)

revisionPath(project: string, location: string, service: string, revision: string): string;

Return a fully-qualified revision resource name string.

Parameters
NameDescription
project string
location string
service string
revision string
Returns
TypeDescription
string

{string} Resource name string.

runJob(request, options)

runJob(request?: protos.google.cloud.run.v2.IRunJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.run.v2.IExecution, protos.google.cloud.run.v2.IExecution>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Triggers creation of a new Execution of this Job.

Parameters
NameDescription
request IRunJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.run.v2.IExecution, protos.google.cloud.run.v2.IExecution>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The full name of the Job.
   *  Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
   *  can be project id or number.
   */
  // const name = 'abc123'
  /**
   *  Indicates that the request should be validated without actually
   *  deleting any resources.
   */
  // const validateOnly = true
  /**
   *  A system-generated fingerprint for this version of the
   *  resource. May be used to detect modification conflict during updates.
   */
  // const etag = 'abc123'
  /**
   *  Overrides specification for a given execution of a job. If provided,
   *  overrides will be applied to update the execution or task spec.
   */
  // const overrides = {}

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callRunJob() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await runClient.runJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRunJob();

runJob(request, options, callback)

runJob(request: protos.google.cloud.run.v2.IRunJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.run.v2.IExecution, protos.google.cloud.run.v2.IExecution>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IRunJobRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.run.v2.IExecution, protos.google.cloud.run.v2.IExecution>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

runJob(request, callback)

runJob(request: protos.google.cloud.run.v2.IRunJobRequest, callback: Callback<LROperation<protos.google.cloud.run.v2.IExecution, protos.google.cloud.run.v2.IExecution>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IRunJobRequest
callback Callback<LROperation<protos.google.cloud.run.v2.IExecution, protos.google.cloud.run.v2.IExecution>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

servicePath(project, location, service)

servicePath(project: string, location: string, service: string): string;

Return a fully-qualified service resource name string.

Parameters
NameDescription
project string
location string
service string
Returns
TypeDescription
string

{string} Resource name string.

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.IPolicy,
        protos.google.iam.v1.ISetIamPolicyRequest | undefined,
        {} | undefined
    ]>;

Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.

Parameters
NameDescription
request ISetIamPolicyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Policy. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy is being specified.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  REQUIRED: The complete policy to be applied to the `resource`. The size of
   *  the policy is limited to a few 10s of KB. An empty policy is a
   *  valid policy but certain Cloud Platform services (such as Projects)
   *  might reject them.
   */
  // const policy = {}
  /**
   *  OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
   *  the fields in the mask will be modified. If no mask is provided, the
   *  following default mask is used:
   *  `paths: "bindings, etag"`
   */
  // const updateMask = {}

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callSetIamPolicy() {
    // Construct request
    const request = {
      resource,
      policy,
    };

    // Run request
    const response = await runClient.setIamPolicy(request);
    console.log(response);
  }

  callSetIamPolicy();

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ISetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ISetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

taskPath(project, location, job, execution, task)

taskPath(project: string, location: string, job: string, execution: string, task: string): string;

Return a fully-qualified task resource name string.

Parameters
NameDescription
project string
location string
job string
execution string
task string
Returns
TypeDescription
string

{string} Resource name string.

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[
        protos.google.iam.v1.ITestIamPermissionsResponse,
        protos.google.iam.v1.ITestIamPermissionsRequest | undefined,
        {} | undefined
    ]>;

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

Parameters
NameDescription
request ITestIamPermissionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy detail is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  The set of permissions to check for the `resource`. Permissions with
   *  wildcards (such as '*' or 'storage.*') are not allowed. For more
   *  information see
   *  IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
   */
  // const permissions = ['abc','def']

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callTestIamPermissions() {
    // Construct request
    const request = {
      resource,
      permissions,
    };

    // Run request
    const response = await runClient.testIamPermissions(request);
    console.log(response);
  }

  callTestIamPermissions();

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ITestIamPermissionsRequest
options CallOptions
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ITestIamPermissionsRequest
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateJob(request, options)

updateJob(request?: protos.google.cloud.run.v2.IUpdateJobRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a Job.

Parameters
NameDescription
request IUpdateJobRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Job to be updated.
   */
  // const job = {}
  /**
   *  Indicates that the request should be validated and default values
   *  populated, without persisting the request or updating any resources.
   */
  // const validateOnly = true
  /**
   *  If set to true, and if the Job does not exist, it will create a new
   *  one. Caller must have both create and update permissions for this call if
   *  this is set to true.
   */
  // const allowMissing = true

  // Imports the Run library
  const {JobsClient} = require('@google-cloud/run').v2;

  // Instantiates a client
  const runClient = new JobsClient();

  async function callUpdateJob() {
    // Construct request
    const request = {
      job,
    };

    // Run request
    const [operation] = await runClient.updateJob(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateJob();

updateJob(request, options, callback)

updateJob(request: protos.google.cloud.run.v2.IUpdateJobRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateJobRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateJob(request, callback)

updateJob(request: protos.google.cloud.run.v2.IUpdateJobRequest, callback: Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateJobRequest
callback Callback<LROperation<protos.google.cloud.run.v2.IJob, protos.google.cloud.run.v2.IJob>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void