[e3d4e0a] | 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 |
|
---|
| 18 | namespace Google\Service\Apigee\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\Apigee\GoogleCloudApigeeV1Export;
|
---|
| 21 | use Google\Service\Apigee\GoogleCloudApigeeV1ExportRequest;
|
---|
| 22 | use 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->organizations_environments_analytics_exports;
|
---|
| 30 | * </code>
|
---|
| 31 | */
|
---|
| 32 | class 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 | * @throws \Google\Service\Exception
|
---|
| 46 | */
|
---|
| 47 | public function create($parent, GoogleCloudApigeeV1ExportRequest $postBody, $optParams = [])
|
---|
| 48 | {
|
---|
| 49 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
| 50 | $params = array_merge($params, $optParams);
|
---|
| 51 | return $this->call('create', [$params], GoogleCloudApigeeV1Export::class);
|
---|
| 52 | }
|
---|
| 53 | /**
|
---|
| 54 | * Gets the details and status of an analytics export job. If the export job is
|
---|
| 55 | * still in progress, its `state` is set to "running". After the export job has
|
---|
| 56 | * completed successfully, its `state` is set to "completed". If the export job
|
---|
| 57 | * fails, its `state` is set to `failed`. (exports.get)
|
---|
| 58 | *
|
---|
| 59 | * @param string $name Required. Resource name of the export to get.
|
---|
| 60 | * @param array $optParams Optional parameters.
|
---|
| 61 | * @return GoogleCloudApigeeV1Export
|
---|
| 62 | * @throws \Google\Service\Exception
|
---|
| 63 | */
|
---|
| 64 | public function get($name, $optParams = [])
|
---|
| 65 | {
|
---|
| 66 | $params = ['name' => $name];
|
---|
| 67 | $params = array_merge($params, $optParams);
|
---|
| 68 | return $this->call('get', [$params], GoogleCloudApigeeV1Export::class);
|
---|
| 69 | }
|
---|
| 70 | /**
|
---|
| 71 | * Lists the details and status of all analytics export jobs belonging to the
|
---|
| 72 | * parent organization and environment.
|
---|
| 73 | * (exports.listOrganizationsEnvironmentsAnalyticsExports)
|
---|
| 74 | *
|
---|
| 75 | * @param string $parent Required. Names of the parent organization and
|
---|
| 76 | * environment. Must be of the form `organizations/{org}/environments/{env}`.
|
---|
| 77 | * @param array $optParams Optional parameters.
|
---|
| 78 | * @return GoogleCloudApigeeV1ListExportsResponse
|
---|
| 79 | * @throws \Google\Service\Exception
|
---|
| 80 | */
|
---|
| 81 | public function listOrganizationsEnvironmentsAnalyticsExports($parent, $optParams = [])
|
---|
| 82 | {
|
---|
| 83 | $params = ['parent' => $parent];
|
---|
| 84 | $params = array_merge($params, $optParams);
|
---|
| 85 | return $this->call('list', [$params], GoogleCloudApigeeV1ListExportsResponse::class);
|
---|
| 86 | }
|
---|
| 87 | }
|
---|
| 88 |
|
---|
| 89 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 90 | class_alias(OrganizationsEnvironmentsAnalyticsExports::class, 'Google_Service_Apigee_Resource_OrganizationsEnvironmentsAnalyticsExports');
|
---|