Google_Service_Dataflow_ProjectsJobs_Resource Class Reference

The "jobs" collection of methods. More...

Inheritance diagram for Google_Service_Dataflow_ProjectsJobs_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	create ($projectId, Google_Service_Dataflow_Job $postBody, $optParams=array())
	Creates a dataflow job.
	get ($projectId, $jobId, $optParams=array())
	Gets the state of the specified dataflow job.
	getMetrics ($projectId, $jobId, $optParams=array())
	Request the job status.
	listProjectsJobs ($projectId, $optParams=array())
	List the jobs of a project (jobs.listProjectsJobs)
	update ($projectId, $jobId, Google_Service_Dataflow_Job $postBody, $optParams=array())
	Updates the state of an existing dataflow job.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "jobs" collection of methods.

Typical usage is: $dataflowService = new Google_Service_Dataflow(...); $jobs = $dataflowService->jobs;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

create()

Google_Service_Dataflow_ProjectsJobs_Resource::create	(		$projectId,
		Google_Service_Dataflow_Job	$postBody,
			$optParams = array() )

Creates a dataflow job.

(jobs.create)

Parameters

string	$projectId	The project which owns the job.
Google_Job	$postBody
array	$optParams	Optional parameters.

@opt_param string replaceJobId DEPRECATED. This field is now on the Job message. @opt_param string view Level of information requested in response.

Return values

Google_Service_Dataflow_Job

get()

Google_Service_Dataflow_ProjectsJobs_Resource::get	(		$projectId,
			$jobId,
			$optParams = array() )

Gets the state of the specified dataflow job.

(jobs.get)

Parameters

string	$projectId	The project which owns the job.
string	$jobId	Identifies a single job.
array	$optParams	Optional parameters.

@opt_param string view Level of information requested in response.

Return values

Google_Service_Dataflow_Job

getMetrics()

Google_Service_Dataflow_ProjectsJobs_Resource::getMetrics	(		$projectId,
			$jobId,
			$optParams = array() )

Request the job status.

(jobs.getMetrics)

Parameters

string	$projectId	A project id.
string	$jobId	The job to get messages for.
array	$optParams	Optional parameters.

@opt_param string startTime Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

Return values

Google_Service_Dataflow_JobMetrics

listProjectsJobs()

Google_Service_Dataflow_ProjectsJobs_Resource::listProjectsJobs	(		$projectId,
			$optParams = array() )

List the jobs of a project (jobs.listProjectsJobs)

Parameters

string	$projectId	The project which owns the jobs.
array	$optParams	Optional parameters.

@opt_param string pageToken Set this to the 'next_page_token' field of a previous response to request additional results in a long list. @opt_param int pageSize If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. @opt_param string view Level of information requested in response. Default is SUMMARY.

Return values

Google_Service_Dataflow_ListJobsResponse

update()

Google_Service_Dataflow_ProjectsJobs_Resource::update	(		$projectId,
			$jobId,
		Google_Service_Dataflow_Job	$postBody,
			$optParams = array() )

Updates the state of an existing dataflow job.

(jobs.update)

Parameters

string	$projectId	The project which owns the job.
string	$jobId	Identifies a single job.
Google_Job	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Dataflow_Job

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Dataflow.php