Documentation

Google_Service_CloudScheduler_Resource_ProjectsLocationsJobs extends Google_Service_Resource
in package

Application

The "jobs" collection of methods.

Typical usage is: $cloudschedulerService = new Google_Service_CloudScheduler(...); $jobs = $cloudschedulerService->jobs;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_CloudScheduler_Job: Creates a job. (jobs.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_CloudScheduler_CloudschedulerEmpty: Deletes a job. (jobs.delete)
get() : Google_Service_CloudScheduler_Job: Gets a job. (jobs.get)
listProjectsLocationsJobs() : Google_Service_CloudScheduler_ListJobsResponse: Lists jobs. (jobs.listProjectsLocationsJobs)
patch() : Google_Service_CloudScheduler_Job: 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.
pause() : Google_Service_CloudScheduler_Job: 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. (jobs.pause)
resume() : Google_Service_CloudScheduler_Job: Resume a job. This method reenables a job after it has been Job.State.PAUSED.
run() : Google_Service_CloudScheduler_Job: Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. (jobs.run)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a job. (jobs.create)


    public
                create(string $parent, Google_Service_CloudScheduler_Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudScheduler_Job

Parameters

$parent : string: Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.
$postBody : Google_Service_CloudScheduler_Job
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudScheduler_Job —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deletes a job. (jobs.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudScheduler_CloudschedulerEmpty

Parameters

$name : string: Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudScheduler_CloudschedulerEmpty —

get()

Gets a job. (jobs.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudScheduler_Job

Parameters

$name : string: Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudScheduler_Job —

listProjectsLocationsJobs()

Lists jobs. (jobs.listProjectsLocationsJobs)


    public
                listProjectsLocationsJobs(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudScheduler_ListJobsResponse

Parameters

$parent : string: Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudScheduler_ListJobsResponse —

patch()

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.


    public
                patch(string $name, Google_Service_CloudScheduler_Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudScheduler_Job

A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received. (jobs.patch)

Parameters

$name : string: 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.
$postBody : Google_Service_CloudScheduler_Job
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudScheduler_Job —

pause()

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. (jobs.pause)


    public
                pause(string $name, Google_Service_CloudScheduler_PauseJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudScheduler_Job

Parameters

$name : string: Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
$postBody : Google_Service_CloudScheduler_PauseJobRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudScheduler_Job —

resume()

Resume a job. This method reenables a job after it has been Job.State.PAUSED.


    public
                resume(string $name, Google_Service_CloudScheduler_ResumeJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudScheduler_Job

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. (jobs.resume)

Parameters

$name : string: Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
$postBody : Google_Service_CloudScheduler_ResumeJobRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudScheduler_Job —

run()

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


    public
                run(string $name, Google_Service_CloudScheduler_RunJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudScheduler_Job

Parameters

$name : string: Required. The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.
$postBody : Google_Service_CloudScheduler_RunJobRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudScheduler_Job —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —