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

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

Upload project files

  • Property mode set to 100644
File size: 6.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\GoogleCloudApigeeV1KeyValueEntry;
21use Google\Service\Apigee\GoogleCloudApigeeV1ListKeyValueEntriesResponse;
22
23/**
24 * The "entries" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $apigeeService = new Google\Service\Apigee(...);
28 * $entries = $apigeeService->organizations_keyvaluemaps_entries;
29 * </code>
30 */
31class OrganizationsKeyvaluemapsEntries extends \Google\Service\Resource
32{
33 /**
34 * Creates key value entries in a key value map scoped to an organization,
35 * environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and
36 * higher. (entries.create)
37 *
38 * @param string $parent Required. Scope as indicated by the URI in which to
39 * create the key value map entry. Use **one** of the following structures in
40 * your request: *
41 * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `orga
42 * nizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap
43 * }` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
44 * @param GoogleCloudApigeeV1KeyValueEntry $postBody
45 * @param array $optParams Optional parameters.
46 * @return GoogleCloudApigeeV1KeyValueEntry
47 * @throws \Google\Service\Exception
48 */
49 public function create($parent, GoogleCloudApigeeV1KeyValueEntry $postBody, $optParams = [])
50 {
51 $params = ['parent' => $parent, 'postBody' => $postBody];
52 $params = array_merge($params, $optParams);
53 return $this->call('create', [$params], GoogleCloudApigeeV1KeyValueEntry::class);
54 }
55 /**
56 * Deletes a key value entry from a key value map scoped to an organization,
57 * environment, or API proxy. **Notes:** * After you delete the key value entry,
58 * the policy consuming the entry will continue to function with its cached
59 * values for a few minutes. This is expected behavior. * Supported for Apigee
60 * hybrid 1.8.x and higher. (entries.delete)
61 *
62 * @param string $name Required. Scope as indicated by the URI in which to
63 * delete the key value map entry. Use **one** of the following structures in
64 * your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyval
65 * uemap}/entries/{entry}`. * `organizations/{organization}/environments/{enviro
66 * nment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` *
67 * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
68 * @param array $optParams Optional parameters.
69 * @return GoogleCloudApigeeV1KeyValueEntry
70 * @throws \Google\Service\Exception
71 */
72 public function delete($name, $optParams = [])
73 {
74 $params = ['name' => $name];
75 $params = array_merge($params, $optParams);
76 return $this->call('delete', [$params], GoogleCloudApigeeV1KeyValueEntry::class);
77 }
78 /**
79 * Get the key value entry value for a key value map scoped to an organization,
80 * environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and
81 * higher. (entries.get)
82 *
83 * @param string $name Required. Scope as indicated by the URI in which to fetch
84 * the key value map entry/value. Use **one** of the following structures in
85 * your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyval
86 * uemap}/entries/{entry}`. * `organizations/{organization}/environments/{enviro
87 * nment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` *
88 * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
89 * @param array $optParams Optional parameters.
90 * @return GoogleCloudApigeeV1KeyValueEntry
91 * @throws \Google\Service\Exception
92 */
93 public function get($name, $optParams = [])
94 {
95 $params = ['name' => $name];
96 $params = array_merge($params, $optParams);
97 return $this->call('get', [$params], GoogleCloudApigeeV1KeyValueEntry::class);
98 }
99 /**
100 * Lists key value entries for key values maps scoped to an organization,
101 * environment, or API proxy. **Note**: Supported for Apigee hybrid 1.8.x and
102 * higher. (entries.listOrganizationsKeyvaluemapsEntries)
103 *
104 * @param string $parent Required. Scope as indicated by the URI in which to
105 * list key value maps. Use **one** of the following structures in your request:
106 * * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `or
107 * ganizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluem
108 * ap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
109 * @param array $optParams Optional parameters.
110 *
111 * @opt_param int pageSize Optional. Maximum number of key value entries to
112 * return. If unspecified, at most 100 entries will be returned.
113 * @opt_param string pageToken Optional. Page token. If provides, must be a
114 * valid key value entry returned from a previous call that can be used to
115 * retrieve the next page.
116 * @return GoogleCloudApigeeV1ListKeyValueEntriesResponse
117 * @throws \Google\Service\Exception
118 */
119 public function listOrganizationsKeyvaluemapsEntries($parent, $optParams = [])
120 {
121 $params = ['parent' => $parent];
122 $params = array_merge($params, $optParams);
123 return $this->call('list', [$params], GoogleCloudApigeeV1ListKeyValueEntriesResponse::class);
124 }
125 /**
126 * Update key value entry scoped to an organization, environment, or API proxy
127 * for an existing key. (entries.update)
128 *
129 * @param string $name Required. Scope as indicated by the URI in which to
130 * create the key value map entry. Use **one** of the following structures in
131 * your request: *
132 * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `orga
133 * nizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap
134 * }` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
135 * @param GoogleCloudApigeeV1KeyValueEntry $postBody
136 * @param array $optParams Optional parameters.
137 * @return GoogleCloudApigeeV1KeyValueEntry
138 * @throws \Google\Service\Exception
139 */
140 public function update($name, GoogleCloudApigeeV1KeyValueEntry $postBody, $optParams = [])
141 {
142 $params = ['name' => $name, 'postBody' => $postBody];
143 $params = array_merge($params, $optParams);
144 return $this->call('update', [$params], GoogleCloudApigeeV1KeyValueEntry::class);
145 }
146}
147
148// Adding a class alias for backwards compatibility with the previous class name.
149class_alias(OrganizationsKeyvaluemapsEntries::class, 'Google_Service_Apigee_Resource_OrganizationsKeyvaluemapsEntries');
Note: See TracBrowser for help on using the repository browser.