space

package
v1.6.0 Latest Latest
Warning

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

Go to latest
Published: Jun 20, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_proto_space_proto protoreflect.FileDescriptor

Functions

func NewSpaceEndpoints

func NewSpaceEndpoints() []*api.Endpoint

func RegisterSpaceHandler

func RegisterSpaceHandler(s server.Server, hdlr SpaceHandler, opts ...server.HandlerOption) error

Types

type CreateRequest

type CreateRequest struct {

	// The contents of the object. Either base64 encoded if sending request as application/json or raw bytes if using multipart/form-data format
	Object []byte `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
	// The name of the object. Use forward slash delimiter to implement a nested directory-like structure e.g. images/foo.jpg
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Who can see this object? "public" or "private", defaults to "private"
	Visibility string `protobuf:"bytes,3,opt,name=visibility,proto3" json:"visibility,omitempty"`
	// contains filtered or unexported fields
}

Create an object. Returns error if object with this name already exists. Max object size of 10MB, see Upload endpoint for larger objects. If you want to update an existing object use the `Update` endpoint

func (*CreateRequest) Descriptor deprecated

func (*CreateRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateRequest.ProtoReflect.Descriptor instead.

func (*CreateRequest) GetName

func (x *CreateRequest) GetName() string

func (*CreateRequest) GetObject

func (x *CreateRequest) GetObject() []byte

func (*CreateRequest) GetVisibility

func (x *CreateRequest) GetVisibility() string

func (*CreateRequest) ProtoMessage

func (*CreateRequest) ProtoMessage()

func (*CreateRequest) ProtoReflect

func (x *CreateRequest) ProtoReflect() protoreflect.Message

func (*CreateRequest) Reset

func (x *CreateRequest) Reset()

func (*CreateRequest) String

func (x *CreateRequest) String() string

type CreateResponse

type CreateResponse struct {

	// A public URL to access the object if visibility is "public"
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateResponse) Descriptor deprecated

func (*CreateResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateResponse.ProtoReflect.Descriptor instead.

func (*CreateResponse) GetUrl

func (x *CreateResponse) GetUrl() string

func (*CreateResponse) ProtoMessage

func (*CreateResponse) ProtoMessage()

func (*CreateResponse) ProtoReflect

func (x *CreateResponse) ProtoReflect() protoreflect.Message

func (*CreateResponse) Reset

func (x *CreateResponse) Reset()

func (*CreateResponse) String

func (x *CreateResponse) String() string

type DeleteRequest

type DeleteRequest struct {

	// Name of the object
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Delete an object from space

func (*DeleteRequest) Descriptor deprecated

func (*DeleteRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteRequest.ProtoReflect.Descriptor instead.

func (*DeleteRequest) GetName

func (x *DeleteRequest) GetName() string

func (*DeleteRequest) ProtoMessage

func (*DeleteRequest) ProtoMessage()

func (*DeleteRequest) ProtoReflect

func (x *DeleteRequest) ProtoReflect() protoreflect.Message

func (*DeleteRequest) Reset

func (x *DeleteRequest) Reset()

func (*DeleteRequest) String

func (x *DeleteRequest) String() string

type DeleteResponse

type DeleteResponse struct {
	// contains filtered or unexported fields
}

func (*DeleteResponse) Descriptor deprecated

func (*DeleteResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteResponse.ProtoReflect.Descriptor instead.

func (*DeleteResponse) ProtoMessage

func (*DeleteResponse) ProtoMessage()

func (*DeleteResponse) ProtoReflect

func (x *DeleteResponse) ProtoReflect() protoreflect.Message

func (*DeleteResponse) Reset

func (x *DeleteResponse) Reset()

func (*DeleteResponse) String

func (x *DeleteResponse) String() string

type DownloadRequest

type DownloadRequest struct {

	// name of object
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Download an object via a presigned url

func (*DownloadRequest) Descriptor deprecated

func (*DownloadRequest) Descriptor() ([]byte, []int)

Deprecated: Use DownloadRequest.ProtoReflect.Descriptor instead.

func (*DownloadRequest) GetName

func (x *DownloadRequest) GetName() string

func (*DownloadRequest) ProtoMessage

func (*DownloadRequest) ProtoMessage()

func (*DownloadRequest) ProtoReflect

func (x *DownloadRequest) ProtoReflect() protoreflect.Message

func (*DownloadRequest) Reset

func (x *DownloadRequest) Reset()

func (*DownloadRequest) String

func (x *DownloadRequest) String() string

type DownloadResponse

type DownloadResponse struct {

	// presigned url
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*DownloadResponse) Descriptor deprecated

func (*DownloadResponse) Descriptor() ([]byte, []int)

Deprecated: Use DownloadResponse.ProtoReflect.Descriptor instead.

func (*DownloadResponse) GetUrl

func (x *DownloadResponse) GetUrl() string

func (*DownloadResponse) ProtoMessage

func (*DownloadResponse) ProtoMessage()

func (*DownloadResponse) ProtoReflect

func (x *DownloadResponse) ProtoReflect() protoreflect.Message

func (*DownloadResponse) Reset

func (x *DownloadResponse) Reset()

func (*DownloadResponse) String

func (x *DownloadResponse) String() string

type HeadObject

type HeadObject struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// when was this last modified
	Modified string `protobuf:"bytes,2,opt,name=modified,proto3" json:"modified,omitempty"`
	// when was this created
	Created string `protobuf:"bytes,3,opt,name=created,proto3" json:"created,omitempty"`
	// is this public or private
	Visibility string `protobuf:"bytes,4,opt,name=visibility,proto3" json:"visibility,omitempty"`
	// URL to access the object if it is public
	Url string `protobuf:"bytes,5,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*HeadObject) Descriptor deprecated

func (*HeadObject) Descriptor() ([]byte, []int)

Deprecated: Use HeadObject.ProtoReflect.Descriptor instead.

func (*HeadObject) GetCreated

func (x *HeadObject) GetCreated() string

func (*HeadObject) GetModified

func (x *HeadObject) GetModified() string

func (*HeadObject) GetName

func (x *HeadObject) GetName() string

func (*HeadObject) GetUrl

func (x *HeadObject) GetUrl() string

func (*HeadObject) GetVisibility

func (x *HeadObject) GetVisibility() string

func (*HeadObject) ProtoMessage

func (*HeadObject) ProtoMessage()

func (*HeadObject) ProtoReflect

func (x *HeadObject) ProtoReflect() protoreflect.Message

func (*HeadObject) Reset

func (x *HeadObject) Reset()

func (*HeadObject) String

func (x *HeadObject) String() string

type HeadRequest

type HeadRequest struct {

	// name of the object
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Retrieve meta information about an object

func (*HeadRequest) Descriptor deprecated

func (*HeadRequest) Descriptor() ([]byte, []int)

Deprecated: Use HeadRequest.ProtoReflect.Descriptor instead.

func (*HeadRequest) GetName

func (x *HeadRequest) GetName() string

func (*HeadRequest) ProtoMessage

func (*HeadRequest) ProtoMessage()

func (*HeadRequest) ProtoReflect

func (x *HeadRequest) ProtoReflect() protoreflect.Message

func (*HeadRequest) Reset

func (x *HeadRequest) Reset()

func (*HeadRequest) String

func (x *HeadRequest) String() string

type HeadResponse

type HeadResponse struct {
	Object *HeadObject `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
	// contains filtered or unexported fields
}

func (*HeadResponse) Descriptor deprecated

func (*HeadResponse) Descriptor() ([]byte, []int)

Deprecated: Use HeadResponse.ProtoReflect.Descriptor instead.

func (*HeadResponse) GetObject

func (x *HeadResponse) GetObject() *HeadObject

func (*HeadResponse) ProtoMessage

func (*HeadResponse) ProtoMessage()

func (*HeadResponse) ProtoReflect

func (x *HeadResponse) ProtoReflect() protoreflect.Message

func (*HeadResponse) Reset

func (x *HeadResponse) Reset()

func (*HeadResponse) String

func (x *HeadResponse) String() string

type ListObject

type ListObject struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// when was this last modified
	Modified   string `protobuf:"bytes,2,opt,name=modified,proto3" json:"modified,omitempty"`
	Url        string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	Visibility string `protobuf:"bytes,4,opt,name=visibility,proto3" json:"visibility,omitempty"`
	Created    string `protobuf:"bytes,5,opt,name=created,proto3" json:"created,omitempty"`
	// contains filtered or unexported fields
}

func (*ListObject) Descriptor deprecated

func (*ListObject) Descriptor() ([]byte, []int)

Deprecated: Use ListObject.ProtoReflect.Descriptor instead.

func (*ListObject) GetCreated

func (x *ListObject) GetCreated() string

func (*ListObject) GetModified

func (x *ListObject) GetModified() string

func (*ListObject) GetName

func (x *ListObject) GetName() string

func (*ListObject) GetUrl

func (x *ListObject) GetUrl() string

func (*ListObject) GetVisibility

func (x *ListObject) GetVisibility() string

func (*ListObject) ProtoMessage

func (*ListObject) ProtoMessage()

func (*ListObject) ProtoReflect

func (x *ListObject) ProtoReflect() protoreflect.Message

func (*ListObject) Reset

func (x *ListObject) Reset()

func (*ListObject) String

func (x *ListObject) String() string

type ListRequest

type ListRequest struct {

	// optional prefix for the name e.g. to return all the objects in the images directory pass images/
	Prefix string `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// contains filtered or unexported fields
}

List the objects in space

func (*ListRequest) Descriptor deprecated

func (*ListRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.

func (*ListRequest) GetPrefix

func (x *ListRequest) GetPrefix() string

func (*ListRequest) ProtoMessage

func (*ListRequest) ProtoMessage()

func (*ListRequest) ProtoReflect

func (x *ListRequest) ProtoReflect() protoreflect.Message

func (*ListRequest) Reset

func (x *ListRequest) Reset()

func (*ListRequest) String

func (x *ListRequest) String() string

type ListResponse

type ListResponse struct {
	Objects []*ListObject `protobuf:"bytes,1,rep,name=objects,proto3" json:"objects,omitempty"`
	// contains filtered or unexported fields
}

func (*ListResponse) Descriptor deprecated

func (*ListResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListResponse.ProtoReflect.Descriptor instead.

func (*ListResponse) GetObjects

func (x *ListResponse) GetObjects() []*ListObject

func (*ListResponse) ProtoMessage

func (*ListResponse) ProtoMessage()

func (*ListResponse) ProtoReflect

func (x *ListResponse) ProtoReflect() protoreflect.Message

func (*ListResponse) Reset

func (x *ListResponse) Reset()

func (*ListResponse) String

func (x *ListResponse) String() string

type ReadRequest

type ReadRequest struct {

	// name of the object
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Read an object in space

func (*ReadRequest) Descriptor deprecated

func (*ReadRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadRequest.ProtoReflect.Descriptor instead.

func (*ReadRequest) GetName

func (x *ReadRequest) GetName() string

func (*ReadRequest) ProtoMessage

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) ProtoReflect

func (x *ReadRequest) ProtoReflect() protoreflect.Message

func (*ReadRequest) Reset

func (x *ReadRequest) Reset()

func (*ReadRequest) String

func (x *ReadRequest) String() string

type ReadResponse

type ReadResponse struct {

	// The object itself
	Object *SpaceObject `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
	// contains filtered or unexported fields
}

Returns the raw object

func (*ReadResponse) Descriptor deprecated

func (*ReadResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReadResponse.ProtoReflect.Descriptor instead.

func (*ReadResponse) GetObject

func (x *ReadResponse) GetObject() *SpaceObject

func (*ReadResponse) ProtoMessage

func (*ReadResponse) ProtoMessage()

func (*ReadResponse) ProtoReflect

func (x *ReadResponse) ProtoReflect() protoreflect.Message

func (*ReadResponse) Reset

func (x *ReadResponse) Reset()

func (*ReadResponse) String

func (x *ReadResponse) String() string

type SpaceObject added in v0.26.0

type SpaceObject struct {

	// name of object
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// when was this last modified
	Modified string `protobuf:"bytes,2,opt,name=modified,proto3" json:"modified,omitempty"`
	// when was this created
	Created string `protobuf:"bytes,3,opt,name=created,proto3" json:"created,omitempty"`
	// is this public or private
	Visibility string `protobuf:"bytes,4,opt,name=visibility,proto3" json:"visibility,omitempty"`
	// URL to access the object if it is public
	Url string `protobuf:"bytes,5,opt,name=url,proto3" json:"url,omitempty"`
	// the data within the object
	Data []byte `protobuf:"bytes,6,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SpaceObject) Descriptor deprecated added in v0.26.0

func (*SpaceObject) Descriptor() ([]byte, []int)

Deprecated: Use SpaceObject.ProtoReflect.Descriptor instead.

func (*SpaceObject) GetCreated added in v0.26.0

func (x *SpaceObject) GetCreated() string

func (*SpaceObject) GetData added in v0.26.0

func (x *SpaceObject) GetData() []byte

func (*SpaceObject) GetModified added in v0.26.0

func (x *SpaceObject) GetModified() string

func (*SpaceObject) GetName added in v0.26.0

func (x *SpaceObject) GetName() string

func (*SpaceObject) GetUrl added in v0.26.0

func (x *SpaceObject) GetUrl() string

func (*SpaceObject) GetVisibility added in v0.26.0

func (x *SpaceObject) GetVisibility() string

func (*SpaceObject) ProtoMessage added in v0.26.0

func (*SpaceObject) ProtoMessage()

func (*SpaceObject) ProtoReflect added in v0.26.0

func (x *SpaceObject) ProtoReflect() protoreflect.Message

func (*SpaceObject) Reset added in v0.26.0

func (x *SpaceObject) Reset()

func (*SpaceObject) String added in v0.26.0

func (x *SpaceObject) String() string

type SpaceService

func NewSpaceService

func NewSpaceService(name string, c client.Client) SpaceService

type UpdateRequest

type UpdateRequest struct {

	// The contents of the object. Either base64 encoded if sending request as application/json or raw bytes if using multipart/form-data format
	Object []byte `protobuf:"bytes,1,opt,name=object,proto3" json:"object,omitempty"`
	// The name of the object. Use forward slash delimiter to implement a nested directory-like structure e.g. images/foo.jpg
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Who can see this object? "public" or "private", defaults to "private"
	Visibility string `protobuf:"bytes,3,opt,name=visibility,proto3" json:"visibility,omitempty"`
	// contains filtered or unexported fields
}

Update an object. If an object with this name does not exist, creates a new one.

func (*UpdateRequest) Descriptor deprecated

func (*UpdateRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateRequest.ProtoReflect.Descriptor instead.

func (*UpdateRequest) GetName

func (x *UpdateRequest) GetName() string

func (*UpdateRequest) GetObject

func (x *UpdateRequest) GetObject() []byte

func (*UpdateRequest) GetVisibility

func (x *UpdateRequest) GetVisibility() string

func (*UpdateRequest) ProtoMessage

func (*UpdateRequest) ProtoMessage()

func (*UpdateRequest) ProtoReflect

func (x *UpdateRequest) ProtoReflect() protoreflect.Message

func (*UpdateRequest) Reset

func (x *UpdateRequest) Reset()

func (*UpdateRequest) String

func (x *UpdateRequest) String() string

type UpdateResponse

type UpdateResponse struct {

	// A public URL to access the object if visibility is "public"
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateResponse) Descriptor deprecated

func (*UpdateResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateResponse.ProtoReflect.Descriptor instead.

func (*UpdateResponse) GetUrl

func (x *UpdateResponse) GetUrl() string

func (*UpdateResponse) ProtoMessage

func (*UpdateResponse) ProtoMessage()

func (*UpdateResponse) ProtoReflect

func (x *UpdateResponse) ProtoReflect() protoreflect.Message

func (*UpdateResponse) Reset

func (x *UpdateResponse) Reset()

func (*UpdateResponse) String

func (x *UpdateResponse) String() string

type UploadRequest

type UploadRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// is this object public or private
	Visibility string `protobuf:"bytes,2,opt,name=visibility,proto3" json:"visibility,omitempty"`
	// contains filtered or unexported fields
}

Upload a large object (> 10MB). Returns a time limited presigned URL to be used for uploading the object

func (*UploadRequest) Descriptor deprecated

func (*UploadRequest) Descriptor() ([]byte, []int)

Deprecated: Use UploadRequest.ProtoReflect.Descriptor instead.

func (*UploadRequest) GetName

func (x *UploadRequest) GetName() string

func (*UploadRequest) GetVisibility

func (x *UploadRequest) GetVisibility() string

func (*UploadRequest) ProtoMessage

func (*UploadRequest) ProtoMessage()

func (*UploadRequest) ProtoReflect

func (x *UploadRequest) ProtoReflect() protoreflect.Message

func (*UploadRequest) Reset

func (x *UploadRequest) Reset()

func (*UploadRequest) String

func (x *UploadRequest) String() string

type UploadResponse

type UploadResponse struct {

	// a presigned url to be used for uploading. To use the URL call it with HTTP PUT and pass the object as the request data
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*UploadResponse) Descriptor deprecated

func (*UploadResponse) Descriptor() ([]byte, []int)

Deprecated: Use UploadResponse.ProtoReflect.Descriptor instead.

func (*UploadResponse) GetUrl

func (x *UploadResponse) GetUrl() string

func (*UploadResponse) ProtoMessage

func (*UploadResponse) ProtoMessage()

func (*UploadResponse) ProtoReflect

func (x *UploadResponse) ProtoReflect() protoreflect.Message

func (*UploadResponse) Reset

func (x *UploadResponse) Reset()

func (*UploadResponse) String

func (x *UploadResponse) String() string

Jump to

Keyboard shortcuts

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