Cumulus v0.1.0 Cumulus View Source

Link to this section Summary

Functions

This is the function responsible for returning the URL of a given bucket for upload purposes. This is separate from bucket_url/1 because Google uses a different endpoint for uploading files

This is the function responsible for returning the URL of a given bucket

This is the function responsible for finding an object in Google Cloud Storage and deleting it. Possible return values are

This is the function responsible for finding a bucket in Google Cloud Storage and returning it. Possible return values are

This is the function responsible for finding an object in Google Cloud Storage and returning it. Possible return values are

This is the function responsible for finding an object in Google Cloud Storage and returning the file itself. Possible return values are

This is the function responsible for returning the URL of a given bucket / object combination’s media (i.e., the file itself, not the metadata about the file)

This is the function responsible for returning the URL of a given bucket / object combination

This function is used to save a file into a given bucket

Link to this section Functions

Link to this function bucket_upload_url(bucket, object) View Source

This is the function responsible for returning the URL of a given bucket for upload purposes. This is separate from bucket_url/1 because Google uses a different endpoint for uploading files.

This is the function responsible for returning the URL of a given bucket.

Link to this function delete_object(bucket, object) View Source

This is the function responsible for finding an object in Google Cloud Storage and deleting it. Possible return values are:

  • {:error, :not_found} is used for buckets that are not found in the system
  • {:error, :not_authorized} is used for buckets that you do not have access to
  • {:error, :invalid_request} is used for requests where the bucket or object name is invalid
  • :ok is used to return the object’s contents

This is the function responsible for finding a bucket in Google Cloud Storage and returning it. Possible return values are:

  • {:error, :not_found} is used for buckets that are not found in the system
  • {:error, :not_authorized} is used for buckets that you do not have access to
  • {:error, :invalid_format} is used for responses where we cannot parse the response as a bucket
  • {:error, :invalid_request} is used for requests where the bucket name is invalid
  • {:ok, bucket} is for successful responses and where we can successfully parse the response as a bucket
Link to this function get_object(bucket, object) View Source

This is the function responsible for finding an object in Google Cloud Storage and returning it. Possible return values are:

  • {:error, :not_found} is used for buckets that are not found in the system
  • {:error, :not_authorized} is used for buckets that you do not have access to
  • {:error, :invalid_format} is used for responses where we cannot parse the response as an object
  • {:error, :invalid_request} is used for requests where the bucket or object name is invalid
  • {:ok, object} is for successful responses where we can successfully parse the response as an object
Link to this function get_object_media(bucket, object, key \\ nil, hash \\ nil) View Source

This is the function responsible for finding an object in Google Cloud Storage and returning the file itself. Possible return values are:

  • {:error, :not_found} is used for buckets that are not found in the system
  • {:error, :not_authorized} is used for buckets that you do not have access to
  • {:error, :invalid_request} is used for requests where the bucket or object name is invalid
  • {:ok, body} is used to return the object’s contents
Link to this function object_media_url(bucket, object) View Source

This is the function responsible for returning the URL of a given bucket / object combination’s media (i.e., the file itself, not the metadata about the file).

Link to this function object_url(bucket, object) View Source

This is the function responsible for returning the URL of a given bucket / object combination.

Link to this function save_object(bucket, object, filepath, key \\ nil, hash \\ nil) View Source

This function is used to save a file into a given bucket.

  • {:error, :not_found} is used for buckets that are not found in the system
  • {:error, :not_authorized} is used for buckets that you do not have access to
  • {:error, :invalid_request} is used for requests where the bucket or object name is invalid
  • {:ok, object} means the file was saved successfully