bucket_contents
Creates, updates, deletes, gets or lists a bucket_contents resource.
Overview
| Name | bucket_contents |
| Type | Resource |
| Id | linode.object_storage.bucket_contents |
Fields
The following fields are returned by SELECT queries:
- get_object_storage_bucket_content
One page of the requested bucket's contents.
| Name | Datatype | Description |
|---|---|---|
data | array | |
is_truncated | boolean | Designates if there is another page of bucket objects. |
next_marker | string | Returns the value you should pass to the marker query parameter to get the next page of objects. If there is no next page, null will be returned. (example: bd021c21-e734-4823-97a4-58b41c2cd4c8.892602.184) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_object_storage_bucket_content | select | marker, delimiter, prefix, page_size | Returns the contents of a bucket. The contents are paginated using a marker, that's the name of the last object on the previous page. Objects can also be filtered by prefix and delimiter. See Filtering and sorting for more information.> 📘 > > You can use an outside API, such as the Ceph Object Gateway S3 API for more options. OAuth scopes. <br /> object_storage:read_only<br /> Learn more... |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
delimiter | string | The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the / character to allow bucket transversal in a manner similar to a filesystem, however any delimiter may be used. Use in conjunction with prefix to see object names past the first occurrence of the delimiter. (example: {{delimiter}}) |
marker | string | The "marker" for this request, which can be used to paginate through large buckets. Its value should be the value of the next_marker property returned with the last page. Listing bucket contents does not support arbitrary page access. See the next_marker property in the responses section for more details. (example: {{marker}}) |
page_size | integer | The number of items to return per page. |
prefix | string | Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with delimiter to allow transversal of bucket contents in a manner similar to a filesystem. (example: {{prefix}}) |
SELECT examples
- get_object_storage_bucket_content
Returns the contents of a bucket. The contents are paginated using a marker, that's the name of the last object on the previous page. Objects can also be filtered by prefix and delimiter. See Filtering and sorting for more information.
> 📘
>
> You can use an outside API, such as the Ceph Object Gateway S3 API for more options. OAuth scopes.
<br /> object_storage:read_only<br />
Learn more...
SELECT
data,
is_truncated,
next_marker
FROM linode.object_storage.bucket_contents
WHERE marker = '{{ marker }}'
AND delimiter = '{{ delimiter }}'
AND prefix = '{{ prefix }}'
AND page_size = '{{ page_size }}';