Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class TemplatesServiceClient.
Service Description: Provides a method to create Cloud Dataflow jobs from templates.
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:
$templatesServiceClient = new TemplatesServiceClient();
try {
$response = $templatesServiceClient->createJobFromTemplate();
} finally {
$templatesServiceClient->close();
}
This service has a new (beta) implementation. See Google\Cloud\Dataflow\V1beta3\Client\TemplatesServiceClient to use the new surface.
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__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.
createJobFromTemplate
Creates a Cloud Dataflow job from a template.
optionalArgs
array
Optional.
↳ projectId
string
Required. The ID of the Cloud Platform project that the job belongs to.
↳ jobName
string
Required. The job name to use for the created job.
↳ gcsPath
string
Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with gs://
.
↳ parameters
array
The runtime parameters to pass to the job.
↳ environment
RuntimeEnvironment
The runtime environment for the job.
↳ location
↳ 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\TemplatesServiceClient;
use Google\Cloud\Dataflow\V1beta3\CreateJobFromTemplateRequest;
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_from_template_sample(): void
{
// Create a client.
$templatesServiceClient = new TemplatesServiceClient();
// Prepare the request message.
$request = new CreateJobFromTemplateRequest();
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $templatesServiceClient->createJobFromTemplate($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getTemplate
Get the template associated with a template.
optionalArgs
array
Optional.
↳ projectId
string
Required. The ID of the Cloud Platform project that the job belongs to.
↳ gcsPath
string
Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
↳ view
int
The view to retrieve. Defaults to METADATA_ONLY. For allowed values, use constants defined on Google\Cloud\Dataflow\V1beta3\GetTemplateRequest\TemplateView
↳ location
↳ 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\TemplatesServiceClient;
use Google\Cloud\Dataflow\V1beta3\GetTemplateRequest;
use Google\Cloud\Dataflow\V1beta3\GetTemplateResponse;
/**
* 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_template_sample(): void
{
// Create a client.
$templatesServiceClient = new TemplatesServiceClient();
// Prepare the request message.
$request = new GetTemplateRequest();
// Call the API and handle any network failures.
try {
/** @var GetTemplateResponse $response */
$response = $templatesServiceClient->getTemplate($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
launchTemplate
Launch a template.
optionalArgs
array
Optional.
↳ projectId
string
Required. The ID of the Cloud Platform project that the job belongs to.
↳ validateOnly
bool
If true, the request is validated but not actually executed. Defaults to false.
↳ gcsPath
string
A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
↳ dynamicTemplate
DynamicTemplateLaunchParams
Params for launching a dynamic template.
↳ launchParameters
LaunchTemplateParameters
The parameters of the template to launch. This should be part of the body of the POST request.
↳ location
↳ 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\TemplatesServiceClient;
use Google\Cloud\Dataflow\V1beta3\LaunchTemplateRequest;
use Google\Cloud\Dataflow\V1beta3\LaunchTemplateResponse;
/**
* 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 launch_template_sample(): void
{
// Create a client.
$templatesServiceClient = new TemplatesServiceClient();
// Prepare the request message.
$request = new LaunchTemplateRequest();
// Call the API and handle any network failures.
try {
/** @var LaunchTemplateResponse $response */
$response = $templatesServiceClient->launchTemplate($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.TemplatesService'
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.
