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.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.archiveDeployments.html">archiveDeployments</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new ArchiveDeployment.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes an archive deployment.</p> 86<p class="toc_element"> 87 <code><a href="#generateDownloadUrl">generateDownloadUrl(name, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL.</p> 89<p class="toc_element"> 90 <code><a href="#generateUploadUrl">generateUploadUrl(parent, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,1073741824` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`</p> 92<p class="toc_element"> 93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 94<p class="firstline">Gets the specified ArchiveDeployment.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists the ArchiveDeployments in the specified Environment.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates an existing ArchiveDeployment. Labels can modified but most of the other fields are not modifiable.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 112 <pre>Creates a new ArchiveDeployment. 113 114Args: 115 parent: string, Required. The Environment this Archive Deployment will be created in. (required) 116 body: object, The request body. 117 The object takes the form of: 118 119{ # Archive Deployment information. 120 "createdAt": "A String", # Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. 121 "gcsUri": "A String", # Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. 122 "labels": { # User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. 123 "a_key": "A String", 124 }, 125 "name": "A String", # Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. 126 "operation": "A String", # Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}` 127 "updatedAt": "A String", # Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch. 128} 129 130 x__xgafv: string, V1 error format. 131 Allowed values 132 1 - v1 error format 133 2 - v2 error format 134 135Returns: 136 An object of the form: 137 138 { # This resource represents a long-running operation that is the result of a network API call. 139 "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. 140 "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. 141 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 142 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 143 { 144 "a_key": "", # Properties of the object. Contains field @type with type URL. 145 }, 146 ], 147 "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. 148 }, 149 "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. 150 "a_key": "", # Properties of the object. Contains field @type with type URL. 151 }, 152 "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}`. 153 "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`. 154 "a_key": "", # Properties of the object. Contains field @type with type URL. 155 }, 156}</pre> 157</div> 158 159<div class="method"> 160 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 161 <pre>Deletes an archive deployment. 162 163Args: 164 name: string, Required. Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. (required) 165 x__xgafv: string, V1 error format. 166 Allowed values 167 1 - v1 error format 168 2 - v2 error format 169 170Returns: 171 An object of the form: 172 173 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 174}</pre> 175</div> 176 177<div class="method"> 178 <code class="details" id="generateDownloadUrl">generateDownloadUrl(name, body=None, x__xgafv=None)</code> 179 <pre>Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL. 180 181Args: 182 name: string, Required. The name of the Archive Deployment you want to download. (required) 183 body: object, The request body. 184 The object takes the form of: 185 186{ # Request for GenerateDownloadUrl method. 187} 188 189 x__xgafv: string, V1 error format. 190 Allowed values 191 1 - v1 error format 192 2 - v2 error format 193 194Returns: 195 An object of the form: 196 197 { # Response for GenerateDownloadUrl method. 198 "downloadUri": "A String", # The Google Cloud Storage signed URL that can be used to download the Archive zip file. 199}</pre> 200</div> 201 202<div class="method"> 203 <code class="details" id="generateUploadUrl">generateUploadUrl(parent, body=None, x__xgafv=None)</code> 204 <pre>Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,1073741824` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` 205 206Args: 207 parent: string, Required. The organization and environment to upload to. (required) 208 body: object, The request body. 209 The object takes the form of: 210 211{ # Request for GenerateUploadUrl method. 212} 213 214 x__xgafv: string, V1 error format. 215 Allowed values 216 1 - v1 error format 217 2 - v2 error format 218 219Returns: 220 An object of the form: 221 222 { # Response for GenerateUploadUrl method. 223 "uploadUri": "A String", # The Google Cloud Storage signed URL that can be used to upload a new Archive zip file. 224}</pre> 225</div> 226 227<div class="method"> 228 <code class="details" id="get">get(name, x__xgafv=None)</code> 229 <pre>Gets the specified ArchiveDeployment. 230 231Args: 232 name: string, Required. Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. (required) 233 x__xgafv: string, V1 error format. 234 Allowed values 235 1 - v1 error format 236 2 - v2 error format 237 238Returns: 239 An object of the form: 240 241 { # Archive Deployment information. 242 "createdAt": "A String", # Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. 243 "gcsUri": "A String", # Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. 244 "labels": { # User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. 245 "a_key": "A String", 246 }, 247 "name": "A String", # Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. 248 "operation": "A String", # Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}` 249 "updatedAt": "A String", # Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch. 250}</pre> 251</div> 252 253<div class="method"> 254 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 255 <pre>Lists the ArchiveDeployments in the specified Environment. 256 257Args: 258 parent: string, Required. Name of the Environment for which to list Archive Deployments in the format: `organizations/{org}/environments/{env}`. (required) 259 filter: string, Optional. An optional query used to return a subset of Archive Deployments using the semantics defined in https://google.aip.dev/160. 260 pageSize: integer, Optional. Maximum number of Archive Deployments to return. If unspecified, at most 25 deployments will be returned. 261 pageToken: string, Optional. Page token, returned from a previous ListArchiveDeployments call, that you can use to retrieve the next page. 262 x__xgafv: string, V1 error format. 263 Allowed values 264 1 - v1 error format 265 2 - v2 error format 266 267Returns: 268 An object of the form: 269 270 { # Response for ListArchiveDeployments method. 271 "archiveDeployments": [ # Archive Deployments in the specified environment. 272 { # Archive Deployment information. 273 "createdAt": "A String", # Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. 274 "gcsUri": "A String", # Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. 275 "labels": { # User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. 276 "a_key": "A String", 277 }, 278 "name": "A String", # Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. 279 "operation": "A String", # Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}` 280 "updatedAt": "A String", # Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch. 281 }, 282 ], 283 "nextPageToken": "A String", # Page token that you can include in a ListArchiveDeployments request to retrieve the next page. If omitted, no subsequent pages exist. 284}</pre> 285</div> 286 287<div class="method"> 288 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 289 <pre>Retrieves the next page of results. 290 291Args: 292 previous_request: The request for the previous page. (required) 293 previous_response: The response from the request for the previous page. (required) 294 295Returns: 296 A request object that you can call 'execute()' on to request the next 297 page. Returns None if there are no more items in the collection. 298 </pre> 299</div> 300 301<div class="method"> 302 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 303 <pre>Updates an existing ArchiveDeployment. Labels can modified but most of the other fields are not modifiable. 304 305Args: 306 name: string, Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. (required) 307 body: object, The request body. 308 The object takes the form of: 309 310{ # Archive Deployment information. 311 "createdAt": "A String", # Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. 312 "gcsUri": "A String", # Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. 313 "labels": { # User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. 314 "a_key": "A String", 315 }, 316 "name": "A String", # Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. 317 "operation": "A String", # Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}` 318 "updatedAt": "A String", # Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch. 319} 320 321 updateMask: string, Required. The list of fields to be updated. 322 x__xgafv: string, V1 error format. 323 Allowed values 324 1 - v1 error format 325 2 - v2 error format 326 327Returns: 328 An object of the form: 329 330 { # Archive Deployment information. 331 "createdAt": "A String", # Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. 332 "gcsUri": "A String", # Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. 333 "labels": { # User-supplied key-value pairs used to organize ArchiveDeployments. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. 334 "a_key": "A String", 335 }, 336 "name": "A String", # Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. 337 "operation": "A String", # Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}` 338 "updatedAt": "A String", # Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch. 339}</pre> 340</div> 341 342</body></html>