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\Indexing\Resource;
19
20use Google\Service\Indexing\PublishUrlNotificationResponse;
21use Google\Service\Indexing\UrlNotification;
22use Google\Service\Indexing\UrlNotificationMetadata;
23
24/**
25 * The "urlNotifications" collection of methods.
26 * Typical usage is:
27 *  <code>
28 *   $indexingService = new Google\Service\Indexing(...);
29 *   $urlNotifications = $indexingService->urlNotifications;
30 *  </code>
31 */
32class UrlNotifications extends \Google\Service\Resource
33{
34  /**
35   * Gets metadata about a Web Document. This method can _only_ be used to query
36   * URLs that were previously seen in successful Indexing API notifications.
37   * Includes the latest `UrlNotification` received via this API.
38   * (urlNotifications.getMetadata)
39   *
40   * @param array $optParams Optional parameters.
41   *
42   * @opt_param string url URL that is being queried.
43   * @return UrlNotificationMetadata
44   */
45  public function getMetadata($optParams = [])
46  {
47    $params = [];
48    $params = array_merge($params, $optParams);
49    return $this->call('getMetadata', [$params], UrlNotificationMetadata::class);
50  }
51  /**
52   * Notifies that a URL has been updated or deleted. (urlNotifications.publish)
53   *
54   * @param UrlNotification $postBody
55   * @param array $optParams Optional parameters.
56   * @return PublishUrlNotificationResponse
57   */
58  public function publish(UrlNotification $postBody, $optParams = [])
59  {
60    $params = ['postBody' => $postBody];
61    $params = array_merge($params, $optParams);
62    return $this->call('publish', [$params], PublishUrlNotificationResponse::class);
63  }
64}
65
66// Adding a class alias for backwards compatibility with the previous class name.
67class_alias(UrlNotifications::class, 'Google_Service_Indexing_Resource_UrlNotifications');
68