Cloud Storage के ट्रिगर


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

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

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

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

functions.storage का इस्तेमाल करें एक ऐसा फ़ंक्शन बनाने के लिए जो Cloud 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 वैल्यू 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 में ऑब्जेक्ट को आसानी से डाउनलोड और फिर से अपलोड करने के लिए, Google Cloud Storage पैकेज का इस्तेमाल किया जा रहा है npm install --save @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

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

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

इमेज प्रोसेसिंग प्रोग्राम के साथ 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 पर उपलब्ध है.