minio/pkg/api/api_definitions.go

/*
 * Minimalist Object Storage, (C) 2014 Minio, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package api

import (
	"encoding/xml"
)

// Limit number of objects in a given response
const (
	maxObjectList = 1000
)

// ObjectListResponse format
type ObjectListResponse struct {
	XMLName        xml.Name `xml:"ListBucketResult" json:"-"`
	Name           string
	Prefix         string
	Marker         string
	MaxKeys        int
	Delimiter      string
	IsTruncated    bool
	Contents       []*Item
	CommonPrefixes []*Prefix
}

// BucketListResponse - bucket list response format
type BucketListResponse struct {
	XMLName xml.Name `xml:"ListAllMyBucketsResult" json:"-"`
	Owner   Owner
	Buckets struct {
		Bucket []*Bucket
	} // Buckets are nested
}

// Prefix - common prefix
type Prefix struct {
	Prefix string
}

// Bucket - bucket item
type Bucket struct {
	Name         string
	CreationDate string
}

// Item - object item
type Item struct {
	Key          string
	LastModified string
	ETag         string
	Size         int64
	StorageClass string
	Owner        Owner
}

// Owner - bucket owner/principal
type Owner struct {
	ID          string
	DisplayName string
}

// List of not implemented bucket queries
var unimplementedBucketResourceNames = map[string]bool{
	"acl":            true,
	"policy":         true,
	"cors":           true,
	"lifecycle":      true,
	"location":       true,
	"logging":        true,
	"notification":   true,
	"tagging":        true,
	"versions":       true,
	"requestPayment": true,
	"versioning":     true,
	"website":        true,
	"uploads":        true,
}

// List of not implemented object queries
var unimplementedObjectResourceNames = map[string]bool{
	"uploadId": true,
	"acl":      true,
	"torrent":  true,
	"uploads":  true,
}