Skip to content

Latest commit

 

History

History

samples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
acceptance
acceptance
 
 
.rubocop.yml
.rubocop.yml
 
 
Gemfile
Gemfile
 
 
README.md
README.md
 
 
Rakefile
Rakefile
 
 
storage_activate_hmac_key.rb
storage_activate_hmac_key.rb
 
 
storage_add_bucket_conditional_iam_binding.rb
storage_add_bucket_conditional_iam_binding.rb
 
 
storage_add_bucket_default_owner.rb
storage_add_bucket_default_owner.rb
 
 
storage_add_bucket_iam_member.rb
storage_add_bucket_iam_member.rb
 
 
storage_add_bucket_label.rb
storage_add_bucket_label.rb
 
 
storage_add_bucket_owner.rb
storage_add_bucket_owner.rb
 
 
storage_add_file_owner.rb
storage_add_file_owner.rb
 
 
storage_bucket_delete_default_kms_key.rb
storage_bucket_delete_default_kms_key.rb
 
 
storage_change_default_storage_class.rb
storage_change_default_storage_class.rb
 
 
storage_change_file_storage_class.rb
storage_change_file_storage_class.rb
 
 
storage_compose_file.rb
storage_compose_file.rb
 
 
storage_configure_retries.rb
storage_configure_retries.rb
 
 
storage_copy_file.rb
storage_copy_file.rb
 
 
storage_copy_file_archived_generation.rb
storage_copy_file_archived_generation.rb
 
 
storage_cors_configuration.rb
storage_cors_configuration.rb
 
 
storage_create_bucket.rb
storage_create_bucket.rb
 
 
storage_create_bucket_class_location.rb
storage_create_bucket_class_location.rb
 
 
storage_create_bucket_dual_region.rb
storage_create_bucket_dual_region.rb
 
 
storage_create_bucket_hierarchical_namespace.rb
storage_create_bucket_hierarchical_namespace.rb
 
 
storage_create_bucket_notifications.rb
storage_create_bucket_notifications.rb
 
 
storage_create_bucket_turbo_replication.rb
storage_create_bucket_turbo_replication.rb
 
 
storage_create_bucket_with_object_retention.rb
storage_create_bucket_with_object_retention.rb
 
 
storage_create_hmac_key.rb
storage_create_hmac_key.rb
 
 
storage_deactivate_hmac_key.rb
storage_deactivate_hmac_key.rb
 
 
storage_define_bucket_website_configuration.rb
storage_define_bucket_website_configuration.rb
 
 
storage_delete_bucket.rb
storage_delete_bucket.rb
 
 
storage_delete_bucket_notification.rb
storage_delete_bucket_notification.rb
 
 
storage_delete_file.rb
storage_delete_file.rb
 
 
storage_delete_file_archived_generation.rb
storage_delete_file_archived_generation.rb
 
 
storage_delete_hmac_key.rb
storage_delete_hmac_key.rb
 
 
storage_disable_bucket_lifecycle_management.rb
storage_disable_bucket_lifecycle_management.rb
 
 
storage_disable_default_event_based_hold.rb
storage_disable_default_event_based_hold.rb
 
 
storage_disable_requester_pays.rb
storage_disable_requester_pays.rb
 
 
storage_disable_uniform_bucket_level_access.rb
storage_disable_uniform_bucket_level_access.rb
 
 
storage_disable_versioning.rb
storage_disable_versioning.rb
 
 
storage_download_byte_range.rb
storage_download_byte_range.rb
 
 
storage_download_encrypted_file.rb
storage_download_encrypted_file.rb
 
 
storage_download_file.rb
storage_download_file.rb
 
 
storage_download_file_into_memory.rb
storage_download_file_into_memory.rb
 
 
storage_download_file_requester_pays.rb
storage_download_file_requester_pays.rb
 
 
storage_download_public_file.rb
storage_download_public_file.rb
 
 
storage_enable_bucket_lifecycle_management.rb
storage_enable_bucket_lifecycle_management.rb
 
 
storage_enable_default_event_based_hold.rb
storage_enable_default_event_based_hold.rb
 
 
storage_enable_requester_pays.rb
storage_enable_requester_pays.rb
 
 
storage_enable_uniform_bucket_level_access.rb
storage_enable_uniform_bucket_level_access.rb
 
 
storage_enable_versioning.rb
storage_enable_versioning.rb
 
 
storage_generate_encryption_key.rb
storage_generate_encryption_key.rb
 
 
storage_generate_signed_post_policy_v4.rb
storage_generate_signed_post_policy_v4.rb
 
 
storage_generate_signed_url_v2.rb
storage_generate_signed_url_v2.rb
 
 
storage_generate_signed_url_v4.rb
storage_generate_signed_url_v4.rb
 
 
storage_generate_upload_signed_url_v4.rb
storage_generate_upload_signed_url_v4.rb
 
 
storage_get_autoclass.rb
storage_get_autoclass.rb
 
 
storage_get_bucket_class_and_location.rb
storage_get_bucket_class_and_location.rb
 
 
storage_get_bucket_metadata.rb
storage_get_bucket_metadata.rb
 
 
storage_get_default_event_based_hold.rb
storage_get_default_event_based_hold.rb
 
 
storage_get_hmac_key.rb
storage_get_hmac_key.rb
 
 
storage_get_metadata.rb
storage_get_metadata.rb
 
 
storage_get_public_access_prevention.rb
storage_get_public_access_prevention.rb
 
 
storage_get_requester_pays_status.rb
storage_get_requester_pays_status.rb
 
 
storage_get_retention_policy.rb
storage_get_retention_policy.rb
 
 
storage_get_rpo.rb
storage_get_rpo.rb
 
 
storage_get_service_account.rb
storage_get_service_account.rb
 
 
storage_get_uniform_bucket_level_access.rb
storage_get_uniform_bucket_level_access.rb
 
 
storage_list_bucket_notifications.rb
storage_list_bucket_notifications.rb
 
 
storage_list_buckets.rb
storage_list_buckets.rb
 
 
storage_list_file_archived_generations.rb
storage_list_file_archived_generations.rb
 
 
storage_list_files.rb
storage_list_files.rb
 
 
storage_list_files_with_prefix.rb
storage_list_files_with_prefix.rb
 
 
storage_list_hmac_keys.rb
storage_list_hmac_keys.rb
 
 
storage_lock_retention_policy.rb
storage_lock_retention_policy.rb
 
 
storage_make_public.rb
storage_make_public.rb
 
 
storage_move_file.rb
storage_move_file.rb
 
 
storage_object_csek_to_cmek.rb
storage_object_csek_to_cmek.rb
 
 
storage_print_bucket_acl.rb
storage_print_bucket_acl.rb
 
 
storage_print_bucket_acl_for_user.rb
storage_print_bucket_acl_for_user.rb
 
 
storage_print_file_acl.rb
storage_print_file_acl.rb
 
 
storage_print_file_acl_for_user.rb
storage_print_file_acl_for_user.rb
 
 
storage_print_pubsub_bucket_notification.rb
storage_print_pubsub_bucket_notification.rb
 
 
storage_quickstart.rb
storage_quickstart.rb
 
 
storage_release_event_based_hold.rb
storage_release_event_based_hold.rb
 
 
storage_release_temporary_hold.rb
storage_release_temporary_hold.rb
 
 
storage_remove_bucket_acl.rb
storage_remove_bucket_acl.rb
 
 
storage_remove_bucket_conditional_iam_binding.rb
storage_remove_bucket_conditional_iam_binding.rb
 
 
storage_remove_bucket_default_acl.rb
storage_remove_bucket_default_acl.rb
 
 
storage_remove_bucket_iam_member.rb
storage_remove_bucket_iam_member.rb
 
 
storage_remove_bucket_label.rb
storage_remove_bucket_label.rb
 
 
storage_remove_cors_configuration.rb
storage_remove_cors_configuration.rb
 
 
storage_remove_file_acl.rb
storage_remove_file_acl.rb
 
 
storage_remove_retention_policy.rb
storage_remove_retention_policy.rb
 
 
storage_rotate_encryption_key.rb
storage_rotate_encryption_key.rb
 
 
storage_set_autoclass.rb
storage_set_autoclass.rb
 
 
storage_set_bucket_default_kms_key.rb
storage_set_bucket_default_kms_key.rb
 
 
storage_set_bucket_public_iam.rb
storage_set_bucket_public_iam.rb
 
 
storage_set_client_endpoint.rb
storage_set_client_endpoint.rb
 
 
storage_set_event_based_hold.rb
storage_set_event_based_hold.rb
 
 

