googlecloudstorage

package
v0.15.0-beta Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 25, 2024 License: MIT Imports: 12 Imported by: 0

README

---
title: "Google Cloud Storage"
lang: "en-US"
draft: false
description: "Learn about how to set up a VDP Google Cloud Storage connector https://github.com/instill-ai/instill-core"
---

The Google Cloud Storage component is a data connector that allows users to upload data to Google's Cloud Storage.
It can carry out the following tasks:

- [Upload](#upload)

## Release Stage

`Alpha`

## Configuration

The component configuration is defined and maintained [here](https://github.com/instill-ai/component/blob/main/pkg/connector/googlecloudstorage/v0/config/definition.json).

## Connection

| Field | Field ID | Type | Note |
| :--- | :--- | :--- | :--- |
| Bucket Name (required) | `bucket_name` | string | Name of the bucket to be used for object storage. |
| JSON Key File contents (required) | `json_key` | string | Contents of the JSON key file with access to the bucket. |

## Supported Tasks

### Upload

Upload data to Google Cloud Storage.

| Input | ID | Type | Description |
| :--- | :--- | :--- | :--- |
| Task ID (required) | `task` | string | `TASK_UPLOAD` |
| Object Name (required) | `object_name` | string | The name of the object to be created |
| Data (required) | `data` | string | The data to be saved in the object |

| Output | ID | Type | Description |
| :--- | :--- | :--- | :--- |
| Authenticated URL (optional) | `authenticated_url` | string | Only users granted permission can access the object with this link |
| Gsutil URI (optional) | `gsutil_uri` | string | File path to this resource in Cloud Storage |
| Public Access (optional) | `public_access` | boolean | Whether the object is publicly accessible |
| Public URL (optional) | `public_url` | string | Anyone with this link can access the object on the public Internet |
| Upload Status | `status` | string | Status of the upload operation |

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Init

func Init(l *zap.Logger, u base.UsageHandler) *connector

func NewClient

func NewClient(jsonKey string) (*storage.Client, error)

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL