1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.envgroups.html">envgroups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="apigee_v1.organizations.envgroups.attachments.html">attachments()</a></code> 79</p> 80<p class="firstline">Returns the attachments Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, name=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a new environment group.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes an environment group.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Gets an environment group.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Lists all environment groups.</p> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<p class="toc_element"> 101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Updates an environment group.</p> 103<h3>Method Details</h3> 104<div class="method"> 105 <code class="details" id="close">close()</code> 106 <pre>Close httplib2 connections.</pre> 107</div> 108 109<div class="method"> 110 <code class="details" id="create">create(parent, body=None, name=None, x__xgafv=None)</code> 111 <pre>Creates a new environment group. 112 113Args: 114 parent: string, Required. Name of the organization in which to create the environment group in the following format: `organizations/{org}`. (required) 115 body: object, The request body. 116 The object takes the form of: 117 118{ # EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name. 119 "createdAt": "A String", # Output only. The time at which the environment group was created as milliseconds since epoch. 120 "hostnames": [ # Required. Host names for this environment group. 121 "A String", 122 ], 123 "lastModifiedAt": "A String", # Output only. The time at which the environment group was last updated as milliseconds since epoch. 124 "name": "A String", # ID of the environment group. 125 "state": "A String", # Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use. 126} 127 128 name: string, ID of the environment group. Overrides any ID in the environment_group resource. 129 x__xgafv: string, V1 error format. 130 Allowed values 131 1 - v1 error format 132 2 - v2 error format 133 134Returns: 135 An object of the form: 136 137 { # This resource represents a long-running operation that is the result of a network API call. 138 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 139 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 140 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 141 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 142 { 143 "a_key": "", # Properties of the object. Contains field @type with type URL. 144 }, 145 ], 146 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 147 }, 148 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 149 "a_key": "", # Properties of the object. Contains field @type with type URL. 150 }, 151 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 152 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 153 "a_key": "", # Properties of the object. Contains field @type with type URL. 154 }, 155}</pre> 156</div> 157 158<div class="method"> 159 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 160 <pre>Deletes an environment group. 161 162Args: 163 name: string, Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. (required) 164 x__xgafv: string, V1 error format. 165 Allowed values 166 1 - v1 error format 167 2 - v2 error format 168 169Returns: 170 An object of the form: 171 172 { # This resource represents a long-running operation that is the result of a network API call. 173 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 174 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 175 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 176 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 177 { 178 "a_key": "", # Properties of the object. Contains field @type with type URL. 179 }, 180 ], 181 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 182 }, 183 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 184 "a_key": "", # Properties of the object. Contains field @type with type URL. 185 }, 186 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 187 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 188 "a_key": "", # Properties of the object. Contains field @type with type URL. 189 }, 190}</pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="get">get(name, x__xgafv=None)</code> 195 <pre>Gets an environment group. 196 197Args: 198 name: string, Required. Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. (required) 199 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { # EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name. 208 "createdAt": "A String", # Output only. The time at which the environment group was created as milliseconds since epoch. 209 "hostnames": [ # Required. Host names for this environment group. 210 "A String", 211 ], 212 "lastModifiedAt": "A String", # Output only. The time at which the environment group was last updated as milliseconds since epoch. 213 "name": "A String", # ID of the environment group. 214 "state": "A String", # Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use. 215}</pre> 216</div> 217 218<div class="method"> 219 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 220 <pre>Lists all environment groups. 221 222Args: 223 parent: string, Required. Name of the organization for which to list environment groups in the following format: `organizations/{org}`. (required) 224 pageSize: integer, Maximum number of environment groups to return. The page size defaults to 25. 225 pageToken: string, Page token, returned from a previous ListEnvironmentGroups call, that you can use to retrieve the next page. 226 x__xgafv: string, V1 error format. 227 Allowed values 228 1 - v1 error format 229 2 - v2 error format 230 231Returns: 232 An object of the form: 233 234 { # Response for ListEnvironmentGroups. 235 "environmentGroups": [ # EnvironmentGroups in the specified organization. 236 { # EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name. 237 "createdAt": "A String", # Output only. The time at which the environment group was created as milliseconds since epoch. 238 "hostnames": [ # Required. Host names for this environment group. 239 "A String", 240 ], 241 "lastModifiedAt": "A String", # Output only. The time at which the environment group was last updated as milliseconds since epoch. 242 "name": "A String", # ID of the environment group. 243 "state": "A String", # Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use. 244 }, 245 ], 246 "nextPageToken": "A String", # Page token that you can include in a ListEnvironmentGroups request to retrieve the next page. If omitted, no subsequent pages exist. 247}</pre> 248</div> 249 250<div class="method"> 251 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 252 <pre>Retrieves the next page of results. 253 254Args: 255 previous_request: The request for the previous page. (required) 256 previous_response: The response from the request for the previous page. (required) 257 258Returns: 259 A request object that you can call 'execute()' on to request the next 260 page. Returns None if there are no more items in the collection. 261 </pre> 262</div> 263 264<div class="method"> 265 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 266 <pre>Updates an environment group. 267 268Args: 269 name: string, Required. Name of the environment group to update in the format: `organizations/{org}/envgroups/{envgroup}. (required) 270 body: object, The request body. 271 The object takes the form of: 272 273{ # EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name. 274 "createdAt": "A String", # Output only. The time at which the environment group was created as milliseconds since epoch. 275 "hostnames": [ # Required. Host names for this environment group. 276 "A String", 277 ], 278 "lastModifiedAt": "A String", # Output only. The time at which the environment group was last updated as milliseconds since epoch. 279 "name": "A String", # ID of the environment group. 280 "state": "A String", # Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use. 281} 282 283 updateMask: string, List of fields to be updated. 284 x__xgafv: string, V1 error format. 285 Allowed values 286 1 - v1 error format 287 2 - v2 error format 288 289Returns: 290 An object of the form: 291 292 { # This resource represents a long-running operation that is the result of a network API call. 293 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 294 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 295 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 296 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 297 { 298 "a_key": "", # Properties of the object. Contains field @type with type URL. 299 }, 300 ], 301 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 302 }, 303 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 304 "a_key": "", # Properties of the object. Contains field @type with type URL. 305 }, 306 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 307 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 308 "a_key": "", # Properties of the object. Contains field @type with type URL. 309 }, 310}</pre> 311</div> 312 313</body></html>