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\CloudIot\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\CloudIot\ListDeviceStatesResponse;
|
---|
21 |
|
---|
22 | /**
|
---|
23 | * The "states" collection of methods.
|
---|
24 | * Typical usage is:
|
---|
25 | * <code>
|
---|
26 | * $cloudiotService = new Google\Service\CloudIot(...);
|
---|
27 | * $states = $cloudiotService->projects_locations_registries_devices_states;
|
---|
28 | * </code>
|
---|
29 | */
|
---|
30 | class ProjectsLocationsRegistriesDevicesStates extends \Google\Service\Resource
|
---|
31 | {
|
---|
32 | /**
|
---|
33 | * Lists the last few versions of the device state in descending order (i.e.:
|
---|
34 | * newest first). (states.listProjectsLocationsRegistriesDevicesStates)
|
---|
35 | *
|
---|
36 | * @param string $name Required. The name of the device. For example,
|
---|
37 | * `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
|
---|
38 | * `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
|
---|
39 | * @param array $optParams Optional parameters.
|
---|
40 | *
|
---|
41 | * @opt_param int numStates The number of states to list. States are listed in
|
---|
42 | * descending order of update time. The maximum number of states retained is 10.
|
---|
43 | * If this value is zero, it will return all the states available.
|
---|
44 | * @return ListDeviceStatesResponse
|
---|
45 | */
|
---|
46 | public function listProjectsLocationsRegistriesDevicesStates($name, $optParams = [])
|
---|
47 | {
|
---|
48 | $params = ['name' => $name];
|
---|
49 | $params = array_merge($params, $optParams);
|
---|
50 | return $this->call('list', [$params], ListDeviceStatesResponse::class);
|
---|
51 | }
|
---|
52 | }
|
---|
53 |
|
---|
54 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
55 | class_alias(ProjectsLocationsRegistriesDevicesStates::class, 'Google_Service_CloudIot_Resource_ProjectsLocationsRegistriesDevicesStates');
|
---|