Help us shape the future of Go! Take the 2026 Go Developer Survey

file

package
v1.0.76 Latest Latest
Warning

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

Go to latest
Published: Aug 6, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PurposeUserData = "user_data"

	StatusActive = "active"

	StatusProcessing = "processing"

	StatusFailed = "failed"

	ObjectTypeList = "list"

	ObjectTypeFile = "file"

	OrderAsc = "asc"

	OrderDesc = "desc"
)

Variables

View Source
var FileMeta_Bytes_DEFAULT int64
View Source
var FileMeta_MimeType_DEFAULT string
View Source
var ListFilesRequest_After_DEFAULT string
View Source
var ListFilesRequest_Limit_DEFAULT int64
View Source
var UploadFileRequest_ExpireAt_DEFAULT int64
View Source
var Video_Fps_DEFAULT float64

Functions

This section is empty.

Types

type DeleteFileRequest

type DeleteFileRequest struct {
	ID string `thrift:"ID,1,required" json:"ID,required" path:"id,required"`
}

func NewDeleteFileRequest

func NewDeleteFileRequest() *DeleteFileRequest

func (*DeleteFileRequest) GetID

func (p *DeleteFileRequest) GetID() (v string)

func (*DeleteFileRequest) InitDefault

func (p *DeleteFileRequest) InitDefault()

func (*DeleteFileRequest) String

func (p *DeleteFileRequest) String() string

type DeleteFileResponse

type DeleteFileResponse struct {
	ObjectType ObjectType `thrift:"ObjectType,1,required" form:"object,required" json:"object,required"`
	ID         string     `thrift:"ID,2,required" form:"id,required" json:"id,required"`
	Deleted    bool       `thrift:"Deleted,3,required" form:"deleted,required" json:"deleted,required"`
	model.HttpHeader
}

func NewDeleteFileResponse

func NewDeleteFileResponse() *DeleteFileResponse

func (*DeleteFileResponse) GetDeleted

func (p *DeleteFileResponse) GetDeleted() (v bool)

func (*DeleteFileResponse) GetID

func (p *DeleteFileResponse) GetID() (v string)

func (*DeleteFileResponse) GetObjectType

func (p *DeleteFileResponse) GetObjectType() (v ObjectType)

func (*DeleteFileResponse) InitDefault

func (p *DeleteFileResponse) InitDefault()

func (*DeleteFileResponse) String

func (p *DeleteFileResponse) String() string

type Error

type Error struct {
	Code    string `thrift:"Code,1,required" form:"code,required" json:"code,required"`
	Message string `thrift:"Message,2,required" form:"message,required" json:"message,required"`
	Param   string `thrift:"Param,3,required" form:"param,required" json:"param,required"`
	Type    string `thrift:"Type,4,required" form:"type,required" json:"type,required"`
}
var FileMeta_Error_DEFAULT *Error

func NewError

func NewError() *Error

func (*Error) GetCode

func (p *Error) GetCode() (v string)

func (*Error) GetMessage

func (p *Error) GetMessage() (v string)

func (*Error) GetParam

func (p *Error) GetParam() (v string)

func (*Error) GetType

func (p *Error) GetType() (v string)

func (*Error) InitDefault

func (p *Error) InitDefault()

func (*Error) String

func (p *Error) String() string

type FileMeta

type FileMeta struct {
	ObjectType ObjectType `thrift:"ObjectType,1,required" form:"object,required" json:"object,required"`
	ID         string     `thrift:"ID,2,required" form:"id,required" json:"id,required"`
	Purpose    Purpose    `thrift:"Purpose,3,required" form:"purpose,required" json:"purpose,required"`
	FileName   string     `thrift:"FileName,4,required" form:"filename,required" json:"filename,required"`
	Bytes      *int64     `thrift:"Bytes,5,optional" form:"bytes" json:"bytes,omitempty"`
	MimeType   *string    `thrift:"MimeType,6,optional" form:"mime_type" json:"mime_type,omitempty"`
	/*
	   time stamp for file
	*/
	CreatedAt int64  `thrift:"CreatedAt,7,required" form:"created_at,required" json:"created_at,required"`
	ExpireAt  int64  `thrift:"ExpireAt,8,required" form:"expire_at,required" json:"expire_at,required"`
	Status    Status `thrift:"Status,9,required" form:"status,required" json:"status,required"`

	// only set when status = failed
	Error             *Error             `thrift:"Error,11,optional" form:"error" json:"error,omitempty"`
	PreprocessConfigs *PreprocessConfigs `thrift:"PreprocessConfigs,12,optional" form:"preprocess_configs" json:"preprocess_configs,omitempty"`
	model.HttpHeader
}

