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\Apigee\Resource;
19
20use Google\Service\Apigee\GoogleCloudApigeeV1Schema;
21
22/**
23 * The "admin" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $apigeeService = new Google\Service\Apigee(...);
27 *   $admin = $apigeeService->admin;
28 *  </code>
29 */
30class OrganizationsEnvironmentsAnalyticsAdmin extends \Google\Service\Resource
31{
32  /**
33   * Gets a list of metrics and dimensions that can be used to create analytics
34   * queries and reports. Each schema element contains the name of the field, its
35   * associated type, and a flag indicating whether it is a standard or custom
36   * field. (admin.getSchemav2)
37   *
38   * @param string $name Required. Path to the schema. Use the following structure
39   * in your request:
40   * `organizations/{org}/environments/{env}/analytics/admin/schemav2`.
41   * @param array $optParams Optional parameters.
42   *
43   * @opt_param bool disableCache Flag that specifies whether the schema is be
44   * read from the database or cache. Set to `true` to read the schema from the
45   * database. Defaults to cache.
46   * @opt_param string type Required. Name of the dataset for which you want to
47   * retrieve the schema. For example: `fact` or `agg_cus1`
48   * @return GoogleCloudApigeeV1Schema
49   */
50  public function getSchemav2($name, $optParams = [])
51  {
52    $params = ['name' => $name];
53    $params = array_merge($params, $optParams);
54    return $this->call('getSchemav2', [$params], GoogleCloudApigeeV1Schema::class);
55  }
56}
57
58// Adding a class alias for backwards compatibility with the previous class name.
59class_alias(OrganizationsEnvironmentsAnalyticsAdmin::class, 'Google_Service_Apigee_Resource_OrganizationsEnvironmentsAnalyticsAdmin');
60