README.md

Google Cloud Platform logo

Google Cloud Storage Ruby Samples

This directory contains samples for google-cloud-storage. Google Cloud Storage allows world-wide storage and retrieval of any amount of data at any time.

Setup

Authentication

Authentication is typically done through Application Default Credentials , which means you do not have to change the code to authenticate as long as your environment has credentials. You have a few options for setting up authentication:

  1. When running locally, use the Google Cloud SDK

    gcloud auth application-default login

  2. When running on App Engine or Compute Engine, credentials are already set-up. However, you may need to configure your Compute Engine instance with additional scopes.

  3. You can create a Service Account key file . This file can be used to authenticate to Google Cloud Platform services from any environment. To use the file, set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the path to the key file, for example:

    export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json

Set Project ID

Next, set the GOOGLE_CLOUD_PROJECT environment variable to the project name set in the Google Cloud Platform Developer Console:

`export GOOGLE_CLOUD_PROJECT="YOUR-PROJECT-ID"`

Install Dependencies

  1. Install the Bundler gem.

  2. Install dependencies using:

    bundle install

Run tests

Run the tests for these samples by running bundle exec rake test.

Run samples

Usage: ruby sample.rb [arguments]

List of executable samples files and their arguments
File Args Description
storage_activate_hmac_key.rb access_id Activate an HMAC Key
storage_add_bucket_conditional_iam_binding.rb bucket Add a conditional bucket-level binding
storage_add_bucket_iam_member.rb bucket Add a bucket-level IAM member
storage_add_bucket_label.rb bucket label_key label_value Add bucket label
storage_bucket_delete_default_kms_key.rb bucket Delete the default KMS encryption key from a bucket
storage_change_default_storage_class.rb bucket Set the default storage class for a bucket
storage_change_file_storage_class.rb bucket file Set the storage class for a file
storage_compose_file.rb bucket first_file_name second_file_name dest_file Compose a new file from sources
storage_copy_file.rb src_bucket src_file dest_bucket dest_file Copy a file to another bucket
storage_copy_file_archived_generation.rb src_bucket src_file generation dest_bucket dest_file Copy a file generation to another bucket
storage_cors_configuration.rb bucket Set a CORS rule for a bucket
storage_create_bucket.rb bucket Create a new bucket with default storage class and location
storage_create_bucket_class_location.rb bucket Create a new bucket with specific storage class and location
storage_create_bucket_dual_region.rb bucket Create a new bucket with default storage class and dual region location
storage_create_hmac_key.rb service_account_email Create HMAC Key
storage_deactivate_hmac_key.rb access_id Deactivate an HMAC Key
storage_define_bucket_website_configuration.rb bucket main_page_suffix not_found_page Configure index and 404 pages for static website bucket
storage_delete_bucket.rb bucket Delete bucket with the provided name
storage_delete_file.rb bucket file Delete a file from a bucket
storage_delete_file_archived_generation.rb bucket file generation Delete a file generation from a bucket
storage_delete_hmac_key.rb access_id Delete a deactivated HMAC key
storage_disable_bucket_lifecycle_management.rb bucket Disable lifecycle management for a bucket
storage_disable_default_event_based_hold.rb bucket Disable event-based hold for a bucket
storage_disable_requester_pays.rb bucket Disable requester pays for a bucket
storage_disable_uniform_bucket_level_access.rb bucket Disable uniform bucket-level access for a bucket
storage_disable_versioning.rb bucket Disable versioning for a bucket
storage_download_encrypted_file.rb bucket file local_file_path encryption_key Download an encrypted file from a bucket
storage_download_file.rb bucket file local_file_path Download a file from a bucket
storage_download_file_requester_pays.rb project bucket file local_file_path Download a file from a requester pays enabled bucket
storage_download_public_file.rb bucket file local_file_path Download a publically accessible file from a bucket
storage_enable_bucket_lifecycle_management.rb bucket Enable lifecycle management for a bucket
storage_enable_default_event_based_hold.rb bucket Enable event-based hold for a bucket
storage_enable_requester_pays.rb bucket Enable requester pays for a bucket
storage_enable_uniform_bucket_level_access.rb bucket Enable uniform bucket-level access for a bucket
storage_enable_versioning.rb bucket Enable versioning for a bucket
storage_generate_encryption_key.rb Generate a sample encryption key
storage_generate_signed_post_policy_v4.rb bucket file Generate a V4 signed post policy for a file and print HTML form
storage_generate_signed_url_v2.rb bucket file Generate a V2 signed url for a file
storage_generate_signed_url_v4.rb bucket file Generate a V4 signed get url for a file
storage_generate_upload_signed_url_v4.rb bucket file Generate a V4 signed put url for a file
storage_get_bucket_metadata.rb bucket Display metadata for a bucket
storage_get_default_event_based_hold.rb bucket Get state of event-based hold for a bucket
storage_get_hmac_key access_id Get HMAC Key metadata
storage_get_metadata.rb bucket file Display metadata for a file in a bucket
storage_get_rerequester_pays_status.rb bucket Get requester pays status for a bucket
storage_get_retention_policy.rb bucket Get retention policy for a bucket
storage_get_service_account.rb Display the GCS service account for the project
storage_get_uniform_bucket_level_access.rb bucket Get uniform bucket-level access for a bucket
storage_list_buckets.rb List all buckets in the authenticated project
storage_list_file_archived_generations.rb bucket List all files with generation in the bucket
storage_list_files.rb bucket List all files in the bucket
storage_list_files_with_prefix.rb bucket prefix delimiter List all files with given prefix and optional delimiter in the bucket
storage_list_hmac_keys.rb List all HMAC keys for a project
storage_lock_retention_policy.rb bucket Lock retention policy
storage_make_public.rb bucket file Make a file in a bucket public
storage_move_file.rb bucket file new_name Rename a file in a bucket
storage_object_csek_to_cmek.rb bucket file encryption_key kms_key_name Change a file from a customer-supplied encryption key to a customer-managed encryption key
storage_quickstart.rb bucket Create a new bucket
storage_release_event_based_hold.rb bucket file Relase an event-based hold on a file
storage_release_temporary_hold.rb bucket file Release a temporary hold on a file
storage_remove_bucket_conditional_iam_binding.rb bucket Remove a conditional bucket-level binding
storage_remove_bucket_iam_member.rb bucket Remove a bucket-level IAM member
storage_remove_bucket_label.rb bucket label_key Delete bucket label
storage_remove_cors_configuration.rb bucket Remove CORS policies for a bucket
storage_remove_retention_policy.rb bucket Remove a retention policy from a bucket if policy is not locked
storage_rotate_encryption_key.rb bucket file base64_current_encryption_key base64_new_encryption_key Update encryption key of an encrypted file.
storage_set_bucket_default_kms_key.rb bucket kms_key Enable default KMS encryption for bucket
storage_set_bucket_public_iam.rb bucket Configure a bucket to be publicly readable
storage_set_event_based_hold.rb bucket file Set an event-based hold on a file
storage_set_metadata.rb bucket file Set metadata for a file in a bucket
storage_set_retention_policy.rb bucket retention_period Set a retention policy on bucket with a retention period determined in seconds
storage_set_temporary_hold.rb bucket file Set a temporary hold on a file
storage_upload_encrypted_file.rb bucket local_file_path file_name encryption_key Upload local file as an encrypted file to a bucket
storage_upload_file.rb bucket local_file_path file_name Upload local file to a bucket
storage_upload_with_kms_key.rb bucket local_file_path file_name kms_key Upload local file and encrypt service side using a KMS key
storage_view_bucket_iam_members.rb bucket View bucket-level IAM members