| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| https://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| <html> |
| <head> |
| <meta http-equiv="Content-Language" content="en-us"></meta> |
| <link rel="stylesheet" type="text/css" href="style.css"> |
| <title>S3 Delete Task</title> |
| </head> |
| |
| <body> |
| <h2><a name="s3delete">s3:delete</a></h2> |
| |
| <h3>Description</h3> |
| |
| <p>Delete the objects represented by a collection of |
| <a href="s3object.html">s3:object</a> resources.</p> |
| |
| <h3>Parameters</h3> |
| <table border="1" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td valign="top"><b>Attribute</b></td> |
| <td valign="top"><b>Description</b></td> |
| <td align="center" valign="top"><b>Required</b></td> |
| </tr> |
| <tr> |
| <td valign="top">clientrefid</td> |
| <td valign="top">Ant reference ID to an <a href="s3client.html">s3:client</a> |
| defined elsewhere</td> |
| <td align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">refid</td> |
| <td valign="top">Ant reference ID to a resource collection to delete</td> |
| <td align="center">No</td> |
| </tr> |
| <tr> |
| <td valign="top">as</td> |
| <td valign="top">object precision: <code>object|version</code></td> |
| <td align="center">No, default <code>object</code></td> |
| </tr> |
| <tr> |
| <td valign="top">blocksize</td> |
| <td valign="top">Size of delete batches when operating in batch mode</td> |
| <td align="center">No, default 1000</td> |
| </tr> |
| <tr> |
| <td valign="top">verbose</td> |
| <td valign="top">Log activity verbosely</td> |
| <td align="center">No, default <code>false</code></td> |
| </tr> |
| </table> |
| |
| <h3>Parameters specified as nested elements</h3> |
| |
| <h4>s3:client</h4> |
| |
| <p><a href="s3client.html">s3:client</a> to use for deletion. If a client is |
| specified either in this manner or by use of <code>@clientrefid</code>, the |
| <code>delete</code> operation is put into batch mode. If the collection of |
| <code>s3:object</code> resources come from an |
| <a href="s3objects.html">s3:objects</a> collection, and therefore already |
| have a reference to the client that discovered them, this task does not need |
| a client reference and each object will be requested to delete itself. |
| </p> |
| |
| <h4>resource collection</h4> |
| |
| <p>Any number of nested resource collections may be specified; however |
| resources other than <a href="s3object.html">s3:object</a> are ignored. |
| Further, if <code>@as</code> is <code>object</code> an <code>s3:object</code> |
| that is a delete marker will also be ignored, as it indicates the object |
| has already been deleted, so far as it goes.</p> |
| |
| </body> |
| </html> |
| |
