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. जब भी ऑब्जेक्ट के मेटाडेटा में कोई बदलाव होता है, तो 'metageneration' एट्रिब्यूट की वैल्यू में बढ़ोतरी होती है. नए ऑब्जेक्ट के लिए, 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 प्रॉमिस दिखाया हो.

उदाहरण: इमेज में बदलाव करना

Cloud Functions को 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 पर उपलब्ध है.