source: vendor/google/apiclient-services/src/Apigee/Resource/OrganizationsDatacollectors.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 2 weeks ago

Upload project files

  • Property mode set to 100644
File size: 4.9 KB
Line 
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\GoogleCloudApigeeV1DataCollector;
21use Google\Service\Apigee\GoogleCloudApigeeV1ListDataCollectorsResponse;
22use Google\Service\Apigee\GoogleProtobufEmpty;
23
24/**
25 * The "datacollectors" collection of methods.
26 * Typical usage is:
27 * <code>
28 * $apigeeService = new Google\Service\Apigee(...);
29 * $datacollectors = $apigeeService->organizations_datacollectors;
30 * </code>
31 */
32class OrganizationsDatacollectors extends \Google\Service\Resource
33{
34 /**
35 * Creates a new data collector. (datacollectors.create)
36 *
37 * @param string $parent Required. Name of the organization in which to create
38 * the data collector in the following format: `organizations/{org}`.
39 * @param GoogleCloudApigeeV1DataCollector $postBody
40 * @param array $optParams Optional parameters.
41 *
42 * @opt_param string dataCollectorId ID of the data collector. Overrides any ID
43 * in the data collector resource. Must be a string beginning with `dc_` that
44 * contains only letters, numbers, and underscores.
45 * @return GoogleCloudApigeeV1DataCollector
46 * @throws \Google\Service\Exception
47 */
48 public function create($parent, GoogleCloudApigeeV1DataCollector $postBody, $optParams = [])
49 {
50 $params = ['parent' => $parent, 'postBody' => $postBody];
51 $params = array_merge($params, $optParams);
52 return $this->call('create', [$params], GoogleCloudApigeeV1DataCollector::class);
53 }
54 /**
55 * Deletes a data collector. (datacollectors.delete)
56 *
57 * @param string $name Required. Name of the data collector in the following
58 * format: `organizations/{org}/datacollectors/{data_collector_id}`.
59 * @param array $optParams Optional parameters.
60 * @return GoogleProtobufEmpty
61 * @throws \Google\Service\Exception
62 */
63 public function delete($name, $optParams = [])
64 {
65 $params = ['name' => $name];
66 $params = array_merge($params, $optParams);
67 return $this->call('delete', [$params], GoogleProtobufEmpty::class);
68 }
69 /**
70 * Gets a data collector. (datacollectors.get)
71 *
72 * @param string $name Required. Name of the data collector in the following
73 * format: `organizations/{org}/datacollectors/{data_collector_id}`.
74 * @param array $optParams Optional parameters.
75 * @return GoogleCloudApigeeV1DataCollector
76 * @throws \Google\Service\Exception
77 */
78 public function get($name, $optParams = [])
79 {
80 $params = ['name' => $name];
81 $params = array_merge($params, $optParams);
82 return $this->call('get', [$params], GoogleCloudApigeeV1DataCollector::class);
83 }
84 /**
85 * Lists all data collectors. (datacollectors.listOrganizationsDatacollectors)
86 *
87 * @param string $parent Required. Name of the organization for which to list
88 * data collectors in the following format: `organizations/{org}`.
89 * @param array $optParams Optional parameters.
90 *
91 * @opt_param int pageSize Maximum number of data collectors to return. The page
92 * size defaults to 25.
93 * @opt_param string pageToken Page token, returned from a previous
94 * ListDataCollectors call, that you can use to retrieve the next page.
95 * @return GoogleCloudApigeeV1ListDataCollectorsResponse
96 * @throws \Google\Service\Exception
97 */
98 public function listOrganizationsDatacollectors($parent, $optParams = [])
99 {
100 $params = ['parent' => $parent];
101 $params = array_merge($params, $optParams);
102 return $this->call('list', [$params], GoogleCloudApigeeV1ListDataCollectorsResponse::class);
103 }
104 /**
105 * Updates a data collector. (datacollectors.patch)
106 *
107 * @param string $name Required. Name of the data collector in the following
108 * format: `organizations/{org}/datacollectors/{data_collector_id}`.
109 * @param GoogleCloudApigeeV1DataCollector $postBody
110 * @param array $optParams Optional parameters.
111 *
112 * @opt_param string updateMask List of fields to be updated.
113 * @return GoogleCloudApigeeV1DataCollector
114 * @throws \Google\Service\Exception
115 */
116 public function patch($name, GoogleCloudApigeeV1DataCollector $postBody, $optParams = [])
117 {
118 $params = ['name' => $name, 'postBody' => $postBody];
119 $params = array_merge($params, $optParams);
120 return $this->call('patch', [$params], GoogleCloudApigeeV1DataCollector::class);
121 }
122}
123
124// Adding a class alias for backwards compatibility with the previous class name.
125class_alias(OrganizationsDatacollectors::class, 'Google_Service_Apigee_Resource_OrganizationsDatacollectors');
Note: See TracBrowser for help on using the repository browser.