gcs-read.html

<!--
Copyright 2019 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

<script type="text/html" data-template-name="google-cloud-gcs-read">
    <!--Name-->
    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name">
    </div>
    
    <!--Account-->
    <div class="form-row">
        <label for="node-input-account"><i class="fa fa-user"></i> Credentials</label>
        <input type="text" id="node-input-account">
    </div>

    <!--Key Filename-->
    <div class="form-row">
        <label for="node-input-keyFilename"><i class="fa fa-user"></i> Key File</label>
        <input type="text" id="node-input-keyFilename">
    </div>

    <!--Filename-->
    <div class="form-row">
        <label for="node-input-filename"><i class="fa fa-file"></i> File Name</label>
        <input type="text" id="node-input-filename">
    </div>

    <!--List-->
    <div class="form-row">
        <label for="node-input-list"><i class="fa fa-list"></i> List</label>
        <input type="checkbox" id="node-input-list" style="width: 20px;vertical-align: top;">  List the files.
    </div>  
    
    <!--To Base64-->
    <div class="form-row">
        <label for="node-input-toBase64"><i class="fa fa-code"></i> Base64</label>
        <input type="checkbox" id="node-input-toBase64" style="width: 20px;vertical-align: top;">  Convert to base64
    </div>

</script>

<script type="text/html" data-help-name="google-cloud-gcs-read">
    <p>Read data from Google Cloud Storage.</p>
    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>msg.filename
            <span class="property-type">string</span>
        </dt>
        <dd>The name of the file in URL form.</dd>
    </dl>
    <h3>Outputs</h3>
    <dl class="message-properties">
        <dt>msg.payload
            <span class="property-type">string</span>
        </dt>
        <dd>The payload read from the Google Cloud Storage object</dd>
        <dt>msg.contenttype
            <span class="property-type">string</span>
        </dt>
        <dd>The MIME content type of the object.</dd>
    </dl>

    <h3>Details</h3>
    <p>This node can either read the contents of a file or list the files in a bucket.
        If reading the contents of a file, <code>msg.filename</code> is the identity of the file to be read
        from GCS.  If listing the contents of a bucket, <code>msg.filename</code> is the identity of the 
        bucket to be listed.  The format of the file name is a URL string of the form
        <code>gs://[BUCKET]/[FILENAME]</code>.  Alternatively, we can specify the file to be read in the file name configuration property.
        If both this property and a runtime value found in <code>msg.filename</code> are present, then the <code>msg.filename</code> name will be used.
    </p>
    The metadata associated with the file is returned in <code>msg.metadata</code>.
    </p>
</script>

<script type="text/javascript">

RED.nodes.registerType("google-cloud-gcs-read", {
    category: "GCP",
    defaults: {
        account: { type: "google-cloud-credentials", required: false },
        keyFilename: {value: "", required: false },
        filename: { required: false },
        list: { value: false, required: false},
        toBase64: {value: false, required: false },
        name: { value: "", required: false }
    },
    inputs: 1,
    outputs: 1,
    icon: "gcs.png",
    align: "left",
    color: "#3FADB5",
    label: function () {
        return this.name || "gcs-read";
    },
    paletteLabel: "gcs-read"
});
</script>