Ruby

Backblaze S3 List Bucket Objects

See more Backblaze S3 Examples

Demonstrates how to list the objects in a bucket.

The Chilkat S3 functions in the HTTP class are compatible with the Backblaze service. However, because of some specific issues, Chilkat v9.5.0.89 or later is needed.

Ruby

require 'chilkat'

success = false

# This example assumes the Chilkat HTTP API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# keyID = Access Key ID or Access Key
http.put_AwsAccessKey("access-key")

# applicationKey = Secret Access Key or Secret Key
http.put_AwsSecretKey("secret-key")

# Region is the 2nd part of your S3 Endpoint
http.put_AwsEndpoint("s3.us-west-002.backblazeb2.com")

bucketName = "chilkat-test"

strXml = http.s3_ListBucketObjects(bucketName)
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

print "Response status code = " + http.get_LastStatus().to_s() + "\n";

xml = Chilkat::CkXml.new()
success = xml.LoadXml(strXml)
if (success != true)
    print xml.lastErrorText() + "\n";
    exit
end

# If the response status code was not 200, then the XML response is not a 
# listing of objects, but instead contains error information.
if (http.get_LastStatus() != 200)
    print xml.getXml() + "\n";
    print "Failed." + "\n";
    exit
end

# A sample response is shown below.
print xml.getXml() + "\n";
print "----" + "\n";

# Use this online tool to generate parsing code from sample XML: 
# Generate Parsing Code from XML

# <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
# <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
#     <Contents>
#         <ETag>"303fb46cf341094fef6274b7789cd6aa"</ETag>
#         <Key>orchard.json</Key>
#         <LastModified>2021-10-30T14:45:52.000Z</LastModified>
#         <Owner>
#             <ID>f2ebbc5f792c</ID>
#             <DisplayName/>
#         </Owner>
#         <Size>22</Size>
#         <StorageClass>STANDARD</StorageClass>
#     </Contents>
#     <Contents>
#         <ETag>"a8551f0a5437f43a796fca7623ee9232"</ETag>
#         <Key>seahorse.jpg</Key>
#         <LastModified>2021-10-30T14:38:53.000Z</LastModified>
#         <Owner>
#             <ID>f2ebbc5f792c</ID>
#             <DisplayName/>
#         </Owner>
#         <Size>24388</Size>
#         <StorageClass>STANDARD</StorageClass>
#     </Contents>
#     <IsTruncated>false</IsTruncated>
#     <MaxKeys>1000</MaxKeys>
#     <Name>chilkat-test</Name>
#     <Prefix/>
#     <Marker/>
# </ListBucketResult>

ListBucketResult_xmlns = xml.getAttrValue("xmlns")
i = 0
count_i = xml.NumChildrenHavingTag("Contents")
while i < count_i
    xml.put_I(i)
    ETag = xml.getChildContent("Contents[i]|ETag")
    Key = xml.getChildContent("Contents[i]|Key")
    LastModified = xml.getChildContent("Contents[i]|LastModified")
    ID = xml.getChildContent("Contents[i]|Owner|ID")
    SizeDecimalStr = xml.getChildContent("Contents[i]|Size")
    StorageClass = xml.getChildContent("Contents[i]|StorageClass")
    i = i + 1
end
IsTruncated = xml.getChildContent("IsTruncated")
MaxKeys = xml.GetChildIntValue("MaxKeys")
Name = xml.getChildContent("Name")