gcs-write.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-write">
    <!--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>

    <!--Credentials-->
    <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 File-->
    <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>

    <!--File Name-->
    <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>

    <!--Content Type-->
    <div class="form-row">
        <label for="node-input-contentType"><i class="fa fa-info-circle"></i> Content Type</label>
        <input type="text" id="node-input-contentType">
    </div>

</script>

<script type="text/html" data-help-name="google-cloud-gcs-write">
    <p>Write data to Google Cloud Storage.</p>
    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>msg.payload
            <span class="property-type">string</span>
        </dt>
        <dd>The payload to write to the Google Cloud Storage object</dd>

        <dt>msg.filename
            <span class="property-type">string</span>
        </dt>
        <dd>The name of the file in URL form.</dd>
        
        <dt>msg.contentType
            <span class="property-type">string</span>
        </dt>
        <dd>[Optional] The MIME content type of the object.</dd>
    </dl>

    <h3>Details</h3>
    <p>This node writes the content of the payload to a GCS object. 

        On execution, the data contained in <code>msg.payload</code> is written into the file specified by <code>msg.filename</code>.
        The format of this field is a GCS Url of the form <code>gs://[BUCKET]/[FILE]</code>.
        Optionally, the file to be written can be supplied as the file name property during configuration.  If both are supplied,
        the <code>msg.filename</code> will be used. 

        An optional field called <code>msg.contentType</code> contains the MIME type to be associated with the file.
        If this is not specified but a configuration property for content type is, then THAT will be used.  If neither are supplied,
        then we don't specify a content type for the GCS file.
    </p>
</script>

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