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\Spanner\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Spanner\ListScansResponse;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * The "scans" collection of methods.
|
---|
24 | * Typical usage is:
|
---|
25 | * <code>
|
---|
26 | * $spannerService = new Google\Service\Spanner(...);
|
---|
27 | * $scans = $spannerService->scans;
|
---|
28 | * </code>
|
---|
29 | */
|
---|
30 | class Scans extends \Google\Service\Resource
|
---|
31 | {
|
---|
32 | /**
|
---|
33 | * Return available scans given a Database-specific resource name.
|
---|
34 | * (scans.listScans)
|
---|
35 | *
|
---|
36 | * @param string $parent Required. The unique name of the parent resource,
|
---|
37 | * specific to the Database service implementing this interface.
|
---|
38 | * @param array $optParams Optional parameters.
|
---|
39 | *
|
---|
40 | * @opt_param string filter A filter expression to restrict the results based on
|
---|
41 | * information present in the available Scan collection. The filter applies to
|
---|
42 | * all fields within the Scan message except for `data`.
|
---|
43 | * @opt_param int pageSize The maximum number of items to return.
|
---|
44 | * @opt_param string pageToken The next_page_token value returned from a
|
---|
45 | * previous List request, if any.
|
---|
46 | * @opt_param string view Specifies which parts of the Scan should be returned
|
---|
47 | * in the response. Note, only the SUMMARY view (the default) is currently
|
---|
48 | * supported for ListScans.
|
---|
49 | * @return ListScansResponse
|
---|
50 | * @throws \Google\Service\Exception
|
---|
51 | */
|
---|
52 | public function listScans($parent, $optParams = [])
|
---|
53 | {
|
---|
54 | $params = ['parent' => $parent];
|
---|
55 | $params = array_merge($params, $optParams);
|
---|
56 | return $this->call('list', [$params], ListScansResponse::class);
|
---|
57 | }
|
---|
58 | }
|
---|
59 |
|
---|
60 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
61 | class_alias(Scans::class, 'Google_Service_Spanner_Resource_Scans');
|
---|