Renaming GetObject to GetPartialObject

README.md

@@ -38,7 +38,7 @@ func main() {
 ## Documentation
 
 * [PutObject(string, string, int64, io.Reader) error](examples/s3/putobject.go)
-* [GetObject(string, string, int64, int64](examples/s3/getobject.go)
+* [GetObject(string, string](examples/s3/getobject.go)
 * [ListObjects(string, string, bool) <-chan](examples/s3/listobjects.go)
 * [ListBuckets() <-chan](examples/s3/listbuckets.go)
 

api.go

@@ -54,7 +54,7 @@ type BucketAPI interface {
 
 // ObjectAPI - object specific Read/Write/Stat interface
 type ObjectAPI interface {
-	GetObject(bucket, object string, offset, length int64) (io.ReadCloser, ObjectStat, error)
+	GetPartialObject(bucket, object string, offset, length int64) (io.ReadCloser, ObjectStat, error)
 	PutObject(bucket, object string, size int64, data io.Reader) error
 	StatObject(bucket, object string) (ObjectStat, error)
 	RemoveObject(bucket, object string) error
@@ -181,13 +181,14 @@ func New(config Config) (API, error) {
 
 /// Object operations
 
-// GetObject retrieve object
+// GetPartialObject retrieve object
 //
-// Additionally it also takes range arguments to download the specified range bytes of an object.
+// Takes range arguments to download the specified range bytes of an object.
+// Setting offset and length = 0 will download the full object.
 // For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
-func (a api) GetObject(bucket, object string, offset, length int64) (io.ReadCloser, ObjectStat, error) {
+func (a api) GetPartialObject(bucket, object string, offset, length int64) (io.ReadCloser, ObjectStat, error) {
 	// get the the object
-	return a.getObject(bucket, object, offset, length)
+	return a.getPartialObject(bucket, object, offset, length)
 }
 
 // completedParts is a wrapper to make parts sortable by their part number

api_test.go

@@ -166,7 +166,7 @@ func TestObjectOperations(t *testing.T) {
 		t.Fatalf("Error")
 	}
 
-	reader, metadata, err := a.GetObject("bucket", "object", 0, 0)
+	reader, metadata, err := a.GetPartialObject("bucket", "object", 0, 0)
 	if err != nil {
 		t.Fatalf("Error")
 	}

examples/play/getobject.go

@@ -36,7 +36,7 @@ func main() {
 	if err != nil {
 		log.Fatalln(err)
 	}
-	reader, stat, err := playClient.GetObject("mybucket", "myobject", 0, 0)
+	reader, stat, err := playClient.GetPartialObject("mybucket", "myobject", 0, 0)
 	if err != nil {
 		log.Fatalln(err)
 	}

examples/s3/getobject.go

@@ -36,7 +36,7 @@ func main() {
 	if err != nil {
 		log.Fatalln(err)
 	}
-	reader, stat, err := s3Client.GetObject("mybucket", "myobject", 0, 0)
+	reader, stat, err := s3Client.GetPartialObject("mybucket", "myobject", 0, 0)
 	if err != nil {
 		log.Fatalln(err)
 	}

lowlevelapi.go

@@ -497,11 +497,12 @@ func (a lowLevelAPI) getObjectRequest(bucket, object string, offset, length int6
 	return r, nil
 }
 
-// getObject - retrieve object from Object Storage
+// getPartialObject - retrieve object from Object Storage
 //
 // Additionally it also takes range arguments to download the specified range bytes of an object.
+// Setting offset and length = 0 will download the full object.
 // For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
-func (a lowLevelAPI) getObject(bucket, object string, offset, length int64) (io.ReadCloser, ObjectStat, error) {
+func (a lowLevelAPI) getPartialObject(bucket, object string, offset, length int64) (io.ReadCloser, ObjectStat, error) {
 	if err := invalidArgumentToError(object); err != nil {
 		return nil, ObjectStat{}, err
 	}