Class ProjectsResource.LocationsResource.JobsResource

The "jobs" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.JobsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudScheduler.v1

Assembly: Google.Apis.CloudScheduler.v1.dll

Syntax

public class ProjectsResource.LocationsResource.JobsResource

Constructors

JobsResource(IClientService)

Constructs a new resource.

Declaration

public JobsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(Job, string)

Creates a job.

Declaration

public virtual ProjectsResource.LocationsResource.JobsResource.CreateRequest Create(Job body, string parent)

Parameters

Type	Name	Description
Job	body	The body of the request.
string	parent	Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.JobsResource.CreateRequest

Delete(string)

Deletes a job.

Declaration

public virtual ProjectsResource.LocationsResource.JobsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.JobsResource.DeleteRequest

Get(string)

Gets a job.

Declaration

public virtual ProjectsResource.LocationsResource.JobsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.JobsResource.GetRequest

List(string)

Lists jobs.

Declaration

public virtual ProjectsResource.LocationsResource.JobsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.JobsResource.ListRequest

Patch(Job, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.JobsResource.PatchRequest Patch(Job body, string name)

Parameters

Type	Name	Description
Job	body	The body of the request.
string	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 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.

Returns

Type	Description
ProjectsResource.LocationsResource.JobsResource.PatchRequest

Pause(PauseJobRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.JobsResource.PauseRequest Pause(PauseJobRequest body, string name)

Parameters

Type	Name	Description
PauseJobRequest	body	The body of the request.
string	name	Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.JobsResource.PauseRequest

Resume(ResumeJobRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.JobsResource.ResumeRequest Resume(ResumeJobRequest body, string name)

Parameters

Type	Name	Description
ResumeJobRequest	body	The body of the request.
string	name	Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.JobsResource.ResumeRequest

Run(RunJobRequest, string)

Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

Declaration

public virtual ProjectsResource.LocationsResource.JobsResource.RunRequest Run(RunJobRequest body, string name)

Parameters

Type	Name	Description
RunJobRequest	body	The body of the request.
string	name	Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

Returns

Type	Description
ProjectsResource.LocationsResource.JobsResource.RunRequest