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.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Dataflow \ V1beta3 \ ClientMethods
__construct
Constructor.
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 false
.
↳ 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 rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ 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.
The async variant is Google\Cloud\Dataflow\V1beta3\Client\BaseClient\self::aggregatedListJobsAsync() .
request
callOptions
array
Optional.
↳ 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.
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.
The async variant is Google\Cloud\Dataflow\V1beta3\Client\BaseClient\self::checkActiveJobsAsync() .
request
Google\Cloud\Dataflow\V1beta3\CheckActiveJobsRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ 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.
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
.
The async variant is Google\Cloud\Dataflow\V1beta3\Client\BaseClient\self::createJobAsync() .
request
callOptions
array
Optional.
↳ 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.
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
.
The async variant is Google\Cloud\Dataflow\V1beta3\Client\BaseClient\self::getJobAsync() .
request
callOptions
array
Optional.
↳ 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.
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
.
The async variant is Google\Cloud\Dataflow\V1beta3\Client\BaseClient\self::listJobsAsync() .
request
callOptions
array
Optional.
↳ 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.
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.
The async variant is Google\Cloud\Dataflow\V1beta3\Client\BaseClient\self::snapshotJobAsync() .
request
Google\Cloud\Dataflow\V1beta3\SnapshotJobRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ 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.
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
.
The async variant is Google\Cloud\Dataflow\V1beta3\Client\BaseClient\self::updateJobAsync() .
request
callOptions
array
Optional.
↳ 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.
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());
}
}
aggregatedListJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
checkActiveJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listJobsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
snapshotJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateJobAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
