Skip to content

Commit

Permalink
Add get bucket versioning (#1266)
Browse files Browse the repository at this point in the history
- Add example for GetBucketVersioning
- Add doc for GetBucketVersioning
  • Loading branch information
clook committed Apr 14, 2020
1 parent 8bb083d commit dea5375
Show file tree
Hide file tree
Showing 3 changed files with 169 additions and 4 deletions.
78 changes: 78 additions & 0 deletions api-get-bucket-versioning.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
* MinIO Go Library for Amazon S3 Compatible Cloud Storage
* Copyright 2020 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 minio

import (
"context"
"encoding/xml"
"io/ioutil"
"net/http"
"net/url"

"github.com/minio/minio-go/v6/pkg/s3utils"
)

// BucketVersioningConfiguration is the versioning configuration structure
type BucketVersioningConfiguration struct {
XMLName xml.Name `xml:"VersioningConfiguration"`
Status string `xml:"Status"`
MfaDelete string `xml:"MfaDelete,omitempty"`
}

// GetBucketVersioning - get versioning configuration for a bucket.
func (c Client) GetBucketVersioning(bucketName string) (BucketVersioningConfiguration, error) {
return c.GetBucketVersioningWithContext(context.Background(), bucketName)
}

// GetBucketVersioningWithContext gets the versioning configuration on an existing bucket with a context to control cancellations and timeouts.
func (c Client) GetBucketVersioningWithContext(ctx context.Context, bucketName string) (BucketVersioningConfiguration, error) {
// Input validation.
if err := s3utils.CheckValidBucketName(bucketName); err != nil {
return BucketVersioningConfiguration{}, err
}

// Get resources properly escaped and lined up before
// using them in http request.
urlValues := make(url.Values)
urlValues.Set("versioning", "")

// Execute GET on bucket to get the versioning configuration.
resp, err := c.executeMethod(ctx, http.MethodGet, requestMetadata{
bucketName: bucketName,
queryValues: urlValues,
})

defer closeResponse(resp)
if err != nil {
return BucketVersioningConfiguration{}, err
}

if resp.StatusCode != http.StatusOK {
return BucketVersioningConfiguration{}, httpRespToErrorResponse(resp, bucketName, "")
}

bucketVersioningBuf, err := ioutil.ReadAll(resp.Body)
if err != nil {
return BucketVersioningConfiguration{}, err
}

versioningConfig := BucketVersioningConfiguration{}
if err := xml.Unmarshal(bucketVersioningBuf, &versioningConfig); err != nil {
return BucketVersioningConfiguration{}, err
}
return versioningConfig, nil
}
43 changes: 39 additions & 4 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,10 @@ func main() {
| | [`ComposeObject`](#ComposeObject) | [`ComposeObject`](#ComposeObject) | | [`GetObjectLockConfig`](#GetObjectLockConfig) | |
| | [`NewSourceInfo`](#NewSourceInfo) | [`NewSourceInfo`](#NewSourceInfo) | | [`EnableVersioning`](#EnableVersioning) | |
| | [`NewDestinationInfo`](#NewDestinationInfo) | [`NewDestinationInfo`](#NewDestinationInfo) | | [`DisableVersioning`](#DisableVersioning) | |
| | [`PutObjectWithContext`](#PutObjectWithContext) | [`PutObjectWithContext`](#PutObjectWithContext) | | [`SetBucketEncryption`](#SetBucketEncryption) |
| | [`GetObjectWithContext`](#GetObjectWithContext) | [`GetObjectWithContext`](#GetObjectWithContext) | | [`GetBucketEncryption`](#GetBucketEncryption) | |
| | [`FPutObjectWithContext`](#FPutObjectWithContext) | [`FPutObjectWithContext`](#FPutObjectWithContext) | | [`DeleteBucketEncryption`](#DeleteBucketEncryption) |
| | [`FGetObjectWithContext`](#FGetObjectWithContext) | [`FGetObjectWithContext`](#FGetObjectWithContext) | | |
| | [`PutObjectWithContext`](#PutObjectWithContext) | [`PutObjectWithContext`](#PutObjectWithContext) | | [`GetBucketVersioning`](#GetBucketVersioning) |
| | [`GetObjectWithContext`](#GetObjectWithContext) | [`GetObjectWithContext`](#GetObjectWithContext) | | [`SetBucketEncryption`](#SetBucketEncryption) | |
| | [`FPutObjectWithContext`](#FPutObjectWithContext) | [`FPutObjectWithContext`](#FPutObjectWithContext) | | [`GetBucketEncryption`](#GetBucketEncryption) |
| | [`FGetObjectWithContext`](#FGetObjectWithContext) | [`FGetObjectWithContext`](#FGetObjectWithContext) | | [`DeleteBucketEncryption`](#DeleteBucketEncryption) |
| | [`RemoveObjectsWithContext`](#RemoveObjectsWithContext) | | | |
| | [`RemoveObjectsWithOptions`](#RemoveObjectsWithOptions) | | | |
| | [`RemoveObjectsWithOptionsContext`](#RemoveObjectsWithOptionsContext) | | | |
Expand Down Expand Up @@ -2314,6 +2314,41 @@ if err != nil {
fmt.Println("versioning disabled for bucket 'my-bucketname'")
```

<a name="GetBucketVersioning"></a>
### GetBucketVersioning(bucketName string) (BucketVersioningConfiguration, error)
Get versioning configuration set on a bucket.

__Parameters__


|Param |Type |Description |
|:---|:---| :---|
|`bucketName` | _string_ |Name of the bucket |

__Return Values__


|Param |Type |Description |
|:---|:---| :---|
|`configuration` | _minio.BucketVersioningConfiguration_ | Structure that holds versioning configuration |
|`err` | _error_ |Standard Error |

__Example__

```go
s3Client, err := minio.New("s3.amazonaws.com", "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", true)
if err != nil {
log.Fatalln(err)
}

// Get versioning configuration set on an S3 bucket and print it out
versioningConfig, err := s3Client.GetBucketVersioning("my-bucketname")
if err != nil {
log.Fatalln(err)
}
fmt.Printf("%+v\n", versioningConfig)
```

## 7. Client custom settings

<a name="SetAppInfo"></a>
Expand Down
52 changes: 52 additions & 0 deletions examples/s3/getbucketversioning.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// +build ignore

/*
* MinIO Go Library for Amazon S3 Compatible Cloud Storage
* Copyright 2020 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 main

import (
"fmt"
"log"

"github.com/minio/minio-go/v6"
)

func main() {
// Note: YOUR-ACCESSKEYID, YOUR-SECRETACCESSKEY and my-bucketname are
// dummy values, please replace them with original values.

// Requests are always secure (HTTPS) by default. Set secure=false to enable insecure (HTTP) access.
// This boolean value is the last argument for New().

// New returns an Amazon S3 compatible client object. API compatibility (v2 or v4) is automatically
// determined based on the Endpoint value.
s3Client, err := minio.New("s3.amazonaws.com", "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", true)
if err != nil {
log.Fatalln(err)
}

// s3Client.TraceOn(os.Stderr)

// Get versioning configuration set on an S3 bucket,
// and print out the versioning configuration.
versioningConfig, err := s3Client.GetBucketVersioning("my-bucketname")
if err != nil {
log.Fatalln(err)
}
fmt.Printf("%+v\n", versioningConfig)
}

0 comments on commit dea5375

Please sign in to comment.