-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Snapshot Create API #533
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,179 @@ | ||
// Copyright 2012-present Oliver Eilhard. All rights reserved. | ||
// Use of this source code is governed by a MIT-license. | ||
// See http://olivere.mit-license.org/license.txt for details. | ||
|
||
package elastic | ||
|
||
import ( | ||
"context" | ||
"encoding/json" | ||
"fmt" | ||
"net/url" | ||
"time" | ||
|
||
"github.com/olivere/elastic/uritemplates" | ||
) | ||
|
||
// SnapshotCreateService is documented at https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html. | ||
type SnapshotCreateService struct { | ||
client *Client | ||
pretty bool | ||
repository string | ||
snapshot string | ||
masterTimeout string | ||
waitForCompletion *bool | ||
bodyJson interface{} | ||
bodyString string | ||
} | ||
|
||
// NewSnapshotCreateService creates a new SnapshotCreateService. | ||
func NewSnapshotCreateService(client *Client) *SnapshotCreateService { | ||
return &SnapshotCreateService{ | ||
client: client, | ||
} | ||
} | ||
|
||
// Repository is the repository name. | ||
func (s *SnapshotCreateService) Repository(repository string) *SnapshotCreateService { | ||
s.repository = repository | ||
return s | ||
} | ||
|
||
// Snapshot is the snapshot name. | ||
func (s *SnapshotCreateService) Snapshot(snapshot string) *SnapshotCreateService { | ||
s.snapshot = snapshot | ||
return s | ||
} | ||
|
||
// MasterTimeout is documented as: Explicit operation timeout for connection to master node. | ||
func (s *SnapshotCreateService) MasterTimeout(masterTimeout string) *SnapshotCreateService { | ||
s.masterTimeout = masterTimeout | ||
return s | ||
} | ||
|
||
// WaitForCompletion is documented as: Should this request wait until the operation has completed before returning. | ||
func (s *SnapshotCreateService) WaitForCompletion(waitForCompletion bool) *SnapshotCreateService { | ||
s.waitForCompletion = &waitForCompletion | ||
return s | ||
} | ||
|
||
// Pretty indicates that the JSON response be indented and human readable. | ||
func (s *SnapshotCreateService) Pretty(pretty bool) *SnapshotCreateService { | ||
s.pretty = pretty | ||
return s | ||
} | ||
|
||
// BodyJson is documented as: The snapshot definition. | ||
func (s *SnapshotCreateService) BodyJson(body interface{}) *SnapshotCreateService { | ||
s.bodyJson = body | ||
return s | ||
} | ||
|
||
// BodyString is documented as: The snapshot definition. | ||
func (s *SnapshotCreateService) BodyString(body string) *SnapshotCreateService { | ||
s.bodyString = body | ||
return s | ||
} | ||
|
||
// buildURL builds the URL for the operation. | ||
func (s *SnapshotCreateService) buildURL() (string, url.Values, error) { | ||
// Build URL | ||
path, err := uritemplates.Expand("/_snapshot/{repository}/{snapshot}", map[string]string{ | ||
"snapshot": s.snapshot, | ||
"repository": s.repository, | ||
}) | ||
if err != nil { | ||
return "", url.Values{}, err | ||
} | ||
|
||
// Add query string parameters | ||
params := url.Values{} | ||
if s.pretty { | ||
params.Set("pretty", "1") | ||
} | ||
if s.masterTimeout != "" { | ||
params.Set("master_timeout", s.masterTimeout) | ||
} | ||
if s.waitForCompletion != nil { | ||
params.Set("wait_for_completion", fmt.Sprintf("%v", *s.waitForCompletion)) | ||
} | ||
return path, params, nil | ||
} | ||
|
||
// Validate checks if the operation is valid. | ||
func (s *SnapshotCreateService) Validate() error { | ||
var invalid []string | ||
if s.repository == "" { | ||
invalid = append(invalid, "Repository") | ||
} | ||
if s.snapshot == "" { | ||
invalid = append(invalid, "Snapshot") | ||
} | ||
if len(invalid) > 0 { | ||
return fmt.Errorf("missing required fields: %v", invalid) | ||
} | ||
return nil | ||
} | ||
|
||
// Do executes the operation. | ||
func (s *SnapshotCreateService) Do(ctx context.Context) (*SnapshotCreateResponse, error) { | ||
// Check pre-conditions | ||
if err := s.Validate(); err != nil { | ||
return nil, err | ||
} | ||
|
||
// Get URL for request | ||
path, params, err := s.buildURL() | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
// Setup HTTP request body | ||
var body interface{} | ||
if s.bodyJson != nil { | ||
body = s.bodyJson | ||
} else { | ||
body = s.bodyString | ||
} | ||
|
||
// Get HTTP response | ||
res, err := s.client.PerformRequest(ctx, "PUT", path, params, body) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
// Return operation response | ||
ret := new(SnapshotCreateResponse) | ||
if err := json.Unmarshal(res.Body, ret); err != nil { | ||
return nil, err | ||
} | ||
return ret, nil | ||
} | ||
|
||
// SnapshotCreateResponse is the response of SnapshotCreateService.Do. | ||
type SnapshotCreateResponse struct { | ||
// Accepted indicates whether the request was accepted by elasticsearch. | ||
// It's available when waitForCompletion is false. | ||
Accepted *bool `json:"accepted"` | ||
|
||
// Snapshot is available when waitForCompletion is true. | ||
Snapshot *struct { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No, ES does not send the |
||
Snapshot string `json:"snapshot"` | ||
UUID string `json:"uuid"` | ||
VersionID int `json:"version_id"` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you compare these fields with what ES really sends, or did you make an educated guess? I typically consult the Java source to see what fields (and their types) ES really sends and, more often than not, I find fields that are undocumented but sent anyway. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. On my previous commit I compared these field with what ES really sends (turning logging on), but today I made a new commit consulting the java source code. |
||
Version string `json:"version"` | ||
Indices []string `json:"indices"` | ||
State string `json:"state"` | ||
StartTime time.Time `json:"start_time"` | ||
StartTimeInMillis int64 `json:"start_time_in_millis"` | ||
EndTime time.Time `json:"end_time"` | ||
EndTimeInMillis int64 `json:"end_time_in_millis"` | ||
DurationInMillis int `json:"duration_in_millis"` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This e.g. should be There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
Failures []interface{} `json:"failures"` | ||
Shards struct { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
Total int `json:"total"` | ||
Failed int `json:"failed"` | ||
Successful int `json:"successful"` | ||
} `json:"shards"` | ||
} `json:"snapshot"` | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
package elastic | ||
|
||
import ( | ||
"net/url" | ||
"reflect" | ||
"testing" | ||
) | ||
|
||
func TestSnapshotValidate(t *testing.T) { | ||
var client *Client | ||
|
||
err := NewSnapshotCreateService(client).Validate() | ||
got := err.Error() | ||
expected := "missing required fields: [Repository Snapshot]" | ||
if got != expected { | ||
t.Errorf("expected %q; got: %q", expected, got) | ||
} | ||
} | ||
|
||
func TestSnapshotPutURL(t *testing.T) { | ||
client := setupTestClient(t) | ||
|
||
tests := []struct { | ||
Repository string | ||
Snapshot string | ||
Pretty bool | ||
MasterTimeout string | ||
WaitForCompletion bool | ||
ExpectedPath string | ||
ExpectedParams url.Values | ||
}{ | ||
{ | ||
Repository: "repo", | ||
Snapshot: "snapshot_of_sunday", | ||
Pretty: true, | ||
MasterTimeout: "60s", | ||
WaitForCompletion: true, | ||
ExpectedPath: "/_snapshot/repo/snapshot_of_sunday", | ||
ExpectedParams: url.Values{ | ||
"pretty": []string{"1"}, | ||
"master_timeout": []string{"60s"}, | ||
"wait_for_completion": []string{"true"}, | ||
}, | ||
}, | ||
} | ||
|
||
for _, test := range tests { | ||
path, params, err := client.SnapshotCreate(test.Repository, test.Snapshot). | ||
Pretty(test.Pretty). | ||
MasterTimeout(test.MasterTimeout). | ||
WaitForCompletion(test.WaitForCompletion). | ||
buildURL() | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
if path != test.ExpectedPath { | ||
t.Errorf("expected %q; got: %q", test.ExpectedPath, path) | ||
} | ||
if !reflect.DeepEqual(params, test.ExpectedParams) { | ||
t.Errorf("expected %q; got: %q", test.ExpectedParams, params) | ||
} | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This must be
"gopkg.in/olivere/elastic.v5/uritemplates"
. The generator need some polish, I'm sorry.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem, the generator is pretty good 👍