Cloud Storage ट्रिगर

Cloud Storage में फ़ाइलों और फ़ोल्डर को अपलोड करने, अपडेट करने या मिटाने के जवाब में, फ़ंक्शन को ट्रिगर किया जा सकता है.

इस पेज में दिए गए उदाहरण, एक सैंपल फ़ंक्शन पर आधारित हैं जो Cloud Storage में इमेज फ़ाइलों को अपलोड किए जाने पर ट्रिगर होता है. इस सैंपल फ़ंक्शन से, इवेंट एट्रिब्यूट को ऐक्सेस करने, Cloud Functions इंस्टेंस में फ़ाइल डाउनलोड करने, और Cloud Storage इवेंट को मैनेज करने की अन्य बुनियादी बातों की जानकारी मिलती है.

इस्तेमाल के उदाहरणों के और उदाहरण देखने के लिए, Cloud Functions की मदद से क्या किया जा सकता है?

Cloud Storage में बदलाव होने पर फ़ंक्शन ट्रिगर करना

Cloud Storage इवेंट को मैनेज करने वाला फ़ंक्शन बनाने के लिए, functions.storage का इस्तेमाल करें. आपको अपने फ़ंक्शन को किसी खास Cloud Storage बकेट के दायरे में लाना है या डिफ़ॉल्ट बकेट का इस्तेमाल करना है, इसके आधार पर इनमें से किसी एक का इस्तेमाल करें:

• functions.storage.object() का इस्तेमाल करके, डिफ़ॉल्ट Cloud Storage बकेट में ऑब्जेक्ट में हुए बदलावों को सुनें.
• functions.storage.bucket('bucketName').object() किसी खास बकेट पर ऑब्जेक्ट में हुए बदलावों को सुनने के लिए.

उदाहरण के लिए, थंबनेल जनरेटर सैंपल, प्रोजेक्ट के डिफ़ॉल्ट बकेट तक सीमित होता है:

exports.firstGenGenerateThumbnail = functions.storage.object().onFinalize(async (object) => {
  // ...
});

Cloud Storage, इन इवेंट के साथ काम करता है:

• onArchive सिर्फ़ तब भेजा जाता है, जब किसी बकेट में ऑब्जेक्ट का वर्शन चालू किया गया हो. यह इवेंट बताता है कि किसी ऑब्जेक्ट का लाइव वर्शन संग्रहित वर्शन बन गया है, क्योंकि या तो इसे संग्रहित किया गया था या इसी नाम के किसी ऑब्जेक्ट को अपलोड करने की वजह से इसे ओवरराइट किया गया था.
• onDelete यह सूचना तब भेजी जाती है, जब कोई ऑब्जेक्ट हमेशा के लिए मिटाया जाता है. इसमें ऐसे ऑब्जेक्ट शामिल होते हैं जिन्हें ओवरराइट किया गया है या जिन्हें बकेट के लाइफ़साइकल कॉन्फ़िगरेशन के हिस्से के तौर पर मिटा दिया गया है. जिन बकेट में ऑब्जेक्ट का वर्शन चालू है, उनके लिए इसे संग्रहित नहीं किया जाता (onArchive देखें), भले ही संग्रह storage.objects.delete तरीके से किया गया हो.
• onFinalize यह सूचना तब भेजी जाती है, जब बकेट में कोई नया ऑब्जेक्ट (या किसी मौजूदा ऑब्जेक्ट की नई जनरेशन) सही तरीके से बनाया जाता है. इसमें किसी मौजूदा ऑब्जेक्ट को कॉपी करना या फिर से लिखना शामिल है. अपलोड न हो पाने से यह इवेंट ट्रिगर नहीं होता.
• onMetadataUpdate यह सूचना तब भेजी जाती है, जब किसी मौजूदा ऑब्जेक्ट का मेटाडेटा बदलता है.

onFinalize के लिए ऊपर दिखाए गए तरीके से, इवेंट को on इवेंट हैंडलर में सेट करें.

Cloud Storage के ऑब्जेक्ट एट्रिब्यूट को ऐक्सेस करना

Cloud Functions, अपडेट की गई फ़ाइल के लिए कई Cloud Storage ऑब्जेक्ट एट्रिब्यूट दिखाता है, जैसे कि size और contentType. ऑब्जेक्ट के मेटाडेटा में बदलाव होने पर, 'meta Generation' एट्रिब्यूट की वैल्यू बढ़ जाती है. नए ऑब्जेक्ट के लिए, metageneration की वैल्यू 1 है.

