module BucketClient::BlobMethods
Public Instance Methods
Deletes the blob in the provided URI Fails if the blob does not exist. Use delete_blob_if_exist
if you do not want this behaviour
uri = “” result = client.delete_blob uri result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> nil
@param [String] uri the URL of the blob @return [OperationResult]
# File lib/bucket_client/client.rb, line 355 def delete_blob(uri) raise NotImplementedError uri end
Deletes the blob in the provided URI Fails if the blob does not exist. Use delete_blob_if_exist
if you do not want this behaviour
Raises exception if the operation fails
uri = “” client.delete_blob! uri
@param [String] uri URL of the blob
# File lib/bucket_client/client.rb, line 369 def delete_blob!(uri) result = delete_blob uri raise BucketOperationException.new(result) unless result.success end
Deletes the blob if it exist, else does nothing
uri = “” result = client.delete_blob uri result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> nil
@param [String] uri the URL of the blob @return [OperationResult]
# File lib/bucket_client/client.rb, line 385 def delete_blob_if_exist(uri) raise NotImplementedError uri end
Deletes the blob if it exist, else does nothing
Raises exception if the operation fails
uri = “” client.delete_blob! uri
@param [String] uri the URL of the blob
# File lib/bucket_client/client.rb, line 397 def delete_blob_if_exist!(uri) result = delete_blob_if_exist uri raise BucketOperationException.new(result) unless result.success end
Check if blob with URI exist#
Raises exception when the operation fails
exist = exist_blob
“host.com/folder/blob.ext” exist #=> true if exist, false if does not exist
@param [String] uri the URL of the blob @return [Boolean]
# File lib/bucket_client/client.rb, line 267 def exist_blob(uri) raise NotImplementedError uri end
Gets the blob in the target URL as byte array.
blob = client.get_blob “host.com/bucket” result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> Byte array (payload of blob)
@param [String] uri the endpoint of the blob you want to get @return [OperationResult]
# File lib/bucket_client/client.rb, line 240 def get_blob(uri) raise NotImplementedError uri end
Gets the blob in the target URL as byte array
Raises exception if operation fails
blob = client.get_blob! “host.com/bucket” #=> [12,65,127,33] (some byte array)
@param [String] uri the endpoint of the blob you want to get @return [Array<Byte>]
# File lib/bucket_client/client.rb, line 252 def get_blob!(uri) result = get_blob(uri) raise BucketOperationException.new(result) unless result.success result.value end
Creates the blob with the payload if it does not exist, Updates the blob with the new payload if it exist
img = IO.binread “pic.png” uri = “” result = client.put_blob img, uri result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> Uri of blob
@param [Array<Byte>] payload the payload to put @param [String] uri the URL of the blob @return [OperationResult]
# File lib/bucket_client/client.rb, line 320 def put_blob(payload, uri) raise NotImplementedError payload.to_s + uri end
Creates the blob with the payload if it does not exist, Updates the blob with the new payload if it exist
Raises exception if the operation fails
img = IO.binread “pic.png” uri = “” result = client.put_blob!(img,uri) #=> returns URI of updated blob
@param [Array<Byte>] payload the payload to put @param [String] uri the URL of the blob @return [String]
# File lib/bucket_client/client.rb, line 336 def put_blob!(payload, uri) result = put_blob payload, uri raise NotImplementedError result unless result.success result.value end
Updates a blob with new payload in byte array Fails if blob with the URI doesn't exist
img = IO.binread “pic.png” uri = “” result = client.update_blob img, uri result.success #=> Whether the operation succeeded result.code #=> Status Code of the operation result.message #=> Error message if it failed result.value #=> Uri of update blob
@param [Array<Byte>] payload the payload to update the blob @param [String] uri the URL of the blob @return [OperationResult]
# File lib/bucket_client/client.rb, line 285 def update_blob(payload, uri) raise NotImplementedError payload.to_s + uri end
Updates a blob with new payload in byte array Fails if blob doesnt exist
Raises exception if operation fails
img = IO.binread “pic.png” uri = “” result = client.update_blob! img, uri #=> URI of update blob
@param [Array<Byte>] payload the payload to update the blob @param [String] uri the URL of the blob
# File lib/bucket_client/client.rb, line 300 def update_blob!(payload, uri) result = update_blob payload, uri raise BucketOperationException.new(result) unless result.success result.value end