client

Documentation

Index

• Constants
• func DownloadStorageObject(ctx context.Context, projectRef, remotePath, localPath string, fsys afero.Fs) error
• func UploadStorageObject(ctx context.Context, projectRef, remotePath, localPath string, fsys afero.Fs) error
• type BucketResponse
  • func ListStorageBuckets(ctx context.Context, projectRef string) ([]BucketResponse, error)
• type CopyObjectRequest
• type CopyObjectResponse
  • func CopyStorageObject(ctx context.Context, projectRef, bucketId, srcPath, dstPath string) (*CopyObjectResponse, error)
• type CreateBucketRequest
• type CreateBucketResponse
  • func CreateStorageBucket(ctx context.Context, projectRef, bucketName string) (*CreateBucketResponse, error)
• type DeleteBucketResponse
  • func DeleteStorageBucket(ctx context.Context, projectRef, bucketId string) (*DeleteBucketResponse, error)
• type DeleteObjectsRequest
• type DeleteObjectsResponse
  • func DeleteStorageObjects(ctx context.Context, projectRef, bucket string, prefixes []string) ([]DeleteObjectsResponse, error)
• type ListObjectsQuery
• type MoveObjectRequest
• type MoveObjectResponse
  • func MoveStorageObject(ctx context.Context, projectRef, bucketId, srcPath, dstPath string) (*MoveObjectResponse, error)
• type ObjectMetadata
• type ObjectResponse
  • func ListStorageObjects(ctx context.Context, projectRef, bucket, prefix string, page int) ([]ObjectResponse, error)

Constants

const PAGE_LIMIT = 100

Functions

func DownloadStorageObject

func DownloadStorageObject(ctx context.Context, projectRef, remotePath, localPath string, fsys afero.Fs) error

func UploadStorageObject

func UploadStorageObject(ctx context.Context, projectRef, remotePath, localPath string, fsys afero.Fs) error

Types

type BucketResponse

type BucketResponse struct {
	Id               string   `json:"id"`                 // "test"
	Name             string   `json:"name"`               // "test"
	Owner            string   `json:"owner"`              // ""
	Public           bool     `json:"public"`             // true
	FileSizeLimit    *int     `json:"file_size_limit"`    // null
	AllowedMimeTypes []string `json:"allowed_mime_types"` // null
	CreatedAt        string   `json:"created_at"`         // "2023-10-13T17:48:58.491Z"
	UpdatedAt        string   `json:"updated_at"`         // "2023-10-13T17:48:58.491Z"
}

func ListStorageBuckets

func ListStorageBuckets(ctx context.Context, projectRef string) ([]BucketResponse, error)

type CopyObjectRequest

type CopyObjectRequest = MoveObjectRequest

type CopyObjectResponse

type CopyObjectResponse struct {
	Key string `json:"key"`
}

func CopyStorageObject

func CopyStorageObject(ctx context.Context, projectRef, bucketId, srcPath, dstPath string) (*CopyObjectResponse, error)

type CreateBucketRequest

type CreateBucketRequest struct {
	Name             string   `json:"name"`                         // "string",
	Id               string   `json:"id,omitempty"`                 // "string",
	Public           bool     `json:"public,omitempty"`             // false,
	FileSizeLimit    int      `json:"file_size_limit,omitempty"`    // 0,
	AllowedMimeTypes []string `json:"allowed_mime_types,omitempty"` // ["string"]
}

type CreateBucketResponse

type CreateBucketResponse struct {
	Name string `json:"name"`
}

func CreateStorageBucket

func CreateStorageBucket(ctx context.Context, projectRef, bucketName string) (*CreateBucketResponse, error)

type DeleteBucketResponse

type DeleteBucketResponse struct {
	Message string `json:"message"`
}

func DeleteStorageBucket

func DeleteStorageBucket(ctx context.Context, projectRef, bucketId string) (*DeleteBucketResponse, error)

type DeleteObjectsRequest

type DeleteObjectsRequest struct {
	Prefixes []string `json:"prefixes"`
}

type DeleteObjectsResponse

type DeleteObjectsResponse struct {
	BucketId       string         `json:"bucket_id"`        // "private"
	Owner          string         `json:"owner"`            // ""
	OwnerId        string         `json:"owner_id"`         // ""
	Version        string         `json:"version"`          // "cf5c5c53-ee73-4806-84e3-7d92c954b436"
	Name           string         `json:"name"`             // "abstract.pdf"
	Id             string         `json:"id"`               // "9b7f9f48-17a6-4ca8-b14a-39b0205a63e9"
	UpdatedAt      string         `json:"updated_at"`       // "2023-10-13T18:08:22.068Z"
	CreatedAt      string         `json:"created_at"`       // "2023-10-13T18:08:22.068Z"
	LastAccessedAt string         `json:"last_accessed_at"` // "2023-10-13T18:08:22.068Z"
	Metadata       ObjectMetadata `json:"metadata"`         // null
}

func DeleteStorageObjects

func DeleteStorageObjects(ctx context.Context, projectRef, bucket string, prefixes []string) ([]DeleteObjectsResponse, error)

type ListObjectsQuery

type ListObjectsQuery struct {
	Prefix string `json:"prefix"`
	Search string `json:"search,omitempty"`
	Limit  int    `json:"limit,omitempty"`
	Offset int    `json:"offset,omitempty"`
}

type MoveObjectRequest

type MoveObjectRequest struct {
	BucketId       string `json:"bucketId"`
	SourceKey      string `json:"sourceKey"`
	DestinationKey string `json:"destinationKey"`
}

type MoveObjectResponse

type MoveObjectResponse = DeleteBucketResponse

func MoveStorageObject

func MoveStorageObject(ctx context.Context, projectRef, bucketId, srcPath, dstPath string) (*MoveObjectResponse, error)

type ObjectMetadata

type ObjectMetadata struct {
	ETag           string `json:"eTag"`           // "\"887ea9be3c68e6f2fca7fd2d7c77d8fe\""
	Size           int    `json:"size"`           // 82702
	Mimetype       string `json:"mimetype"`       // "application/pdf"
	CacheControl   string `json:"cacheControl"`   // "max-age=3600"
	LastModified   string `json:"lastModified"`   // "2023-10-13T18:08:22.000Z"
	ContentLength  int    `json:"contentLength"`  // 82702
	HttpStatusCode int    `json:"httpStatusCode"` // 200
}

type ObjectResponse

type ObjectResponse struct {
	Name           string          `json:"name"`             // "abstract.pdf"
	Id             *string         `json:"id"`               // "9b7f9f48-17a6-4ca8-b14a-39b0205a63e9"
	UpdatedAt      *string         `json:"updated_at"`       // "2023-10-13T18:08:22.068Z"
	CreatedAt      *string         `json:"created_at"`       // "2023-10-13T18:08:22.068Z"
	LastAccessedAt *string         `json:"last_accessed_at"` // "2023-10-13T18:08:22.068Z"
	Metadata       *ObjectMetadata `json:"metadata"`         // null
}

func ListStorageObjects

func ListStorageObjects(ctx context.Context, projectRef, bucket, prefix string, page int) ([]ObjectResponse, error)