1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Genomics\Resource;
19
20use Google\Service\Genomics\Operation;
21use Google\Service\Genomics\RunPipelineRequest;
22
23/**
24 * The "pipelines" collection of methods.
25 * Typical usage is:
26 *  <code>
27 *   $genomicsService = new Google\Service\Genomics(...);
28 *   $pipelines = $genomicsService->pipelines;
29 *  </code>
30 */
31class Pipelines extends \Google\Service\Resource
32{
33  /**
34   * Runs a pipeline. The returned Operation's metadata field will contain a
35   * google.genomics.v2alpha1.Metadata object describing the status of the
36   * pipeline execution. The [response] field will contain a
37   * google.genomics.v2alpha1.RunPipelineResponse object if the pipeline completes
38   * successfully. **Note:** Before you can use this method, the Genomics Service
39   * Agent must have access to your project. This is done automatically when the
40   * Cloud Genomics API is first enabled, but if you delete this permission, or if
41   * you enabled the Cloud Genomics API before the v2alpha1 API launch, you must
42   * disable and re-enable the API to grant the Genomics Service Agent the
43   * required permissions. Authorization requires the following [Google
44   * IAM](https://cloud.google.com/iam/) permission: *
45   * `genomics.operations.create` [1]: /genomics/gsa (pipelines.run)
46   *
47   * @param RunPipelineRequest $postBody
48   * @param array $optParams Optional parameters.
49   * @return Operation
50   */
51  public function run(RunPipelineRequest $postBody, $optParams = [])
52  {
53    $params = ['postBody' => $postBody];
54    $params = array_merge($params, $optParams);
55    return $this->call('run', [$params], Operation::class);
56  }
57}
58
59// Adding a class alias for backwards compatibility with the previous class name.
60class_alias(Pipelines::class, 'Google_Service_Genomics_Resource_Pipelines');
61