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\GoogleCloudDatacatalogLineageV1ListProcessesResponse;
|
---|
21 | use Google\Service\Datalineage\GoogleCloudDatacatalogLineageV1Process;
|
---|
22 | use Google\Service\Datalineage\GoogleLongrunningOperation;
|
---|
23 |
|
---|
24 | /**
|
---|
25 | * The "processes" collection of methods.
|
---|
26 | * Typical usage is:
|
---|
27 | * <code>
|
---|
28 | * $datalineageService = new Google\Service\Datalineage(...);
|
---|
29 | * $processes = $datalineageService->projects_locations_processes;
|
---|
30 | * </code>
|
---|
31 | */
|
---|
32 | class ProjectsLocationsProcesses extends \Google\Service\Resource
|
---|
33 | {
|
---|
34 | /**
|
---|
35 | * Creates a new process. (processes.create)
|
---|
36 | *
|
---|
37 | * @param string $parent Required. The name of the project and its location that
|
---|
38 | * should own the process.
|
---|
39 | * @param GoogleCloudDatacatalogLineageV1Process $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 GoogleCloudDatacatalogLineageV1Process
|
---|
46 | * @throws \Google\Service\Exception
|
---|
47 | */
|
---|
48 | public function create($parent, GoogleCloudDatacatalogLineageV1Process $postBody, $optParams = [])
|
---|
49 | {
|
---|
50 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
51 | $params = array_merge($params, $optParams);
|
---|
52 | return $this->call('create', [$params], GoogleCloudDatacatalogLineageV1Process::class);
|
---|
53 | }
|
---|
54 | /**
|
---|
55 | * Deletes the process with the specified name. (processes.delete)
|
---|
56 | *
|
---|
57 | * @param string $name Required. The name of the process to delete.
|
---|
58 | * @param array $optParams Optional parameters.
|
---|
59 | *
|
---|
60 | * @opt_param bool allowMissing If set to true and the process 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 process. (processes.get)
|
---|
73 | *
|
---|
74 | * @param string $name Required. The name of the process to get.
|
---|
75 | * @param array $optParams Optional parameters.
|
---|
76 | * @return GoogleCloudDatacatalogLineageV1Process
|
---|
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], GoogleCloudDatacatalogLineageV1Process::class);
|
---|
84 | }
|
---|
85 | /**
|
---|
86 | * List processes in the given project and location. List order is descending by
|
---|
87 | * insertion time. (processes.listProjectsLocationsProcesses)
|
---|
88 | *
|
---|
89 | * @param string $parent Required. The name of the project and its location that
|
---|
90 | * owns this collection of processes.
|
---|
91 | * @param array $optParams Optional parameters.
|
---|
92 | *
|
---|
93 | * @opt_param int pageSize The maximum number of processes to return. The
|
---|
94 | * service may return fewer than this value. If unspecified, at most 50
|
---|
95 | * processes are returned. The maximum value is 100; values greater than 100 are
|
---|
96 | * cut to 100.
|
---|
97 | * @opt_param string pageToken The page token received from a previous
|
---|
98 | * `ListProcesses` call. Specify it to get the next page. When paginating, all
|
---|
99 | * other parameters specified in this call must match the parameters of the call
|
---|
100 | * that provided the page token.
|
---|
101 | * @return GoogleCloudDatacatalogLineageV1ListProcessesResponse
|
---|
102 | * @throws \Google\Service\Exception
|
---|
103 | */
|
---|
104 | public function listProjectsLocationsProcesses($parent, $optParams = [])
|
---|
105 | {
|
---|
106 | $params = ['parent' => $parent];
|
---|
107 | $params = array_merge($params, $optParams);
|
---|
108 | return $this->call('list', [$params], GoogleCloudDatacatalogLineageV1ListProcessesResponse::class);
|
---|
109 | }
|
---|
110 | /**
|
---|
111 | * Updates a process. (processes.patch)
|
---|
112 | *
|
---|
113 | * @param string $name Immutable. The resource name of the lineage process.
|
---|
114 | * Format: `projects/{project}/locations/{location}/processes/{process}`. Can be
|
---|
115 | * specified or auto-assigned. {process} must be not longer than 200 characters
|
---|
116 | * and only contain characters in a set: `a-zA-Z0-9_-:.`
|
---|
117 | * @param GoogleCloudDatacatalogLineageV1Process $postBody
|
---|
118 | * @param array $optParams Optional parameters.
|
---|
119 | *
|
---|
120 | * @opt_param bool allowMissing If set to true and the process is not found, the
|
---|
121 | * request inserts it.
|
---|
122 | * @opt_param string updateMask The list of fields to update. Currently not
|
---|
123 | * used. The whole message is updated.
|
---|
124 | * @return GoogleCloudDatacatalogLineageV1Process
|
---|
125 | * @throws \Google\Service\Exception
|
---|
126 | */
|
---|
127 | public function patch($name, GoogleCloudDatacatalogLineageV1Process $postBody, $optParams = [])
|
---|
128 | {
|
---|
129 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
130 | $params = array_merge($params, $optParams);
|
---|
131 | return $this->call('patch', [$params], GoogleCloudDatacatalogLineageV1Process::class);
|
---|
132 | }
|
---|
133 | }
|
---|
134 |
|
---|
135 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
136 | class_alias(ProjectsLocationsProcesses::class, 'Google_Service_Datalineage_Resource_ProjectsLocationsProcesses');
|
---|