func NewFileMeta

func NewFileMeta() *FileMeta

func (*FileMeta) GetBytes

func (p *FileMeta) GetBytes() (v int64)

func (*FileMeta) GetCreatedAt

func (p *FileMeta) GetCreatedAt() (v int64)

func (*FileMeta) GetError

func (p *FileMeta) GetError() (v *Error)

func (*FileMeta) GetExpireAt

func (p *FileMeta) GetExpireAt() (v int64)

func (*FileMeta) GetFileName

func (p *FileMeta) GetFileName() (v string)

func (*FileMeta) GetID

func (p *FileMeta) GetID() (v string)

func (*FileMeta) GetMimeType

func (p *FileMeta) GetMimeType() (v string)

func (*FileMeta) GetObjectType

func (p *FileMeta) GetObjectType() (v ObjectType)

func (*FileMeta) GetPreprocessConfigs

func (p *FileMeta) GetPreprocessConfigs() (v *PreprocessConfigs)

func (*FileMeta) GetPurpose

func (p *FileMeta) GetPurpose() (v Purpose)

func (*FileMeta) GetStatus

func (p *FileMeta) GetStatus() (v Status)

func (*FileMeta) InitDefault

func (p *FileMeta) InitDefault()

func (*FileMeta) IsSetBytes

func (p *FileMeta) IsSetBytes() bool

func (*FileMeta) IsSetError

func (p *FileMeta) IsSetError() bool

func (*FileMeta) IsSetMimeType

func (p *FileMeta) IsSetMimeType() bool

func (*FileMeta) IsSetPreprocessConfigs

func (p *FileMeta) IsSetPreprocessConfigs() bool

func (*FileMeta) String

func (p *FileMeta) String() string

type ListFilesRequest

type ListFilesRequest struct {
	Purpose *Purpose `thrift:"Purpose,1,optional" json:"Purpose,omitempty" query:"purpose"`
	After   *string  `thrift:"After,2,optional" json:"After,omitempty" query:"after"`
	Limit   *int64   `thrift:"Limit,3,optional" json:"Limit,omitempty" query:"limit"`
	Order   *Order   `thrift:"Order,4,optional" json:"Order,omitempty" query:"order"`
}

func NewListFilesRequest

func NewListFilesRequest() *ListFilesRequest

func (*ListFilesRequest) GetAfter

func (p *ListFilesRequest) GetAfter() (v string)

func (*ListFilesRequest) GetLimit

func (p *ListFilesRequest) GetLimit() (v int64)

func (*ListFilesRequest) GetOrder

func (p *ListFilesRequest) GetOrder() (v Order)

func (*ListFilesRequest) GetPurpose

func (p *ListFilesRequest) GetPurpose() (v Purpose)

func (*ListFilesRequest) InitDefault

func (p *ListFilesRequest) InitDefault()

func (*ListFilesRequest) IsSetAfter

func (p *ListFilesRequest) IsSetAfter() bool

func (*ListFilesRequest) IsSetLimit

func (p *ListFilesRequest) IsSetLimit() bool

func (*ListFilesRequest) IsSetOrder

func (p *ListFilesRequest) IsSetOrder() bool

func (*ListFilesRequest) IsSetPurpose

func (p *ListFilesRequest) IsSetPurpose() bool

func (*ListFilesRequest) String

func (p *ListFilesRequest) String() string

func (*ListFilesRequest) URLQuery

func (p *ListFilesRequest) URLQuery() (v url.Values, err error)

type ListFilesResponse

type ListFilesResponse struct {
	ObjectType ObjectType  `thrift:"ObjectType,1,required" form:"object,required" json:"object,required"`
	Data       []*FileMeta `thrift:"data,2,required" form:"data,required" json:"data,required"`
	FirstID    string      `thrift:"FirstID,3,required" form:"first_id,required" json:"first_id,required"`
	LastID     string      `thrift:"LastID,4,required" form:"last_id,required" json:"last_id,required"`
	HasMore    bool        `thrift:"HasMore,5,required" form:"has_more,required" json:"has_more,required"`
	model.HttpHeader
}

func NewListFilesResponse

func NewListFilesResponse() *ListFilesResponse

func (*ListFilesResponse) GetData

func (p *ListFilesResponse) GetData() (v []*FileMeta)

