Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class JobsV1Beta3Client.
Service Description: Provides a method to create and modify Google Cloud Dataflow jobs.
A Job is a multi-stage computation graph run by the Cloud Dataflow service.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$jobsV1Beta3Client = new JobsV1Beta3Client();
try {
// Iterate over pages of elements
$pagedResponse = $jobsV1Beta3Client->aggregatedListJobs();
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $jobsV1Beta3Client->aggregatedListJobs();
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$jobsV1Beta3Client->close();
}
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
aggregatedListJobs
List the jobs of a project across all regions.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ filter |
int
The kind of filter to use. For allowed values, use constants defined on Google\Cloud\Dataflow\V1beta3\ListJobsRequest\Filter |
↳ projectId |
string
The project which owns the jobs. |
↳ view |
int
Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. For allowed values, use constants defined on Google\Cloud\Dataflow\V1beta3\JobView |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ location |
string
The regional endpoint that contains this job. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataflow\V1beta3\Client\JobsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\Job;
use Google\Cloud\Dataflow\V1beta3\ListJobsRequest;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function aggregated_list_jobs_sample(): void
{
// Create a client.
$jobsV1Beta3Client = new JobsV1Beta3Client();
// Prepare the request message.
$request = new ListJobsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $jobsV1Beta3Client->aggregatedListJobs($request);
/** @var Job $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
checkActiveJobs
Check for existence of active jobs in the given project across all regions.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ projectId |
string
The project which owns the jobs. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataflow\V1beta3\CheckActiveJobsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataflow\V1beta3\CheckActiveJobsRequest;
use Google\Cloud\Dataflow\V1beta3\CheckActiveJobsResponse;
use Google\Cloud\Dataflow\V1beta3\Client\JobsV1Beta3Client;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function check_active_jobs_sample(): void
{
// Create a client.
$jobsV1Beta3Client = new JobsV1Beta3Client();
// Prepare the request message.
$request = new CheckActiveJobsRequest();
// Call the API and handle any network failures.
try {
/** @var CheckActiveJobsResponse $response */
$response = $jobsV1Beta3Client->checkActiveJobs($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
createJob
Creates a Cloud Dataflow job.
To create a job, we recommend using projects.locations.jobs.create
with a
regional endpoint. Using
projects.jobs.create
is not recommended, as your job will always start
in us-central1
.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ projectId |
string
The ID of the Cloud Platform project that the job belongs to. |
↳ job |
Job
The job to create. |
↳ view |
int
The level of information requested in response. For allowed values, use constants defined on Google\Cloud\Dataflow\V1beta3\JobView |
↳ replaceJobId |
string
Deprecated. This field is now in the Job message. |
↳ location |
string
The regional endpoint that contains this job. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataflow\V1beta3\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataflow\V1beta3\Client\JobsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\CreateJobRequest;
use Google\Cloud\Dataflow\V1beta3\Job;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function create_job_sample(): void
{
// Create a client.
$jobsV1Beta3Client = new JobsV1Beta3Client();
// Prepare the request message.
$request = new CreateJobRequest();
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobsV1Beta3Client->createJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getJob
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. Using
projects.jobs.get
is not recommended, as you can only get the state of
jobs that are running in us-central1
.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ projectId |
string
The ID of the Cloud Platform project that the job belongs to. |
↳ jobId |
string
The job ID. |
↳ view |
int
The level of information requested in response. For allowed values, use constants defined on Google\Cloud\Dataflow\V1beta3\JobView |
↳ location |
string
The regional endpoint that contains this job. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataflow\V1beta3\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataflow\V1beta3\Client\JobsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\GetJobRequest;
use Google\Cloud\Dataflow\V1beta3\Job;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function get_job_sample(): void
{
// Create a client.
$jobsV1Beta3Client = new JobsV1Beta3Client();
// Prepare the request message.
$request = new GetJobRequest();
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobsV1Beta3Client->getJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listJobs
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. 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
.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ filter |
int
The kind of filter to use. For allowed values, use constants defined on Google\Cloud\Dataflow\V1beta3\ListJobsRequest\Filter |
↳ projectId |
string
The project which owns the jobs. |
↳ view |
int
Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. For allowed values, use constants defined on Google\Cloud\Dataflow\V1beta3\JobView |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ location |
string
The regional endpoint that contains this job. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataflow\V1beta3\Client\JobsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\Job;
use Google\Cloud\Dataflow\V1beta3\ListJobsRequest;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function list_jobs_sample(): void
{
// Create a client.
$jobsV1Beta3Client = new JobsV1Beta3Client();
// Prepare the request message.
$request = new ListJobsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $jobsV1Beta3Client->listJobs($request);
/** @var Job $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
snapshotJob
Snapshot the state of a streaming job.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ projectId |
string
The project which owns the job to be snapshotted. |
↳ jobId |
string
The job to be snapshotted. |
↳ ttl |
Duration
TTL for the snapshot. |
↳ location |
string
The location that contains this job. |
↳ snapshotSources |
bool
If true, perform snapshots for sources which support this. |
↳ description |
string
User specified description of the snapshot. Maybe empty. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataflow\V1beta3\Snapshot |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataflow\V1beta3\Client\JobsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\Snapshot;
use Google\Cloud\Dataflow\V1beta3\SnapshotJobRequest;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function snapshot_job_sample(): void
{
// Create a client.
$jobsV1Beta3Client = new JobsV1Beta3Client();
// Prepare the request message.
$request = new SnapshotJobRequest();
// Call the API and handle any network failures.
try {
/** @var Snapshot $response */
$response = $jobsV1Beta3Client->snapshotJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateJob
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. Using
projects.jobs.update
is not recommended, as you can only update the state
of jobs that are running in us-central1
.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ projectId |
string
The ID of the Cloud Platform project that the job belongs to. |
↳ jobId |
string
The job ID. |
↳ job |
Job
The updated job. Only the job state is updatable; other fields will be ignored. |
↳ location |
string
The regional endpoint that contains this job. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataflow\V1beta3\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataflow\V1beta3\Client\JobsV1Beta3Client;
use Google\Cloud\Dataflow\V1beta3\Job;
use Google\Cloud\Dataflow\V1beta3\UpdateJobRequest;
/**
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function update_job_sample(): void
{
// Create a client.
$jobsV1Beta3Client = new JobsV1Beta3Client();
// Prepare the request message.
$request = new UpdateJobRequest();
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobsV1Beta3Client->updateJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
Constants
SERVICE_NAME
Value: 'google.dataflow.v1beta3.JobsV1Beta3'
The name of the service.
SERVICE_ADDRESS
Value: 'dataflow.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.