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\GoogleAnalyticsAdmin\Resource;
19
20use Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse;
21use Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaWebDataStream;
22use Google\Service\GoogleAnalyticsAdmin\GoogleProtobufEmpty;
23
24/**
25 * The "webDataStreams" collection of methods.
26 * Typical usage is:
27 *  <code>
28 *   $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...);
29 *   $webDataStreams = $analyticsadminService->webDataStreams;
30 *  </code>
31 */
32class PropertiesWebDataStreams extends \Google\Service\Resource
33{
34  /**
35   * Creates a web stream with the specified location and attributes.
36   * (webDataStreams.create)
37   *
38   * @param string $parent Required. The parent resource where this web data
39   * stream will be created. Format: properties/123
40   * @param GoogleAnalyticsAdminV1alphaWebDataStream $postBody
41   * @param array $optParams Optional parameters.
42   * @return GoogleAnalyticsAdminV1alphaWebDataStream
43   */
44  public function create($parent, GoogleAnalyticsAdminV1alphaWebDataStream $postBody, $optParams = [])
45  {
46    $params = ['parent' => $parent, 'postBody' => $postBody];
47    $params = array_merge($params, $optParams);
48    return $this->call('create', [$params], GoogleAnalyticsAdminV1alphaWebDataStream::class);
49  }
50  /**
51   * Deletes a web stream on a property. (webDataStreams.delete)
52   *
53   * @param string $name Required. The name of the web data stream to delete.
54   * Format: properties/{property_id}/webDataStreams/{stream_id} Example:
55   * "properties/123/webDataStreams/456"
56   * @param array $optParams Optional parameters.
57   * @return GoogleProtobufEmpty
58   */
59  public function delete($name, $optParams = [])
60  {
61    $params = ['name' => $name];
62    $params = array_merge($params, $optParams);
63    return $this->call('delete', [$params], GoogleProtobufEmpty::class);
64  }
65  /**
66   * Lookup for a single WebDataStream (webDataStreams.get)
67   *
68   * @param string $name Required. The name of the web data stream to lookup.
69   * Format: properties/{property_id}/webDataStreams/{stream_id} Example:
70   * "properties/123/webDataStreams/456"
71   * @param array $optParams Optional parameters.
72   * @return GoogleAnalyticsAdminV1alphaWebDataStream
73   */
74  public function get($name, $optParams = [])
75  {
76    $params = ['name' => $name];
77    $params = array_merge($params, $optParams);
78    return $this->call('get', [$params], GoogleAnalyticsAdminV1alphaWebDataStream::class);
79  }
80  /**
81   * Returns child web data streams under the specified parent property. Web data
82   * streams will be excluded if the caller does not have access. Returns an empty
83   * list if no relevant web data streams are found.
84   * (webDataStreams.listPropertiesWebDataStreams)
85   *
86   * @param string $parent Required. The name of the parent property. For example,
87   * to list results of web streams under the property with Id 123:
88   * "properties/123"
89   * @param array $optParams Optional parameters.
90   *
91   * @opt_param int pageSize The maximum number of resources to return. If
92   * unspecified, at most 50 resources will be returned. The maximum value is 200;
93   * (higher values will be coerced to the maximum)
94   * @opt_param string pageToken A page token, received from a previous
95   * `ListWebDataStreams` call. Provide this to retrieve the subsequent page. When
96   * paginating, all other parameters provided to `ListWebDataStreams` must match
97   * the call that provided the page token.
98   * @return GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse
99   */
100  public function listPropertiesWebDataStreams($parent, $optParams = [])
101  {
102    $params = ['parent' => $parent];
103    $params = array_merge($params, $optParams);
104    return $this->call('list', [$params], GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse::class);
105  }
106  /**
107   * Updates a web stream on a property. (webDataStreams.patch)
108   *
109   * @param string $name Output only. Resource name of this Data Stream. Format:
110   * properties/{property_id}/webDataStreams/{stream_id} Example:
111   * "properties/1000/webDataStreams/2000"
112   * @param GoogleAnalyticsAdminV1alphaWebDataStream $postBody
113   * @param array $optParams Optional parameters.
114   *
115   * @opt_param string updateMask Required. The list of fields to be updated.
116   * Field names must be in snake case (e.g., "field_to_update"). Omitted fields
117   * will not be updated. To replace the entire entity, use one path with the
118   * string "*" to match all fields.
119   * @return GoogleAnalyticsAdminV1alphaWebDataStream
120   */
121  public function patch($name, GoogleAnalyticsAdminV1alphaWebDataStream $postBody, $optParams = [])
122  {
123    $params = ['name' => $name, 'postBody' => $postBody];
124    $params = array_merge($params, $optParams);
125    return $this->call('patch', [$params], GoogleAnalyticsAdminV1alphaWebDataStream::class);
126  }
127}
128
129// Adding a class alias for backwards compatibility with the previous class name.
130class_alias(PropertiesWebDataStreams::class, 'Google_Service_GoogleAnalyticsAdmin_Resource_PropertiesWebDataStreams');
131