List bucket labels
Stay organized with collections
Save and categorize content based on your preferences.
Retrieve the labels for a Cloud Storage bucket.
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[],[],null,["# List bucket labels\n\nRetrieve the labels for a Cloud Storage bucket.\n\nCode sample\n-----------\n\n### C++\n\n\nFor more information, see the\n[Cloud Storage C++ API\nreference documentation](/cpp/docs/reference/storage/latest).\n\n\nTo authenticate to Cloud Storage, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for client libraries](/storage/docs/authentication#client-libs).\n\n namespace gcs = ::google::cloud::storage;\n using ::google::cloud::StatusOr;\n [](gcs::Client client, std::string const& bucket_name) {\n StatusOr\u003cgcs::BucketMetadata\u003e bucket_metadata =\n client.GetBucketMetadata(bucket_name, gcs::Fields(\"labels\"));\n if (!bucket_metadata) throw std::move(bucket_metadata).status();\n\n if (bucket_metadata-\u003elabels().empty()) {\n std::cout \u003c\u003c \"The bucket \" \u003c\u003c bucket_name \u003c\u003c \" has no labels set.\\n\";\n return;\n }\n\n std::cout \u003c\u003c \"The labels for bucket \" \u003c\u003c bucket_name \u003c\u003c \" are:\";\n for (auto const& kv : bucket_metadata-\u003elabels()) {\n std::cout \u003c\u003c \"\\n \" \u003c\u003c kv.first \u003c\u003c \": \" \u003c\u003c kv.second;\n }\n std::cout \u003c\u003c \"\\n\";\n }\n\n### PHP\n\n\nFor more information, see the\n[Cloud Storage PHP API\nreference documentation](https://googleapis.github.io/google-cloud-php/#/docs/google-cloud/latest/storage/storageclient).\n\n\nTo authenticate to Cloud Storage, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for client libraries](/storage/docs/authentication#client-libs).\n\n use Google\\Cloud\\Storage\\StorageClient;\n\n /**\n * Prints a list of a bucket's lables.\n *\n * @param string $bucketName The name of your Cloud Storage bucket.\n * (e.g. 'my-bucket')\n */\n function get_bucket_labels(string $bucketName): void\n {\n $storage = new StorageClient();\n $bucket = $storage-\u003ebucket($bucketName);\n $info = $bucket-\u003einfo();\n if (isset($info['labels'])) {\n foreach ($info['labels'] as $labelKey =\u003e $labelValue) {\n printf('%s: %s' . PHP_EOL, $labelKey, $labelValue);\n }\n }\n }\n\n### Python\n\n\nFor more information, see the\n[Cloud Storage Python API\nreference documentation](https://cloud.google.com/python/docs/reference/storage/latest).\n\n\nTo authenticate to Cloud Storage, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for client libraries](/storage/docs/authentication#client-libs).\n\n import pprint\n\n from google.cloud import https://cloud.google.com/python/docs/reference/storage/latest/\n\n\n def get_bucket_labels(bucket_name):\n \"\"\"Prints out a bucket's labels.\"\"\"\n # bucket_name = 'your-bucket-name'\n storage_client = https://cloud.google.com/python/docs/reference/storage/latest/.https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.client.Client.html()\n\n bucket = storage_client.https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.client.Client.html#google_cloud_storage_client_Client_get_bucket(bucket_name)\n\n labels = bucket.https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.bucket.Bucket.html#google_cloud_storage_bucket_Bucket_labels\n pprint.pprint(labels)\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=storage)."]]