Documentation

Google_Service_Dataflow_Resource_ProjectsLocationsJobs extends Google_Service_Resource
in package

Application

The "jobs" collection of methods.

Typical usage is: $dataflowService = new Google_Service_Dataflow(...); $jobs = $dataflowService->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_Dataflow_Job: Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. (jobs.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_Dataflow_Job: Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. (jobs.get)
getExecutionDetails() : Google_Service_Dataflow_JobExecutionDetails: Request detailed information about the execution status of the job.
getMetrics() : Google_Service_Dataflow_JobMetrics: Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. (jobs.getMetrics)
listProjectsLocationsJobs() : Google_Service_Dataflow_ListJobsResponse: List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`. (jobs.listProjectsLocationsJobs)
snapshot() : Google_Service_Dataflow_Snapshot: Snapshot the state of a streaming job. (jobs.snapshot)
update() : Google_Service_Dataflow_Job: Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts /regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`.
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 Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. (jobs.create)


    public
                create(string $projectId, string $location, Google_Service_Dataflow_Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_Job

Parameters

$projectId : string: The ID of the Cloud Platform project that the job belongs to.
$location : string: The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
$postBody : Google_Service_Dataflow_Job
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_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

get()

Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. (jobs.get)


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

Parameters

$projectId : string: The ID of the Cloud Platform project that the job belongs to.
$location : string: The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
$jobId : string: The job ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_Job —

getExecutionDetails()

Request detailed information about the execution status of the job.


    public
                getExecutionDetails(string $projectId, string $location, string $jobId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_JobExecutionDetails

EXPERIMENTAL. This API is subject to change or removal without notice. (jobs.getExecutionDetails)

Parameters

$projectId : string: A project id.
$location : string: The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
$jobId : string: The job to get execution details for.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_JobExecutionDetails —

getMetrics()

Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. (jobs.getMetrics)


    public
                getMetrics(string $projectId, string $location, string $jobId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_JobMetrics

Parameters

$projectId : string: A project id.
$location : string: The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
$jobId : string: The job to get metrics for.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_JobMetrics —

listProjectsLocationsJobs()

List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`. (jobs.listProjectsLocationsJobs)


    public
                listProjectsLocationsJobs(string $projectId, string $location[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_ListJobsResponse

Parameters

$projectId : string: The project which owns the jobs.
$location : string: The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_ListJobsResponse —

snapshot()

Snapshot the state of a streaming job. (jobs.snapshot)


    public
                snapshot(string $projectId, string $location, string $jobId, Google_Service_Dataflow_SnapshotJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_Snapshot

Parameters

$projectId : string: The project which owns the job to be snapshotted.
$location : string: The location that contains this job.
$jobId : string: The job to be snapshotted.
$postBody : Google_Service_Dataflow_SnapshotJobRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_Snapshot —

update()

Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts /regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`.


    public
                update(string $projectId, string $location, string $jobId, Google_Service_Dataflow_Job $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_Job

(jobs.update)

Parameters

$projectId : string: The ID of the Cloud Platform project that the job belongs to.
$location : string: The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
$jobId : string: The job ID.
$postBody : Google_Service_Dataflow_Job
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataflow_Job —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —