source: vendor/google/apiclient-services/src/ChromeManagement/Resource/CustomersProfiles.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 10 days ago

Upload project files

  • Property mode set to 100644
File size: 5.3 KB
Line 
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
18namespace Google\Service\ChromeManagement\Resource;
19
20use Google\Service\ChromeManagement\GoogleChromeManagementVersionsV1ChromeBrowserProfile;
21use Google\Service\ChromeManagement\GoogleChromeManagementVersionsV1ListChromeBrowserProfilesResponse;
22use Google\Service\ChromeManagement\GoogleProtobufEmpty;
23
24/**
25 * The "profiles" collection of methods.
26 * Typical usage is:
27 * <code>
28 * $chromemanagementService = new Google\Service\ChromeManagement(...);
29 * $profiles = $chromemanagementService->customers_profiles;
30 * </code>
31 */
32class CustomersProfiles extends \Google\Service\Resource
33{
34 /**
35 * Deletes the data collected from a Chrome browser profile. (profiles.delete)
36 *
37 * @param string $name Required. Format:
38 * customers/{customer_id}/profiles/{profile_permanent_id}
39 * @param array $optParams Optional parameters.
40 * @return GoogleProtobufEmpty
41 * @throws \Google\Service\Exception
42 */
43 public function delete($name, $optParams = [])
44 {
45 $params = ['name' => $name];
46 $params = array_merge($params, $optParams);
47 return $this->call('delete', [$params], GoogleProtobufEmpty::class);
48 }
49 /**
50 * Gets a Chrome browser profile with customer ID and profile permanent ID.
51 * (profiles.get)
52 *
53 * @param string $name Required. Format:
54 * customers/{customer_id}/profiles/{profile_permanent_id}
55 * @param array $optParams Optional parameters.
56 * @return GoogleChromeManagementVersionsV1ChromeBrowserProfile
57 * @throws \Google\Service\Exception
58 */
59 public function get($name, $optParams = [])
60 {
61 $params = ['name' => $name];
62 $params = array_merge($params, $optParams);
63 return $this->call('get', [$params], GoogleChromeManagementVersionsV1ChromeBrowserProfile::class);
64 }
65 /**
66 * Lists Chrome browser profiles of a customer based on the given search and
67 * sorting criteria. (profiles.listCustomersProfiles)
68 *
69 * @param string $parent Required. Format: customers/{customer_id}
70 * @param array $optParams Optional parameters.
71 *
72 * @opt_param string filter Optional. The filter used to filter profiles. The
73 * following fields can be used in the filter: - profile_id - display_name -
74 * user_email - last_activity_time - last_policy_sync_time -
75 * last_status_report_time - first_enrollment_time - os_platform_type -
76 * os_version - browser_version - browser_channel - policy_count -
77 * extension_count - identity_provider - affiliation_state - ouId Any of the
78 * above fields can be used to specify a filter, and filtering by multiple
79 * fields is supported with AND operator. String type fields and enum type
80 * fields support '=' and '!=' operators. The integer type and the timestamp
81 * type fields support '=', '!=', '<', '>', '<=' and '>=' operators. Timestamps
82 * expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00).
83 * Wildcard '*' can be used with a string type field filter. In addition, string
84 * literal filtering is also supported, for example, 'ABC' as a filter maps to a
85 * filter that checks if any of the filterable string type fields contains
86 * 'ABC'. Organization unit number can be used as a filtering criteria here by
87 * specifying 'ouId = ${your_org_unit_id}', please note that only single OU ID
88 * matching is supported.
89 * @opt_param string orderBy Optional. The fields used to specify the ordering
90 * of the results. The supported fields are: - profile_id - display_name -
91 * user_email - last_activity_time - last_policy_sync_time -
92 * last_status_report_time - first_enrollment_time - os_platform_type -
93 * os_version - browser_version - browser_channel - policy_count -
94 * extension_count - identity_provider - affiliation_state By default, sorting
95 * is in ascending order, to specify descending order for a field, a suffix "
96 * desc" should be added to the field name. The default ordering is the
97 * descending order of last_status_report_time.
98 * @opt_param int pageSize Optional. The maximum number of profiles to return.
99 * The default page size is 100 if page_size is unspecified, and the maximum
100 * page size allowed is 200.
101 * @opt_param string pageToken Optional. The page token used to retrieve a
102 * specific page of the listing request.
103 * @return GoogleChromeManagementVersionsV1ListChromeBrowserProfilesResponse
104 * @throws \Google\Service\Exception
105 */
106 public function listCustomersProfiles($parent, $optParams = [])
107 {
108 $params = ['parent' => $parent];
109 $params = array_merge($params, $optParams);
110 return $this->call('list', [$params], GoogleChromeManagementVersionsV1ListChromeBrowserProfilesResponse::class);
111 }
112}
113
114// Adding a class alias for backwards compatibility with the previous class name.
115class_alias(CustomersProfiles::class, 'Google_Service_ChromeManagement_Resource_CustomersProfiles');
Note: See TracBrowser for help on using the repository browser.