const fileBucket = object.bucket; // The Storage bucket that contains the file.
const filePath = object.name; // File path in the bucket.
const contentType = object.contentType; // File content type.
index.js

थंबनेल जनरेशन सैंपल, इनमें से कुछ एट्रिब्यूट का इस्तेमाल करके, उन एग्ज़िट केस का पता लगाता है जिनमें फ़ंक्शन रिटर्न करता है:

// Exit if this is triggered on a file that is not an image.
if (!contentType.startsWith('image/')) {
  return functions.logger.log('This is not an image.');
}

// Get the file name.
const fileName = path.basename(filePath);
// Exit if the image is already a thumbnail.
if (fileName.startsWith('thumb_')) {
  return functions.logger.log('Already a Thumbnail.');
}
index.js

फ़ाइल डाउनलोड करना, बदलना, और अपलोड करना

कुछ मामलों में, हो सकता है कि Cloud Storage से फ़ाइलें डाउनलोड करना ज़रूरी न हो. हालांकि, Cloud Storage में सेव की गई किसी फ़ाइल से थंबनेल इमेज जनरेट करने जैसे मुश्किल काम करने के लिए, आपको फ़ंक्शन इंस्टेंस यानी आपके कोड को चलाने वाली वर्चुअल मशीन में फ़ाइलें डाउनलोड करनी होंगी.

Cloud Storage में आसानी से ऑब्जेक्ट डाउनलोड और फिर से अपलोड करने के लिए, npm install --save @google-cloud/storage का इस्तेमाल करके Google Cloud Storage पैकेज इंस्टॉल करें और उसे इंपोर्ट करें. JavaScript में दिए गए, थंबनेल प्रोसेस करने के टास्क जैसी बाहरी प्रोसेस को हैंडल करने का वादा करने के लिए, child-process-promise को भी इंपोर्ट करें:

const functions = require('firebase-functions/v1');
const admin = require('firebase-admin');
admin.initializeApp()
const path = require('path');

//library for resizing images
const sharp = require('sharp');
index.js

अपने Cloud Functions इंस्टेंस पर, अस्थायी डायरेक्ट्री में फ़ाइल डाउनलोड करने के लिए gcs.bucket.file(filePath).download का इस्तेमाल करें. इस जगह पर, ज़रूरत के हिसाब से फ़ाइल को प्रोसेस किया जा सकता है और फिर उसे Cloud Storage पर अपलोड किया जा सकता है. एसिंक्रोनस टास्क पूरा करते समय, पक्का करें कि आपने कॉलबैक में, JavaScript का प्रॉमिस दिखाया.

उदाहरण: इमेज ट्रांसफ़ॉर्मेशन

sharp जैसे इमेज प्रोसेसिंग प्रोग्राम के साथ क्लाउड फ़ंक्शन का इस्तेमाल करके, ग्राफ़िकल इमेज फ़ाइलों में बदलाव किए जा सकते हैं. अपलोड की गई इमेज फ़ाइल के लिए थंबनेल इमेज बनाने का तरीका यहां दिया गया है:

// Download file from bucket.
const bucket = admin.storage().bucket(fileBucket);
const metadata = {
  contentType: contentType,
};
const downloadResponse = await bucket.file(filePath).download();
const imageBuffer = downloadResponse[0];
functions.logger.log("Image downloaded!");

// Generate a thumbnail using sharp.
const thumbnailBuffer = await sharp(imageBuffer).resize({
  width: 200,
  height: 200,
  withoutEnlargement: true,
}).toBuffer();
functions.logger.log("Thumbnail created");

// Upload the thumbnail with a 'thumb_' prefix.
const thumbFileName = `thumb_${fileName}`;
const thumbFilePath = path.join(path.dirname(filePath), thumbFileName);
await bucket.file(thumbFilePath).save(thumbnailBuffer, {
  metadata: metadata,
});
return functions.logger.log("Thumbnail uploaded!");
index.js

यह कोड, अस्थायी डायरेक्ट्री में सेव की गई इमेज के लिए 200x200 का थंबनेल बनाता है. इसके बाद, उसे Cloud Storage में वापस अपलोड कर देता है.

ज़्यादा उदाहरण देखें

मीडिया ट्रांसफ़ॉर्मेशन के सामान्य फ़ंक्शन के और उदाहरण. जैसे, इमेज को ट्रांसकोड करना, कॉन्टेंट मॉडरेट करना, EXIF मेटाडेटा निकालना. उदाहरणों की पूरी सूची GitHub पर उपलब्ध है.