Documentation
¶
Index ¶
- type AbortMultipartUploadRequest
- type CommonPrefixes
- type CompleteMultipartUploadBody
- type CompleteMultipartUploadRequest
- type CompleteMultipartUploadResponse
- type CompleteMultipartUploadResult
- type CompletePart
- type InitiateMultipartUploadRequest
- type InitiateMultipartUploadResult
- type ListMultipartUploadsRequest
- type ListMultipartUploadsResult
- type ListObjectPartsRequest
- type ListObjectPartsResult
- type ListObjectPartsResultPart
- type ListUpload
- type MultipartClient
- func (mpuc *MultipartClient) AbortMultipartUpload(ctx context.Context, req *AbortMultipartUploadRequest) error
- func (mpuc *MultipartClient) CompleteMultipartUpload(ctx context.Context, req *CompleteMultipartUploadRequest) (*CompleteMultipartUploadResult, error)
- func (mpuc *MultipartClient) InitiateMultipartUpload(ctx context.Context, req *InitiateMultipartUploadRequest) (*InitiateMultipartUploadResult, error)
- func (mpuc *MultipartClient) ListMultipartUploads(ctx context.Context, req *ListMultipartUploadsRequest) (*ListMultipartUploadsResult, error)
- func (mpuc *MultipartClient) ListObjectParts(ctx context.Context, req *ListObjectPartsRequest) (*ListObjectPartsResult, error)
- func (mpuc *MultipartClient) UploadObjectPart(ctx context.Context, req *UploadObjectPartRequest) (*UploadObjectPartResult, error)
- type UploadObjectPartRequest
- type UploadObjectPartResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AbortMultipartUploadRequest ¶ added in v0.1.0
type CommonPrefixes ¶ added in v0.8.0
CommonPrefixes represents grouped object name prefixes
type CompleteMultipartUploadBody ¶ added in v0.1.0
type CompleteMultipartUploadBody struct {
XMLName xml.Name `xml:"CompleteMultipartUpload"`
Parts []CompletePart
}
type CompleteMultipartUploadRequest ¶ added in v0.1.0
type CompleteMultipartUploadRequest struct {
Bucket string
Key string
UploadID string
Body CompleteMultipartUploadBody
}
TODO: Add header support.
type CompleteMultipartUploadResponse ¶ added in v0.1.0
type CompleteMultipartUploadResponse struct {
Result CompleteMultipartUploadResult
Hash string
}
type CompleteMultipartUploadResult ¶ added in v0.1.0
type CompletePart ¶ added in v0.1.0
type InitiateMultipartUploadRequest ¶
type InitiateMultipartUploadRequest struct {
Bucket string
Key string
// Custom metadata
CustomMetadata map[string]string
}
Initiate Multipart Upload Request https://cloud.google.com/storage/docs/xml-api/post-object-multipart
type InitiateMultipartUploadResult ¶
type InitiateMultipartUploadResult struct {
XMLName xml.Name `xml:"InitiateMultipartUploadResult"`
Bucket string `xml:"Bucket"`
Key string `xml:"Key"`
UploadID string `xml:"UploadId"`
}
Initiate Multipart Upload Response https://cloud.google.com/storage/docs/xml-api/post-object-multipart
type ListMultipartUploadsRequest ¶ added in v0.1.0
type ListMultipartUploadsResult ¶ added in v0.1.0
type ListMultipartUploadsResult struct {
XMLName xml.Name `xml:"ListMultipartUploadsResult"`
Bucket string `xml:"Bucket"`
KeyMarker string `xml:"KeyMarker"`
UploadIdMarker string `xml:"UploadIdMarker"`
NextKeyMarker string `xml:"NextKeyMarker"`
NextUploadIdMarker string `xml:"NextUploadIdMarker"`
Delimiter string `xml:"Delimiter"`
Prefix string `xml:"Prefix"`
MaxUploads int `xml:"MaxUploads"`
IsTruncated bool `xml:"IsTruncated"`
Uploads []ListUpload `xml:"Upload"`
CommonPrefixes []CommonPrefixes `xml:"CommonPrefixes"`
}
type ListObjectPartsRequest ¶ added in v0.1.0
type ListObjectPartsResult ¶ added in v0.1.0
type ListObjectPartsResult struct {
XMLName xml.Name `xml:"ListPartsResult"`
Bucket string `xml:"Bucket"`
Key string `xml:"Key"`
UploadID string `xml:"UploadId"`
StorageClass string `xml:"StorageClass"`
PartNumberMarker int `xml:"PartNumberMarker"`
NextPartNumberMarker int `xml:"NextPartNumberMarker"`
MaxParts int `xml:"MaxParts"`
IsTruncated bool `xml:"IsTruncated"`
Parts []ListObjectPartsResultPart `xml:"Part"`
}
type ListObjectPartsResultPart ¶ added in v0.5.0
type ListUpload ¶ added in v0.1.0
type ListUpload struct {
XMLName xml.Name `xml:"Upload"`
Key string `xml:"Key"`
UploadID string `xml:"UploadId"`
StorageClass string `xml:"StorageClass"`
Initiated time.Time `xml:"Initiated"`
}
TODO: Support headers
type MultipartClient ¶ added in v0.1.0
type MultipartClient struct {
// contains filtered or unexported fields
}
Client for using GCS XML Multipart API: https://cloud.google.com/storage/docs/multipart-uploads
func New ¶
func New(hc *http.Client) *MultipartClient
Create a multipart client that uses the specified http.Client.
func NewWithBaseURL ¶ added in v0.8.0
func NewWithBaseURL(hc *http.Client, baseURL string) *MultipartClient
NewWithBaseURL creates a multipart client with a custom base URL (useful for testing).
func (*MultipartClient) AbortMultipartUpload ¶ added in v0.1.0
func (mpuc *MultipartClient) AbortMultipartUpload(ctx context.Context, req *AbortMultipartUploadRequest) error
Abort multipart upload. https://cloud.google.com/storage/docs/xml-api/delete-multipart
func (*MultipartClient) CompleteMultipartUpload ¶ added in v0.1.0
func (mpuc *MultipartClient) CompleteMultipartUpload(ctx context.Context, req *CompleteMultipartUploadRequest) (*CompleteMultipartUploadResult, error)
Complete a multipart upload. https://cloud.google.com/storage/docs/xml-api/post-object-complete
func (*MultipartClient) InitiateMultipartUpload ¶ added in v0.1.0
func (mpuc *MultipartClient) InitiateMultipartUpload(ctx context.Context, req *InitiateMultipartUploadRequest) (*InitiateMultipartUploadResult, error)
InitiateMultipartUpload calls the XML Multipart API to Inititate a Multipart Upload.
func (*MultipartClient) ListMultipartUploads ¶ added in v0.1.0
func (mpuc *MultipartClient) ListMultipartUploads(ctx context.Context, req *ListMultipartUploadsRequest) (*ListMultipartUploadsResult, error)
List Multipart Uploads https://cloud.google.com/storage/docs/xml-api/get-bucket-uploads
func (*MultipartClient) ListObjectParts ¶ added in v0.1.0
func (mpuc *MultipartClient) ListObjectParts(ctx context.Context, req *ListObjectPartsRequest) (*ListObjectPartsResult, error)
List Object Parts https://cloud.google.com/storage/docs/xml-api/get-object-multipart
func (*MultipartClient) UploadObjectPart ¶ added in v0.1.0
func (mpuc *MultipartClient) UploadObjectPart(ctx context.Context, req *UploadObjectPartRequest) (*UploadObjectPartResult, error)
Upload an object part request. https://cloud.google.com/storage/docs/xml-api/put-object-multipart