Class protos.google.cloud.run.v2.Jobs (0.4.2)

Represents a Jobs

Inheritance

$protobuf. rpc.Service > protos.google.cloud.run.v2.Jobs

Package

@google-cloud/run

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Jobs service.

Parameters
Name
Description
rpcImpl
$protobuf. RPCImpl

RPC implementation

requestDelimited
boolean

Whether requests are length-delimited

responseDelimited
boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new Jobs service using the specified rpc implementation.

Parameters
Name
Description
rpcImpl
$protobuf. RPCImpl

RPC implementation

requestDelimited
boolean

Whether requests are length-delimited

responseDelimited
boolean

Whether responses are length-delimited

Returns
Type
Description
Jobs

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

createJob(request, callback)

  public 
  
 createJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ICreateJobRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Jobs 
 . 
 CreateJobCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls CreateJob.

Parameters
Name
Description
request
ICreateJobRequest

CreateJobRequest message or plain object

callback
google.cloud.run.v2.Jobs.CreateJobCallback

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

Returns
Type
Description
void

createJob(request)

  public 
  
 createJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ICreateJobRequest 
 ) 
 : 
  
 Promise<google 
 . 
 longrunning 
 . 
 Operation 
> ; 
 

Calls CreateJob.

Parameter
Name
Description
request
ICreateJobRequest

CreateJobRequest message or plain object

Returns
Type
Description
Promise < google.longrunning.Operation >

Promise

deleteJob(request, callback)

  public 
  
 deleteJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IDeleteJobRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Jobs 
 . 
 DeleteJobCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls DeleteJob.

Parameters
Name
Description
request
google.cloud.run.v2.IDeleteJobRequest

DeleteJobRequest message or plain object

callback
google.cloud.run.v2.Jobs.DeleteJobCallback

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

Returns
Type
Description
void

deleteJob(request)

  public 
  
 deleteJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IDeleteJobRequest 
 ) 
 : 
  
 Promise<google 
 . 
 longrunning 
 . 
 Operation 
> ; 
 

Calls DeleteJob.

Parameter
Name
Description
request
google.cloud.run.v2.IDeleteJobRequest

DeleteJobRequest message or plain object

Returns
Type
Description
Promise < google.longrunning.Operation >

Promise

getIamPolicy(request, callback)

  public 
  
 getIamPolicy 
 ( 
 request 
 : 
  
 google 
 . 
 iam 
 . 
 v1 
 . 
 IGetIamPolicyRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Jobs 
 . 
 GetIamPolicyCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls GetIamPolicy.

Parameters
Name
Description
request
IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

callback
google.cloud.run.v2.Jobs.GetIamPolicyCallback

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

Returns
Type
Description
void

getIamPolicy(request)

  public 
  
 getIamPolicy 
 ( 
 request 
 : 
  
 google 
 . 
 iam 
 . 
 v1 
 . 
 IGetIamPolicyRequest 
 ) 
 : 
  
 Promise<google 
 . 
 iam 
 . 
 v1 
 . 
 Policy 
> ; 
 

Calls GetIamPolicy.

Parameter
Name
Description
request
IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

Returns
Type
Description
Promise < google.iam.v1.Policy >

Promise

getJob(request, callback)

  public 
  
 getJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IGetJobRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Jobs 
 . 
 GetJobCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls GetJob.

Parameters
Name
Description
request
IGetJobRequest

GetJobRequest message or plain object

callback
google.cloud.run.v2.Jobs.GetJobCallback

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

Returns
Type
Description
void

getJob(request)

  public 
  
 getJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IGetJobRequest 
 ) 
 : 
  
 Promise<google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Job 
> ; 
 

Calls GetJob.

Parameter
Name
Description
request
IGetJobRequest

GetJobRequest message or plain object

Returns
Type
Description
Promise < google.cloud.run.v2.Job >

Promise

listJobs(request, callback)

  public 
  
 listJobs 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IListJobsRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Jobs 
 . 
 ListJobsCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls ListJobs.

Parameters
Name
Description
request
IListJobsRequest

