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 |
|
---|
18 | namespace Google\Service\CloudLifeSciences\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\CloudLifeSciences\Operation;
|
---|
21 | use Google\Service\CloudLifeSciences\RunPipelineRequest;
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * The "pipelines" collection of methods.
|
---|
25 | * Typical usage is:
|
---|
26 | * <code>
|
---|
27 | * $lifesciencesService = new Google\Service\CloudLifeSciences(...);
|
---|
28 | * $pipelines = $lifesciencesService->projects_locations_pipelines;
|
---|
29 | * </code>
|
---|
30 | */
|
---|
31 | class ProjectsLocationsPipelines extends \Google\Service\Resource
|
---|
32 | {
|
---|
33 | /**
|
---|
34 | * Runs a pipeline. The returned Operation's metadata field will contain a
|
---|
35 | * google.cloud.lifesciences.v2beta.Metadata object describing the status of the
|
---|
36 | * pipeline execution. The response field will contain a
|
---|
37 | * google.cloud.lifesciences.v2beta.RunPipelineResponse object if the pipeline
|
---|
38 | * completes successfully. **Note:** Before you can use this method, the *Life
|
---|
39 | * Sciences Service Agent* must have access to your project. This is done
|
---|
40 | * automatically when the Cloud Life Sciences API is first enabled, but if you
|
---|
41 | * delete this permission you must disable and re-enable the API to grant the
|
---|
42 | * Life Sciences Service Agent the required permissions. Authorization requires
|
---|
43 | * the following [Google IAM](https://cloud.google.com/iam/) permission: *
|
---|
44 | * `lifesciences.workflows.run` (pipelines.run)
|
---|
45 | *
|
---|
46 | * @param string $parent The project and location that this request should be
|
---|
47 | * executed against.
|
---|
48 | * @param RunPipelineRequest $postBody
|
---|
49 | * @param array $optParams Optional parameters.
|
---|
50 | * @return Operation
|
---|
51 | * @throws \Google\Service\Exception
|
---|
52 | */
|
---|
53 | public function run($parent, RunPipelineRequest $postBody, $optParams = [])
|
---|
54 | {
|
---|
55 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
56 | $params = array_merge($params, $optParams);
|
---|
57 | return $this->call('run', [$params], Operation::class);
|
---|
58 | }
|
---|
59 | }
|
---|
60 |
|
---|
61 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
62 | class_alias(ProjectsLocationsPipelines::class, 'Google_Service_CloudLifeSciences_Resource_ProjectsLocationsPipelines');
|
---|