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\Datalineage\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Datalineage\GoogleCloudDatacatalogLineageV1ListRunsResponse;
|
---|
21 | use Google\Service\Datalineage\GoogleCloudDatacatalogLineageV1Run;
|
---|
22 | use Google\Service\Datalineage\GoogleLongrunningOperation;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "runs" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $datalineageService = new Google\Service\Datalineage(...);
|
---|
29 | * $runs = $datalineageService->projects_locations_processes_runs;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class ProjectsLocationsProcessesRuns extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Creates a new run. (runs.create)
|
---|
36 | *
|
---|
37 | * @param string $parent Required. The name of the process that should own the
|
---|
38 | * run.
|
---|
39 | * @param GoogleCloudDatacatalogLineageV1Run $postBody
|
---|
40 | * @param array $optParams Optional parameters.
|
---|
41 | *
|
---|
42 | * @opt_param string requestId A unique identifier for this request. Restricted
|
---|
43 | * to 36 ASCII characters. A random UUID is recommended. This request is
|
---|
44 | * idempotent only if a `request_id` is provided.
|
---|
45 | * @return GoogleCloudDatacatalogLineageV1Run
|
---|
46 | * @throws \Google\Service\Exception
|
---|
47 | */
|
---|
48 | public function create($parent, GoogleCloudDatacatalogLineageV1Run $postBody, $optParams = [])
|
---|
49 | {
|
---|
50 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
51 | $params = array_merge($params, $optParams);
|
---|
52 | return $this->call('create', [$params], GoogleCloudDatacatalogLineageV1Run::class);
|
---|
53 | }
|
---|
54 | /**
|
---|
55 | * Deletes the run with the specified name. (runs.delete)
|
---|
56 | *
|
---|
57 | * @param string $name Required. The name of the run to delete.
|
---|
58 | * @param array $optParams Optional parameters.
|
---|
59 | *
|
---|
60 | * @opt_param bool allowMissing If set to true and the run is not found, the
|
---|
61 | * request succeeds but the server doesn't perform any actions.
|
---|
62 | * @return GoogleLongrunningOperation
|
---|
63 | * @throws \Google\Service\Exception
|
---|
64 | */
|
---|
65 | public function delete($name, $optParams = [])
|
---|
66 | {
|
---|
67 | $params = ['name' => $name];
|
---|
68 | $params = array_merge($params, $optParams);
|
---|
69 | return $this->call('delete', [$params], GoogleLongrunningOperation::class);
|
---|
70 | }
|
---|
71 | /**
|
---|
72 | * Gets the details of the specified run. (runs.get)
|
---|
73 | *
|
---|
74 | * @param string $name Required. The name of the run to get.
|
---|
75 | * @param array $optParams Optional parameters.
|
---|
76 | * @return GoogleCloudDatacatalogLineageV1Run
|
---|
77 | * @throws \Google\Service\Exception
|
---|
78 | */
|
---|
79 | public function get($name, $optParams = [])
|
---|
80 | {
|
---|
81 | $params = ['name' => $name];
|
---|
82 | $params = array_merge($params, $optParams);
|
---|
83 | return $this->call('get', [$params], GoogleCloudDatacatalogLineageV1Run::class);
|
---|
84 | }
|
---|
85 | /**
|
---|
86 | * Lists runs in the given project and location. List order is descending by
|
---|
87 | * `start_time`. (runs.listProjectsLocationsProcessesRuns)
|
---|
88 | *
|
---|
89 | * @param string $parent Required. The name of process that owns this collection
|
---|
90 | * of runs.
|
---|
91 | * @param array $optParams Optional parameters.
|
---|
92 | *
|
---|
93 | * @opt_param int pageSize The maximum number of runs to return. The service may
|
---|
94 | * return fewer than this value. If unspecified, at most 50 runs are returned.
|
---|
95 | * The maximum value is 100; values greater than 100 are cut to 100.
|
---|
96 | * @opt_param string pageToken The page token received from a previous
|
---|
97 | * `ListRuns` call. Specify it to get the next page. When paginating, all other
|
---|
98 | * parameters specified in this call must match the parameters of the call that
|
---|
99 | * provided the page token.
|
---|
100 | * @return GoogleCloudDatacatalogLineageV1ListRunsResponse
|
---|
101 | * @throws \Google\Service\Exception
|
---|
102 | */
|
---|
103 | public function listProjectsLocationsProcessesRuns($parent, $optParams = [])
|
---|
104 | {
|
---|
105 | $params = ['parent' => $parent];
|
---|
106 | $params = array_merge($params, $optParams);
|
---|
107 | return $this->call('list', [$params], GoogleCloudDatacatalogLineageV1ListRunsResponse::class);
|
---|
108 | }
|
---|
109 | /**
|
---|
110 | * Updates a run. (runs.patch)
|
---|
111 | *
|
---|
112 | * @param string $name Immutable. The resource name of the run. Format:
|
---|
113 | * `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can
|
---|
114 | * be specified or auto-assigned. {run} must be not longer than 200 characters
|
---|
115 | * and only contain characters in a set: `a-zA-Z0-9_-:.`
|
---|
116 | * @param GoogleCloudDatacatalogLineageV1Run $postBody
|
---|
117 | * @param array $optParams Optional parameters.
|
---|
118 | *
|
---|
119 | * @opt_param bool allowMissing If set to true and the run is not found, the
|
---|
120 | * request creates it.
|
---|
121 | * @opt_param string updateMask The list of fields to update. Currently not
|
---|
122 | * used. The whole message is updated.
|
---|
123 | * @return GoogleCloudDatacatalogLineageV1Run
|
---|
124 | * @throws \Google\Service\Exception
|
---|
125 | */
|
---|
126 | public function patch($name, GoogleCloudDatacatalogLineageV1Run $postBody, $optParams = [])
|
---|
127 | {
|
---|
128 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
129 | $params = array_merge($params, $optParams);
|
---|
130 | return $this->call('patch', [$params], GoogleCloudDatacatalogLineageV1Run::class);
|
---|
131 | }
|
---|
132 | }
|
---|
133 |
|
---|
134 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
135 | class_alias(ProjectsLocationsProcessesRuns::class, 'Google_Service_Datalineage_Resource_ProjectsLocationsProcessesRuns');
|
---|