ListJobsRequest message or plain object

callback
google.cloud.run.v2.Jobs.ListJobsCallback

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

Returns
Type
Description
void

listJobs(request)

  public 
  
 listJobs 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IListJobsRequest 
 ) 
 : 
  
 Promise<google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 ListJobsResponse 
> ; 
 

Calls ListJobs.

Parameter
Name
Description
request
IListJobsRequest

ListJobsRequest message or plain object

Returns
Type
Description
Promise < google.cloud.run.v2.ListJobsResponse >

Promise

runJob(request, callback)

  public 
  
 runJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IRunJobRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Jobs 
 . 
 RunJobCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls RunJob.

Parameters
Name
Description
request
IRunJobRequest

RunJobRequest message or plain object

callback
google.cloud.run.v2.Jobs.RunJobCallback

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

Returns
Type
Description
void

runJob(request)

  public 
  
 runJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IRunJobRequest 
 ) 
 : 
  
 Promise<google 
 . 
 longrunning 
 . 
 Operation 
> ; 
 

Calls RunJob.

Parameter
Name
Description
request
IRunJobRequest

RunJobRequest message or plain object

Returns
Type
Description
Promise < google.longrunning.Operation >

Promise

setIamPolicy(request, callback)

  public 
  
 setIamPolicy 
 ( 
 request 
 : 
  
 google 
 . 
 iam 
 . 
 v1 
 . 
 ISetIamPolicyRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Jobs 
 . 
 SetIamPolicyCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls SetIamPolicy.

Parameters
Name
Description
request
ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

callback
google.cloud.run.v2.Jobs.SetIamPolicyCallback

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

Returns
Type
Description
void

setIamPolicy(request)

  public 
  
 setIamPolicy 
 ( 
 request 
 : 
  
 google 
 . 
 iam 
 . 
 v1 
 . 
 ISetIamPolicyRequest 
 ) 
 : 
  
 Promise<google 
 . 
 iam 
 . 
 v1 
 . 
 Policy 
> ; 
 

Calls SetIamPolicy.

Parameter
Name
Description
request
ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

Returns
Type
Description
Promise < google.iam.v1.Policy >

Promise

testIamPermissions(request, callback)

  public 
  
 testIamPermissions 
 ( 
 request 
 : 
  
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Jobs 
 . 
 TestIamPermissionsCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls TestIamPermissions.

Parameters
Name
Description
request
google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

callback
google.cloud.run.v2.Jobs.TestIamPermissionsCallback

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

Returns
Type
Description
void

testIamPermissions(request)

  public 
  
 testIamPermissions 
 ( 
 request 
 : 
  
 google 
 . 
 iam 
 . 
 v1 
 . 
 ITestIamPermissionsRequest 
 ) 
 : 
  
 Promise<google 
 . 
 iam 
 . 
 v1 
 . 
 TestIamPermissionsResponse 
> ; 
 

Calls TestIamPermissions.

Parameter
Name
Description
request
google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

Returns
Type
Description
Promise < google.iam.v1.TestIamPermissionsResponse >

Promise

updateJob(request, callback)

  public 
  
 updateJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IUpdateJobRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 Jobs 
 . 
 UpdateJobCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls UpdateJob.

Parameters
Name
Description
request
IUpdateJobRequest

UpdateJobRequest message or plain object

callback
google.cloud.run.v2.Jobs.UpdateJobCallback

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

Returns
Type
Description
void

updateJob(request)

  public 
  
 updateJob 
 ( 
 request 
 : 
  
 google 
 . 
 cloud 
 . 
 run 
 . 
 v2 
 . 
 IUpdateJobRequest 
 ) 
 : 
  
 Promise<google 
 . 
 longrunning 
 . 
 Operation 
> ; 
 

Calls UpdateJob.

Parameter
Name
Description
request
IUpdateJobRequest

UpdateJobRequest message or plain object

Returns
Type
Description
Promise < google.longrunning.Operation >

Promise

Design a Mobile Site
View Site in Mobile | Classic
Share by: