ProjectsLocationsJobs
class ProjectsLocationsJobs extends Resource (View source)
The "jobs" collection of methods.
Typical usage is:
$dataflowService = new Google\Service\Dataflow(...);
$jobs = $dataflowService->projects_locations_jobs;Methods
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. Do not enter confidential information when you supply string
values using the API. (jobs.create)
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)
Request detailed information about the execution status of the job.
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)
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, because you can only get the list of
jobs that are running in us-central1. projects.locations.jobs.list and
projects.jobs.list support filtering the list of jobs by name. Filtering by
name isn't supported by projects.jobs.aggregated.
Snapshot the state of a streaming job. (jobs.snapshot)
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. (jobs.update)
Details
Job
create(string $projectId, string $location, Job $postBody, array $optParams = [])
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. Do not enter confidential information when you supply string
values using the API. (jobs.create)
Job
get(string $projectId, string $location, string $jobId, array $optParams = [])
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)
JobExecutionDetails
getExecutionDetails(string $projectId, string $location, string $jobId, array $optParams = [])
Request detailed information about the execution status of the job.
EXPERIMENTAL. This API is subject to change or removal without notice. (jobs.getExecutionDetails)
JobMetrics
getMetrics(string $projectId, string $location, string $jobId, array $optParams = [])
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)
ListJobsResponse
listProjectsLocationsJobs(string $projectId, string $location, array $optParams = [])
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, because you can only get the list of
jobs that are running in us-central1. projects.locations.jobs.list and
projects.jobs.list support filtering the list of jobs by name. Filtering by
name isn't supported by projects.jobs.aggregated.
(jobs.listProjectsLocationsJobs)
Snapshot
snapshot(string $projectId, string $location, string $jobId, SnapshotJobRequest $postBody, array $optParams = [])
Snapshot the state of a streaming job. (jobs.snapshot)
Job
update(string $projectId, string $location, string $jobId, Job $postBody, array $optParams = [])
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. (jobs.update)