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\GoogleCloudApigeeV1Export;
21use Google\Service\Apigee\GoogleCloudApigeeV1ExportRequest;
22use Google\Service\Apigee\GoogleCloudApigeeV1ListExportsResponse;
23
24/**
25 * The "exports" collection of methods.
26 * Typical usage is:
27 *  <code>
28 *   $apigeeService = new Google\Service\Apigee(...);
29 *   $exports = $apigeeService->exports;
30 *  </code>
31 */
32class OrganizationsEnvironmentsAnalyticsExports extends \Google\Service\Resource
33{
34  /**
35   * Submit a data export job to be processed in the background. If the request is
36   * successful, the API returns a 201 status, a URI that can be used to retrieve
37   * the status of the export job, and the `state` value of "enqueued".
38   * (exports.create)
39   *
40   * @param string $parent Required. Names of the parent organization and
41   * environment. Must be of the form `organizations/{org}/environments/{env}`.
42   * @param GoogleCloudApigeeV1ExportRequest $postBody
43   * @param array $optParams Optional parameters.
44   * @return GoogleCloudApigeeV1Export
45   */
46  public function create($parent, GoogleCloudApigeeV1ExportRequest $postBody, $optParams = [])
47  {
48    $params = ['parent' => $parent, 'postBody' => $postBody];
49    $params = array_merge($params, $optParams);
50    return $this->call('create', [$params], GoogleCloudApigeeV1Export::class);
51  }
52  /**
53   * Gets the details and status of an analytics export job. If the export job is
54   * still in progress, its `state` is set to "running". After the export job has
55   * completed successfully, its `state` is set to "completed". If the export job
56   * fails, its `state` is set to `failed`. (exports.get)
57   *
58   * @param string $name Required. Resource name of the export to get.
59   * @param array $optParams Optional parameters.
60   * @return GoogleCloudApigeeV1Export
61   */
62  public function get($name, $optParams = [])
63  {
64    $params = ['name' => $name];
65    $params = array_merge($params, $optParams);
66    return $this->call('get', [$params], GoogleCloudApigeeV1Export::class);
67  }
68  /**
69   * Lists the details and status of all analytics export jobs belonging to the
70   * parent organization and environment.
71   * (exports.listOrganizationsEnvironmentsAnalyticsExports)
72   *
73   * @param string $parent Required. Names of the parent organization and
74   * environment. Must be of the form `organizations/{org}/environments/{env}`.
75   * @param array $optParams Optional parameters.
76   * @return GoogleCloudApigeeV1ListExportsResponse
77   */
78  public function listOrganizationsEnvironmentsAnalyticsExports($parent, $optParams = [])
79  {
80    $params = ['parent' => $parent];
81    $params = array_merge($params, $optParams);
82    return $this->call('list', [$params], GoogleCloudApigeeV1ListExportsResponse::class);
83  }
84}
85
86// Adding a class alias for backwards compatibility with the previous class name.
87class_alias(OrganizationsEnvironmentsAnalyticsExports::class, 'Google_Service_Apigee_Resource_OrganizationsEnvironmentsAnalyticsExports');
88