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="appengine_v1beta4.html">App Engine Admin API</a> . <a href="appengine_v1beta4.apps.html">apps</a> . <a href="appengine_v1beta4.apps.modules.html">modules</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="appengine_v1beta4.apps.modules.versions.html">versions()</a></code> 79</p> 80<p class="firstline">Returns the versions 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="#delete">delete(appsId, modulesId, x__xgafv=None)</a></code></p> 87<p class="firstline">Deletes the specified module and all enclosed versions.</p> 88<p class="toc_element"> 89 <code><a href="#get">get(appsId, modulesId, x__xgafv=None)</a></code></p> 90<p class="firstline">Gets the current configuration of the specified module.</p> 91<p class="toc_element"> 92 <code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Lists all the modules in the application.</p> 94<p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96<p class="firstline">Retrieves the next page of results.</p> 97<p class="toc_element"> 98 <code><a href="#patch">patch(appsId, modulesId, body=None, mask=None, migrateTraffic=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Updates the configuration of the specified module.</p> 100<h3>Method Details</h3> 101<div class="method"> 102 <code class="details" id="close">close()</code> 103 <pre>Close httplib2 connections.</pre> 104</div> 105 106<div class="method"> 107 <code class="details" id="delete">delete(appsId, modulesId, x__xgafv=None)</code> 108 <pre>Deletes the specified module and all enclosed versions. 109 110Args: 111 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default. (required) 112 modulesId: string, Part of `name`. See documentation of `appsId`. (required) 113 x__xgafv: string, V1 error format. 114 Allowed values 115 1 - v1 error format 116 2 - v2 error format 117 118Returns: 119 An object of the form: 120 121 { # This resource represents a long-running operation that is the result of a network API call. 122 "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. 123 "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). The error model is designed to be: # The error result of the operation in case of failure or cancellation. 124 # Simple to use and understand for most users 125 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: 126 # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. 127 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. 128 # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. 129 # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. 130 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. 131 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 132 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 133 { 134 "a_key": "", # Properties of the object. Contains field @type with type URL. 135 }, 136 ], 137 "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. 138 }, 139 "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. 140 "a_key": "", # Properties of the object. Contains field @type with type URL. 141 }, 142 "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 have the format of operations/some/unique/name. 143 "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. 144 "a_key": "", # Properties of the object. Contains field @type with type URL. 145 }, 146}</pre> 147</div> 148 149<div class="method"> 150 <code class="details" id="get">get(appsId, modulesId, x__xgafv=None)</code> 151 <pre>Gets the current configuration of the specified module. 152 153Args: 154 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default. (required) 155 modulesId: string, Part of `name`. See documentation of `appsId`. (required) 156 x__xgafv: string, V1 error format. 157 Allowed values 158 1 - v1 error format 159 2 - v2 error format 160 161Returns: 162 An object of the form: 163 164 { # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module. 165 "id": "A String", # Relative name of the module within the application. Example: default.@OutputOnly 166 "name": "A String", # Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly 167 "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module. 168 "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits. 169 "a_key": 3.14, 170 }, 171 "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed. 172 }, 173}</pre> 174</div> 175 176<div class="method"> 177 <code class="details" id="list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</code> 178 <pre>Lists all the modules in the application. 179 180Args: 181 appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp. (required) 182 pageSize: integer, Maximum results to return per page. 183 pageToken: string, Continuation token for fetching the next page of results. 184 x__xgafv: string, V1 error format. 185 Allowed values 186 1 - v1 error format 187 2 - v2 error format 188 189Returns: 190 An object of the form: 191 192 { # Response message for Modules.ListModules. 193 "modules": [ # The modules belonging to the requested application. 194 { # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module. 195 "id": "A String", # Relative name of the module within the application. Example: default.@OutputOnly 196 "name": "A String", # Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly 197 "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module. 198 "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits. 199 "a_key": 3.14, 200 }, 201 "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed. 202 }, 203 }, 204 ], 205 "nextPageToken": "A String", # Continuation token for fetching the next page of results. 206}</pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 211 <pre>Retrieves the next page of results. 212 213Args: 214 previous_request: The request for the previous page. (required) 215 previous_response: The response from the request for the previous page. (required) 216 217Returns: 218 A request object that you can call 'execute()' on to request the next 219 page. Returns None if there are no more items in the collection. 220 </pre> 221</div> 222 223<div class="method"> 224 <code class="details" id="patch">patch(appsId, modulesId, body=None, mask=None, migrateTraffic=None, x__xgafv=None)</code> 225 <pre>Updates the configuration of the specified module. 226 227Args: 228 appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default. (required) 229 modulesId: string, Part of `name`. See documentation of `appsId`. (required) 230 body: object, The request body. 231 The object takes the form of: 232 233{ # A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module. 234 "id": "A String", # Relative name of the module within the application. Example: default.@OutputOnly 235 "name": "A String", # Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly 236 "split": { # Traffic routing configuration for versions within a single module. Traffic splits define how traffic directed to the module is assigned to versions. # Mapping that defines fractional HTTP traffic diversion to different versions within the module. 237 "allocations": { # Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits. 238 "a_key": 3.14, 239 }, 240 "shardBy": "A String", # Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed. 241 }, 242} 243 244 mask: string, Standard field mask for the set of fields to be updated. 245 migrateTraffic: boolean, Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic). 246 x__xgafv: string, V1 error format. 247 Allowed values 248 1 - v1 error format 249 2 - v2 error format 250 251Returns: 252 An object of the form: 253 254 { # This resource represents a long-running operation that is the result of a network API call. 255 "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. 256 "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). The error model is designed to be: # The error result of the operation in case of failure or cancellation. 257 # Simple to use and understand for most users 258 # Flexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include: 259 # Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors. 260 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting. 261 # Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response. 262 # Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message. 263 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. 264 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 265 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 266 { 267 "a_key": "", # Properties of the object. Contains field @type with type URL. 268 }, 269 ], 270 "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. 271 }, 272 "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. 273 "a_key": "", # Properties of the object. Contains field @type with type URL. 274 }, 275 "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 have the format of operations/some/unique/name. 276 "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. 277 "a_key": "", # Properties of the object. Contains field @type with type URL. 278 }, 279}</pre> 280</div> 281 282</body></html>