क्लाउड स्टोरेज ट्रिगर

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

इस पृष्ठ के उदाहरण एक नमूना फ़ंक्शन पर आधारित हैं जो तब ट्रिगर होता है जब छवि फ़ाइलें क्लाउड संग्रहण पर अपलोड की जाती हैं। यह नमूना फ़ंक्शन दर्शाता है कि ईवेंट विशेषताओं तक कैसे पहुंचें, क्लाउड फ़ंक्शंस इंस्टेंस में फ़ाइल कैसे डाउनलोड करें, और क्लाउड स्टोरेज ईवेंट को संभालने के अन्य मूलभूत सिद्धांत।

उपयोग के मामलों के अधिक उदाहरणों के लिए, देखें कि मैं क्लाउड फ़ंक्शंस के साथ क्या कर सकता हूँ?

क्लाउड स्टोरेज परिवर्तन पर एक फ़ंक्शन ट्रिगर करें

क्लाउड स्टोरेज इवेंट को हैंडल करने वाला फंक्शन बनाने के लिए functions.storage का उपयोग करें। इस पर निर्भर करते हुए कि आप अपने फ़ंक्शन को किसी विशिष्ट क्लाउड स्टोरेज बकेट तक सीमित करना चाहते हैं या डिफ़ॉल्ट बकेट का उपयोग करना चाहते हैं, निम्न में से किसी एक का उपयोग करें:

  • functions.storage.object() डिफ़ॉल्ट क्लाउड स्टोरेज बकेट पर ऑब्जेक्ट परिवर्तन सुनने के लिए।
  • functions.storage.bucket('bucketName').object() एक विशिष्ट बकेट पर वस्तु परिवर्तन सुनने के लिए।

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

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

क्लाउड स्टोरेज इन घटनाओं का समर्थन करता है:

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

onFinalize के लिए ऊपर दिखाए गए अनुसार ईवेंट को on इवेंट हैंडलर में सेट करें।

क्लाउड स्टोरेज ऑब्जेक्ट विशेषताओं तक पहुंचें

क्लाउड फ़ंक्शंस अपडेट की गई फ़ाइल के लिए 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.
const metageneration = object.metageneration; // Number of times metadata has been generated. New objects have a value of 1.

थंबनेल पीढ़ी का नमूना इनमें से कुछ विशेषताओं का उपयोग उन निकास मामलों का पता लगाने के लिए करता है जिनमें फ़ंक्शन वापस आता है:

// 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.');
}

फ़ाइल डाउनलोड करें, रूपांतरित करें और अपलोड करें

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

क्लाउड स्टोरेज में वस्तुओं को आसानी से डाउनलोड और पुनः अपलोड करने के लिए, npm install --save @google-cloud/storage का उपयोग करके Google क्लाउड स्टोरेज पैकेज स्थापित करें, और इसे आयात करें। नमूने में थंबनेल प्रसंस्करण कार्यों जैसी बाहरी प्रक्रियाओं को संभालने के लिए जावास्क्रिप्ट वादों का उपयोग करने के लिए, child-process-promise भी आयात करें:

const functions = require('firebase-functions');
const admin = require('firebase-admin');
admin.initializeApp()
const spawn = require('child-process-promise').spawn;
const path = require('path');
const os = require('os');
const fs = require('fs');

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

उदाहरण: छवि परिवर्तन

क्लाउड फंक्शंस ImageMagick नामक एक इमेज-प्रोसेसिंग प्रोग्राम प्रदान करता है जो ग्राफिकल इमेज फाइलों पर जोड़तोड़ कर सकता है। अपलोड की गई छवि फ़ाइल के लिए थंबनेल छवि बनाने का एक उदाहरण निम्नलिखित है:

// Download file from bucket.
const bucket = admin.storage().bucket(fileBucket);
const tempFilePath = path.join(os.tmpdir(), fileName);
const metadata = {
  contentType: contentType,
};
await bucket.file(filePath).download({destination: tempFilePath});
functions.logger.log('Image downloaded locally to', tempFilePath);
// Generate a thumbnail using ImageMagick.
await spawn('convert', [tempFilePath, '-thumbnail', '200x200>', tempFilePath]);
functions.logger.log('Thumbnail created at', tempFilePath);
// We add a 'thumb_' prefix to thumbnails file name. That's where we'll upload the thumbnail.
const thumbFileName = `thumb_${fileName}`;
const thumbFilePath = path.join(path.dirname(filePath), thumbFileName);
// Uploading the thumbnail.
await bucket.upload(tempFilePath, {
  destination: thumbFilePath,
  metadata: metadata,
});
// Once the thumbnail has been uploaded delete the local file to free up disk space.
return fs.unlinkSync(tempFilePath);

यह कोड एक अस्थायी निर्देशिका में सहेजी गई छवि के लिए 200x200 थंबनेल बनाने के लिए ImageMagick कमांड लाइन प्रोग्राम convert को निष्पादित करता है, फिर इसे क्लाउड स्टोरेज पर वापस अपलोड करता है।

और उदाहरण देखें

ट्रांसकोडिंग छवियों , सामग्री को मॉडरेट करने, EXIF ​​मेटाडेटा निकालने सहित सामान्य मीडिया परिवर्तन कार्यों के अधिक उदाहरण। उदाहरणों की पूरी सूची GitHub पर उपलब्ध है।

अधिक जानकारी के लिए संपूर्ण Google क्लाउड संग्रहण ट्रिगर दस्तावेज़ देखें।