Documentation

Google_Service_Dataproc_Resource_ProjectsRegionsJobs extends Google_Service_Resource
in package

Application

The "jobs" collection of methods.

Typical usage is: $dataprocService = new Google_Service_Dataproc(...); $jobs = $dataprocService->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.
cancel() : Google_Service_Dataproc_Job: Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/datap roc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/r est/v1/projects.regions.jobs/get). (jobs.cancel)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Dataproc_DataprocEmpty: Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION. (jobs.delete)
get() : Google_Service_Dataproc_Job: Gets the resource representation for a job in a project. (jobs.get)
getIamPolicy() : Google_Service_Dataproc_Policy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (jobs.getIamPolicy)
listProjectsRegionsJobs() : Google_Service_Dataproc_ListJobsResponse: Lists regions/{region}/jobs in a project. (jobs.listProjectsRegionsJobs)
patch() : Google_Service_Dataproc_Job: Updates a job in a project. (jobs.patch)
setIamPolicy() : Google_Service_Dataproc_Policy: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (jobs.setIamPolicy)
submit() : Google_Service_Dataproc_Job: Submits a job to a cluster. (jobs.submit)
submitAsOperation() : Google_Service_Dataproc_Operation: Submits job to a cluster. (jobs.submitAsOperation)
testIamPermissions() : Google_Service_Dataproc_TestIamPermissionsResponse: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
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 —

cancel()

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/datap roc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/r est/v1/projects.regions.jobs/get). (jobs.cancel)


    public
                cancel(string $projectId, string $region, string $jobId, Google_Service_Dataproc_CancelJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Job

Parameters

$projectId : string: Required. The ID of the Google Cloud Platform project that the job belongs to.
$region : string: Required. The Dataproc region in which to handle the request.
$jobId : string: Required. The job ID.
$postBody : Google_Service_Dataproc_CancelJobRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_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 the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION. (jobs.delete)


    public
                delete(string $projectId, string $region, string $jobId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_DataprocEmpty

Parameters

$projectId : string: Required. The ID of the Google Cloud Platform project that the job belongs to.
$region : string: Required. The Dataproc region in which to handle the request.
$jobId : string: Required. The job ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_DataprocEmpty —

get()

Gets the resource representation for a job in a project. (jobs.get)


    public
                get(string $projectId, string $region, string $jobId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Job

Parameters

$projectId : string: Required. The ID of the Google Cloud Platform project that the job belongs to.
$region : string: Required. The Dataproc region in which to handle the request.
$jobId : string: Required. The job ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Job —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (jobs.getIamPolicy)


    public
                getIamPolicy(string $resource, Google_Service_Dataproc_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Policy —

listProjectsRegionsJobs()

Lists regions/{region}/jobs in a project. (jobs.listProjectsRegionsJobs)


    public
                listProjectsRegionsJobs(string $projectId, string $region[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_ListJobsResponse

Parameters

$projectId : string: Required. The ID of the Google Cloud Platform project that the job belongs to.
$region : string: Required. The Dataproc region in which to handle the request.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_ListJobsResponse —

patch()

Updates a job in a project. (jobs.patch)


    public
                patch(string $projectId, string $region, string $jobId, Google_Service_Dataproc_Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Job

Parameters

$projectId : string: Required. The ID of the Google Cloud Platform project that the job belongs to.
$region : string: Required. The Dataproc region in which to handle the request.
$jobId : string: Required. The job ID.
$postBody : Google_Service_Dataproc_Job
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Job —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (jobs.setIamPolicy)


    public
                setIamPolicy(string $resource, Google_Service_Dataproc_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Policy —

submit()

Submits a job to a cluster. (jobs.submit)


    public
                submit(string $projectId, string $region, Google_Service_Dataproc_SubmitJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Job

Parameters

$projectId : string: Required. The ID of the Google Cloud Platform project that the job belongs to.
$region : string: Required. The Dataproc region in which to handle the request.
$postBody : Google_Service_Dataproc_SubmitJobRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Job —

submitAsOperation()

Submits job to a cluster. (jobs.submitAsOperation)


    public
                submitAsOperation(string $projectId, string $region, Google_Service_Dataproc_SubmitJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Operation

Parameters

$projectId : string: Required. The ID of the Google Cloud Platform project that the job belongs to.
$region : string: Required. The Dataproc region in which to handle the request.
$postBody : Google_Service_Dataproc_SubmitJobRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Operation —

testIamPermissions()

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.


    public
                testIamPermissions(string $resource, Google_Service_Dataproc_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_TestIamPermissionsResponse

This operation may "fail open" without warning. (jobs.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_TestIamPermissionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —