GCP Cloud Function in Java for Bolt

Sample Java Cloud Function in GCP that utilizes Cloud Storage Client library.

Requirements

• Java 11 or later
• Apache Maven / Gradle

Build From Source

• Download the source and change to the directory containing the sample code:

git clone https://gitlab.com/projectn-oss/projectn-bolt-java-gcf-sample.git 

cd projectn-bolt-java-gcf-sample

Deploy

To deploy the function, run the following command:

gcloud functions deploy <function-name> \
--entry-point com.projectn.bolt.BoltGSOpsHandler \
--runtime java11 \
--trigger-http \
--memory 512MB \
--service-account=<service-account-email> \
--project=<project-id> \
--region <region> \
--set-env-vars BOLT_URL=<Bolt-Service-Url>

Usage

The sample Java Cloud Function illustrates the usage and various operations, via separate entry points, that can be performed using Cloud Storage Client library for Java. The deployed Java Cloud Function can be tested from the Google Cloud Console by specifying a triggering event in JSON format.

Please ensure that Bolt is deployed before testing the sample Java Cloud Function. If you haven't deployed Bolt, follow the instructions given here to deploy Bolt.

Testing Bolt or GS Operations

BoltGSOpsHandler is the function that enables the user to perform Bolt or GS operations. It sends a Bucket or Object request to Bolt or GS and returns an appropriate response based on the parameters passed in as input.

• BoltGSOpsHandler represents a Google Cloud Function that is invoked by an HTTP Request.

• BoltGSOpsHandler accepts the following input parameters as part of the HTTP Request:

  • sdkType - Endpoint to which request is sent. The following values are supported:

    • GS - The Request is sent to Google Cloud Storage.
    • Bolt - The Request is sent to Bolt, whose endpoint is configured via 'BOLT_URL' environment variable

  • requestType - type of request / operation to be performed. The following requests are supported:

    • list_objects - list objects
    • list_buckets - list buckets
    • get_object_md - head object
    • get_bucket_md - head bucket
    • download_object - get object (md5 hash)
    • upload_object - upload object
    • delete_object - delete object

  • bucket - bucket name

  • key - key name

• Following are examples of events, for various requests, that can be used to invoke the function.

  • Listing objects from Bolt bucket:

      {"requestType": "list_objects", "sdkType": "BOLT", "bucket": "<bucket>"}

  • Listing buckets from GS:

    {"requestType": "list_buckets", "sdkType": "GS"}

  • Get Bolt object metadata (GET_OBJECT_MD):

    {"requestType": "get_object_md", "sdkType": "BOLT", "bucket": "<bucket>", "key": "<key>"}

  • Check if GS bucket exists (GET_BUCKET_MD):

    {"requestType": "get_bucket_md","sdkType": "GS", "bucket": "<bucket>"}

  • Download object (its MD5 Hash) from Bolt:

    {"requestType": "download_object", "sdkType": "BOLT", "bucket": "<bucket>", "key": "<key>"}

  • Upload object to Bolt:

    {"requestType": "upload_object", "sdkType": "BOLT", "bucket": "<bucket>", "key": "<key>", "value": "<value>"}

  • Delete object from Bolt:

    {"requestType": "delete_object", "sdkType": "BOLT", "bucket": "<bucket>", "key": "<key>"}

Data Validation Tests

BoltGSValidateObjHandler is the function that enables the user to perform data validation tests. It retrieves the object from Bolt and GS (Bucket Cleaning is disabled), computes and returns their corresponding MD5 hash. If the object is gzip encoded, object is decompressed before computing its MD5.

• BoltGSValidateObjHandler represents a Google Cloud Function that is invoked by an HTTP Request for performing data validation tests. To use this Function, change the entry point to com.projectn.bolt.BoltGSValidateObjHandler

• BoltGSValidateObjHandler accepts the following input parameters as part of the HTTP Request:

  • bucket - bucket name

  • key - key name

• Following is an example of an event that can be used to invoke the function.

  • Retrieve object(its MD5 hash) from Bolt and GS:

    If the object is gzip encoded, object is decompressed before computing its MD5.

    {"bucket": "<bucket>", "key": "<key>"}

Getting Help

For additional assistance, please refer to Project N Docs or contact us directly here