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\GoogleCloudApigeeV1EnvironmentGroup;
|
---|
21 | use Google\Service\Apigee\GoogleCloudApigeeV1EnvironmentGroupConfig;
|
---|
22 | use Google\Service\Apigee\GoogleCloudApigeeV1ListEnvironmentGroupsResponse;
|
---|
23 | use Google\Service\Apigee\GoogleLongrunningOperation;
|
---|
24 |
|
---|
25 | /**
|
---|
26 | * The "envgroups" collection of methods.
|
---|
27 | * Typical usage is:
|
---|
28 | * <code>
|
---|
29 | * $apigeeService = new Google\Service\Apigee(...);
|
---|
30 | * $envgroups = $apigeeService->organizations_envgroups;
|
---|
31 | * </code>
|
---|
32 | */
|
---|
33 | class OrganizationsEnvgroups extends \Google\Service\Resource
|
---|
34 | {
|
---|
35 | /**
|
---|
36 | * Creates a new environment group. (envgroups.create)
|
---|
37 | *
|
---|
38 | * @param string $parent Required. Name of the organization in which to create
|
---|
39 | * the environment group in the following format: `organizations/{org}`.
|
---|
40 | * @param GoogleCloudApigeeV1EnvironmentGroup $postBody
|
---|
41 | * @param array $optParams Optional parameters.
|
---|
42 | *
|
---|
43 | * @opt_param string name Optional. ID of the environment group. Overrides any
|
---|
44 | * ID in the environment_group resource.
|
---|
45 | * @return GoogleLongrunningOperation
|
---|
46 | * @throws \Google\Service\Exception
|
---|
47 | */
|
---|
48 | public function create($parent, GoogleCloudApigeeV1EnvironmentGroup $postBody, $optParams = [])
|
---|
49 | {
|
---|
50 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
51 | $params = array_merge($params, $optParams);
|
---|
52 | return $this->call('create', [$params], GoogleLongrunningOperation::class);
|
---|
53 | }
|
---|
54 | /**
|
---|
55 | * Deletes an environment group. (envgroups.delete)
|
---|
56 | *
|
---|
57 | * @param string $name Required. Name of the environment group in the following
|
---|
58 | * format: `organizations/{org}/envgroups/{envgroup}`.
|
---|
59 | * @param array $optParams Optional parameters.
|
---|
60 | * @return GoogleLongrunningOperation
|
---|
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], GoogleLongrunningOperation::class);
|
---|
68 | }
|
---|
69 | /**
|
---|
70 | * Gets an environment group. (envgroups.get)
|
---|
71 | *
|
---|
72 | * @param string $name Required. Name of the environment group in the following
|
---|
73 | * format: `organizations/{org}/envgroups/{envgroup}`.
|
---|
74 | * @param array $optParams Optional parameters.
|
---|
75 | * @return GoogleCloudApigeeV1EnvironmentGroup
|
---|
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], GoogleCloudApigeeV1EnvironmentGroup::class);
|
---|
83 | }
|
---|
84 | /**
|
---|
85 | * Gets the deployed ingress configuration for an environment group.
|
---|
86 | * (envgroups.getDeployedIngressConfig)
|
---|
87 | *
|
---|
88 | * @param string $name Required. Name of the deployed configuration for the
|
---|
89 | * environment group in the following format:
|
---|
90 | * 'organizations/{org}/envgroups/{envgroup}/deployedIngressConfig'.
|
---|
91 | * @param array $optParams Optional parameters.
|
---|
92 | *
|
---|
93 | * @opt_param string view When set to FULL, additional details about the
|
---|
94 | * specific deployments receiving traffic will be included in the IngressConfig
|
---|
95 | * response's RoutingRules.
|
---|
96 | * @return GoogleCloudApigeeV1EnvironmentGroupConfig
|
---|
97 | * @throws \Google\Service\Exception
|
---|
98 | */
|
---|
99 | public function getDeployedIngressConfig($name, $optParams = [])
|
---|
100 | {
|
---|
101 | $params = ['name' => $name];
|
---|
102 | $params = array_merge($params, $optParams);
|
---|
103 | return $this->call('getDeployedIngressConfig', [$params], GoogleCloudApigeeV1EnvironmentGroupConfig::class);
|
---|
104 | }
|
---|
105 | /**
|
---|
106 | * Lists all environment groups. (envgroups.listOrganizationsEnvgroups)
|
---|
107 | *
|
---|
108 | * @param string $parent Required. Name of the organization for which to list
|
---|
109 | * environment groups in the following format: `organizations/{org}`.
|
---|
110 | * @param array $optParams Optional parameters.
|
---|
111 | *
|
---|
112 | * @opt_param int pageSize Maximum number of environment groups to return. The
|
---|
113 | * page size defaults to 25.
|
---|
114 | * @opt_param string pageToken Page token, returned from a previous
|
---|
115 | * ListEnvironmentGroups call, that you can use to retrieve the next page.
|
---|
116 | * @return GoogleCloudApigeeV1ListEnvironmentGroupsResponse
|
---|
117 | * @throws \Google\Service\Exception
|
---|
118 | */
|
---|
119 | public function listOrganizationsEnvgroups($parent, $optParams = [])
|
---|
120 | {
|
---|
121 | $params = ['parent' => $parent];
|
---|
122 | $params = array_merge($params, $optParams);
|
---|
123 | return $this->call('list', [$params], GoogleCloudApigeeV1ListEnvironmentGroupsResponse::class);
|
---|
124 | }
|
---|
125 | /**
|
---|
126 | * Updates an environment group. (envgroups.patch)
|
---|
127 | *
|
---|
128 | * @param string $name Required. Name of the environment group to update in the
|
---|
129 | * format: `organizations/{org}/envgroups/{envgroup}.
|
---|
130 | * @param GoogleCloudApigeeV1EnvironmentGroup $postBody
|
---|
131 | * @param array $optParams Optional parameters.
|
---|
132 | *
|
---|
133 | * @opt_param string updateMask Optional. List of fields to be updated.
|
---|
134 | * @return GoogleLongrunningOperation
|
---|
135 | * @throws \Google\Service\Exception
|
---|
136 | */
|
---|
137 | public function patch($name, GoogleCloudApigeeV1EnvironmentGroup $postBody, $optParams = [])
|
---|
138 | {
|
---|
139 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
140 | $params = array_merge($params, $optParams);
|
---|
141 | return $this->call('patch', [$params], GoogleLongrunningOperation::class);
|
---|
142 | }
|
---|
143 | }
|
---|
144 |
|
---|
145 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
146 | class_alias(OrganizationsEnvgroups::class, 'Google_Service_Apigee_Resource_OrganizationsEnvgroups');
|
---|