• Home
• com.google.apis
• google-api-services-cloudscheduler
• v1-rev20241203-2.0.0
• source code
• CloudScheduler.Projects.Locations.Jobs.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.cloudscheduler.v1.CloudScheduler.Projects.Locations.Jobs.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.cloudscheduler.v1
Class CloudScheduler.Projects.Locations.Jobs



java.lang.Object


com.google.api.services.cloudscheduler.v1.CloudScheduler.Projects.Locations.Jobs







Enclosing class:
CloudScheduler.Projects.Locations




public class CloudScheduler.Projects.Locations.Jobs
extends Object
The "jobs" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
CloudScheduler.Projects.Locations.Jobs.Create 


class 
CloudScheduler.Projects.Locations.Jobs.Delete 


class 
CloudScheduler.Projects.Locations.Jobs.Get 


class 
CloudScheduler.Projects.Locations.Jobs.List 


class 
CloudScheduler.Projects.Locations.Jobs.Patch 


class 
CloudScheduler.Projects.Locations.Jobs.Pause 


class 
CloudScheduler.Projects.Locations.Jobs.Resume 


class 
CloudScheduler.Projects.Locations.Jobs.Run 









Constructor Summary

Constructors 

Constructor and Description


Jobs() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CloudScheduler.Projects.Locations.Jobs.Create
create(String parent,
      Job content)
Creates a job.



CloudScheduler.Projects.Locations.Jobs.Delete
delete(String name)
Deletes a job.



CloudScheduler.Projects.Locations.Jobs.Get
get(String name)
Gets a job.



CloudScheduler.Projects.Locations.Jobs.List
list(String parent)
Lists jobs.



CloudScheduler.Projects.Locations.Jobs.Patch
patch(String name,
     Job content)
Updates a job.



CloudScheduler.Projects.Locations.Jobs.Pause
pause(String name,
     PauseJobRequest content)
Pauses a job.



CloudScheduler.Projects.Locations.Jobs.Resume
resume(String name,
      ResumeJobRequest content)
Resume a job.



CloudScheduler.Projects.Locations.Jobs.Run
run(String name,
   RunJobRequest content)
Forces a job to run now.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Jobs
public Jobs()









Method Detail





create
public CloudScheduler.Projects.Locations.Jobs.Create create(String parent,
                                                            Job content)
                                                     throws IOException
Creates a job.

 Create a request for the method "jobs.create".

 This request holds the parameters needed by the cloudscheduler server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
content - the Job
Returns:
the request
Throws:
IOException








delete
public CloudScheduler.Projects.Locations.Jobs.Delete delete(String name)
                                                     throws IOException
Deletes a job.

 Create a request for the method "jobs.delete".

 This request holds the parameters needed by the cloudscheduler server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Returns:
the request
Throws:
IOException








get
public CloudScheduler.Projects.Locations.Jobs.Get get(String name)
                                               throws IOException
Gets a job.

 Create a request for the method "jobs.get".

 This request holds the parameters needed by the cloudscheduler server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
Returns:
the request
Throws:
IOException








list
public CloudScheduler.Projects.Locations.Jobs.List list(String parent)
                                                 throws IOException
Lists jobs.

 Create a request for the method "jobs.list".

 This request holds the parameters needed by the cloudscheduler server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.
Returns:
the request
Throws:
IOException








patch
public CloudScheduler.Projects.Locations.Jobs.Patch patch(String name,
                                                          Job content)
                                                   throws IOException
Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND`
 is returned. If UpdateJob does not successfully return, it is possible for the job to be in an
 Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry
 the UpdateJob request until a successful response is received.

 Create a request for the method "jobs.patch".

 This request holds the parameters needed by the cloudscheduler server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For
        example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can
        contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For
        more information, see [Identifying projects](https://cloud.google.com/resource-
        manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the
        canonical ID for the job's location. The list of available locations can be obtained by
        calling ListLocations. For more information, see
        https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]),
        numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
content - the Job
Returns:
the request
Throws:
IOException








pause
public CloudScheduler.Projects.Locations.Jobs.Pause pause(String name,
                                                          PauseJobRequest content)
                                                   throws IOException
Pauses a job. If a job is paused then the system will stop executing the job until it is re-
 enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to
 Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

 Create a request for the method "jobs.pause".

 This request holds the parameters needed by the cloudscheduler server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
content - the PauseJobRequest
Returns:
the request
Throws:
IOException








resume
public CloudScheduler.Projects.Locations.Jobs.Resume resume(String name,
                                                            ResumeJobRequest content)
                                                     throws IOException
Resume a job. This method reenables a job after it has been Job.State.PAUSED. The state of a job
 is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must
 be in Job.State.PAUSED to be resumed.

 Create a request for the method "jobs.resume".

 This request holds the parameters needed by the cloudscheduler server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
content - the ResumeJobRequest
Returns:
the request
Throws:
IOException








run
public CloudScheduler.Projects.Locations.Jobs.Run run(String name,
                                                      RunJobRequest content)
                                               throws IOException
Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even
 if the job is already running.

 Create a request for the method "jobs.run".

 This request holds the parameters needed by the cloudscheduler server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
content - the RunJobRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.