func (*ListFilesResponse) GetFirstID

func (p *ListFilesResponse) GetFirstID() (v string)

func (*ListFilesResponse) GetHasMore

func (p *ListFilesResponse) GetHasMore() (v bool)

func (*ListFilesResponse) GetLastID

func (p *ListFilesResponse) GetLastID() (v string)

func (*ListFilesResponse) GetObjectType

func (p *ListFilesResponse) GetObjectType() (v ObjectType)

func (*ListFilesResponse) InitDefault

func (p *ListFilesResponse) InitDefault()

func (*ListFilesResponse) String

func (p *ListFilesResponse) String() string

type ObjectType

type ObjectType string

type Order

type Order string
var ListFilesRequest_Order_DEFAULT Order

type PreprocessConfigs

type PreprocessConfigs struct {
	Video *Video `thrift:"video,1,optional" form:"video" json:"video,omitempty"`
}
var FileMeta_PreprocessConfigs_DEFAULT *PreprocessConfigs
var UploadFileRequest_PreprocessConfigs_DEFAULT *PreprocessConfigs

func NewPreprocessConfigs

func NewPreprocessConfigs() *PreprocessConfigs

func (*PreprocessConfigs) GetVideo

func (p *PreprocessConfigs) GetVideo() (v *Video)

func (*PreprocessConfigs) InitDefault

func (p *PreprocessConfigs) InitDefault()

func (*PreprocessConfigs) IsSetVideo

func (p *PreprocessConfigs) IsSetVideo() bool

func (*PreprocessConfigs) String

func (p *PreprocessConfigs) String() string

type Purpose

type Purpose string
var ListFilesRequest_Purpose_DEFAULT Purpose

type RetrieveFileRequest

type RetrieveFileRequest struct {
	ID string `thrift:"ID,1,required" json:"ID,required" path:"id,required"`
}

func NewRetrieveFileRequest

func NewRetrieveFileRequest() *RetrieveFileRequest

func (*RetrieveFileRequest) GetID

func (p *RetrieveFileRequest) GetID() (v string)

func (*RetrieveFileRequest) InitDefault

func (p *RetrieveFileRequest) InitDefault()

func (*RetrieveFileRequest) String

func (p *RetrieveFileRequest) String() string

type Status

type Status string

type UploadFileRequest

type UploadFileRequest struct {
	// The File object (not file name) to be uploaded.
	File io.Reader `json:"file,required" format:"binary"`
	// The intended purpose of the uploaded file.
	Purpose Purpose `form:"purpose,required"`
	// The preprocessing configurations for the uploaded file.
	PreprocessConfigs *PreprocessConfigs `form:"preprocess_configs,omitempty"`
	// The expiration timestamp for a file.
	ExpireAt *int64 `form:"expire_at,omitempty"`
}

UploadFileRequest upload file request, it's a form request with file field

func NewUploadFileRequest

func NewUploadFileRequest() *UploadFileRequest

func (*UploadFileRequest) GetExpireAt

func (p *UploadFileRequest) GetExpireAt() (v int64)

func (*UploadFileRequest) GetPreprocessConfigs

func (p *UploadFileRequest) GetPreprocessConfigs() (v *PreprocessConfigs)

func (*UploadFileRequest) GetPurpose

func (p *UploadFileRequest) GetPurpose() (v Purpose)

func (*UploadFileRequest) InitDefault

func (p *UploadFileRequest) InitDefault()

func (*UploadFileRequest) IsSetExpireAt

func (p *UploadFileRequest) IsSetExpireAt() bool

func (*UploadFileRequest) IsSetPreprocessConfigs

func (p *UploadFileRequest) IsSetPreprocessConfigs() bool

func (*UploadFileRequest) MarshalMultipart

func (p *UploadFileRequest) MarshalMultipart() (data []byte, contentType string, err error)

func (*UploadFileRequest) String

func (p *UploadFileRequest) String() string

type Video

type Video struct {
	Fps *float64 `thrift:"fps,1,optional" form:"fps" json:"fps,omitempty"`
}
var PreprocessConfigs_Video_DEFAULT *Video

func NewVideo

func NewVideo() *Video

func (*Video) GetFps

func (p *Video) GetFps() (v float64)

func (*Video) InitDefault

func (p *Video) InitDefault()

func (*Video) IsSetFps

func (p *Video) IsSetFps() bool

func (*Video) String

func (p *Video) String() string

Jump to

Keyboard shortcuts

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