File "ProjectsLocationsTemplates.php"
Full Path: /home/palsarh/web/palsarh.in/public_html/vendor/google/apiclient-services/src/Dataflow/Resource/ProjectsLocationsTemplates.php
File size: 5.55 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Dataflow\Resource;
use Google\Service\Dataflow\CreateJobFromTemplateRequest;
use Google\Service\Dataflow\GetTemplateResponse;
use Google\Service\Dataflow\Job;
use Google\Service\Dataflow\LaunchTemplateParameters;
use Google\Service\Dataflow\LaunchTemplateResponse;
/**
* The "templates" collection of methods.
* Typical usage is:
* <code>
* $dataflowService = new Google\Service\Dataflow(...);
* $templates = $dataflowService->projects_locations_templates;
* </code>
*/
class ProjectsLocationsTemplates extends \Google\Service\Resource
{
/**
* Creates a Cloud Dataflow job from a template. Do not enter confidential
* information when you supply string values using the API. To create a job, we
* recommend using `projects.locations.templates.create` with a [regional
* endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
* endpoints). Using `projects.templates.create` is not recommended, because
* your job will always start in `us-central1`. (templates.create)
*
* @param string $projectId Required. The ID of the Cloud Platform project that
* the job belongs to.
* @param string $location The [regional endpoint]
* (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which
* to direct the request.
* @param CreateJobFromTemplateRequest $postBody
* @param array $optParams Optional parameters.
* @return Job
* @throws \Google\Service\Exception
*/
public function create($projectId, $location, CreateJobFromTemplateRequest $postBody, $optParams = [])
{
$params = ['projectId' => $projectId, 'location' => $location, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Job::class);
}
/**
* Get the template associated with a template. To get the template, we
* recommend using `projects.locations.templates.get` with a [regional endpoint]
* (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
* `projects.templates.get` is not recommended, because only templates that are
* running in `us-central1` are retrieved. (templates.get)
*
* @param string $projectId Required. The ID of the Cloud Platform project that
* the job belongs to.
* @param string $location The [regional endpoint]
* (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which
* to direct the request.
* @param array $optParams Optional parameters.
*
* @opt_param string gcsPath Required. A Cloud Storage path to the template from
* which to create the job. Must be valid Cloud Storage URL, beginning with
* 'gs://'.
* @opt_param string view The view to retrieve. Defaults to METADATA_ONLY.
* @return GetTemplateResponse
* @throws \Google\Service\Exception
*/
public function get($projectId, $location, $optParams = [])
{
$params = ['projectId' => $projectId, 'location' => $location];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], GetTemplateResponse::class);
}
/**
* Launches a template. To launch a template, we recommend using
* `projects.locations.templates.launch` with a [regional endpoint]
* (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using
* `projects.templates.launch` is not recommended, because jobs launched from
* the template will always start in `us-central1`. (templates.launch)
*
* @param string $projectId Required. The ID of the Cloud Platform project that
* the job belongs to.
* @param string $location The [regional endpoint]
* (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which
* to direct the request.
* @param LaunchTemplateParameters $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string dynamicTemplate.gcsPath Path to the dynamic template
* specification file on Cloud Storage. The file must be a JSON serialized
* `DynamicTemplateFileSpec` object.
* @opt_param string dynamicTemplate.stagingLocation Cloud Storage path for
* staging dependencies. Must be a valid Cloud Storage URL, beginning with
* `gs://`.
* @opt_param string gcsPath A Cloud Storage path to the template to use to
* create the job. Must be valid Cloud Storage URL, beginning with `gs://`.
* @opt_param bool validateOnly If true, the request is validated but not
* actually executed. Defaults to false.
* @return LaunchTemplateResponse
* @throws \Google\Service\Exception
*/
public function launch($projectId, $location, LaunchTemplateParameters $postBody, $optParams = [])
{
$params = ['projectId' => $projectId, 'location' => $location, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('launch', [$params], LaunchTemplateResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsLocationsTemplates::class, 'Google_Service_Dataflow_Resource_ProjectsLocationsTemplates');