put_template.go

// Copyright 2014 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 (
	"encoding/json"
	"fmt"
	"net/http"
	"net/url"

	"github.com/olivere/elastic/uritemplates"
)

// PutTemplateService creates or updates a search template.
// The documentation can be found at
// http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html.
type PutTemplateService struct {
	client      *Client
	debug       bool
	pretty      bool
	id          string
	opType      string
	version     *int
	versionType string
	bodyJson    interface{}
	bodyString  string
}

// NewPutTemplateService creates a new PutTemplateService.
func NewPutTemplateService(client *Client) *PutTemplateService {
	return &PutTemplateService{
		client: client,
	}
}

// Id is the template ID.
func (s *PutTemplateService) Id(id string) *PutTemplateService {
	s.id = id
	return s
}

// OpType is an explicit operation type.
func (s *PutTemplateService) OpType(opType string) *PutTemplateService {
	s.opType = opType
	return s
}

// Version is an explicit version number for concurrency control.
func (s *PutTemplateService) Version(version int) *PutTemplateService {
	s.version = &version
	return s
}

// VersionType is a specific version type.
func (s *PutTemplateService) VersionType(versionType string) *PutTemplateService {
	s.versionType = versionType
	return s
}

// BodyJson is the document as a JSON serializable object.
func (s *PutTemplateService) BodyJson(body interface{}) *PutTemplateService {
	s.bodyJson = body
	return s
}

// BodyString is the document as a string.
func (s *PutTemplateService) BodyString(body string) *PutTemplateService {
	s.bodyString = body
	return s
}

// buildURL builds the URL for the operation.
func (s *PutTemplateService) buildURL() (string, error) {
	// Build URL
	urls, err := uritemplates.Expand("/_search/template/{id}", map[string]string{
		"id": s.id,
	})
	if err != nil {
		return "", err
	}

	// Add query string parameters
	params := url.Values{}
	if s.version != nil {
		params.Set("version", fmt.Sprintf("%d", *s.version))
	}
	if s.versionType != "" {
		params.Set("version_type", s.versionType)
	}
	if s.opType != "" {
		params.Set("op_type", s.opType)
	}
	if len(params) > 0 {
		urls += "?" + params.Encode()
	}

	return urls, nil
}

// Validate checks if the operation is valid.
func (s *PutTemplateService) Validate() error {
	var invalid []string
	if s.id == "" {
		invalid = append(invalid, "Id")
	}
	if s.bodyString == "" && s.bodyJson == nil {
		invalid = append(invalid, "BodyJson")
	}
	if len(invalid) > 0 {
		return fmt.Errorf("missing required fields: %v", invalid)
	}
	return nil
}

// Do executes the operation.
func (s *PutTemplateService) Do() (*PutTemplateResponse, error) {
	// Check pre-conditions
	if err := s.Validate(); err != nil {
		return nil, err
	}

	// Get URL for request
	urls, err := s.buildURL()
	if err != nil {
		return nil, err
	}

	// Setup HTTP request
	req, err := s.client.NewRequest("PUT", urls)
	if err != nil {
		return nil, err
	}

	// Setup HTTP request body
	if s.bodyJson != nil {
		req.SetBodyJson(s.bodyJson)
	} else {
		req.SetBodyString(s.bodyString)
	}

	// Debug output?
	if s.debug {
		s.client.dumpRequest((*http.Request)(req))
	}

	// Get HTTP response
	res, err := s.client.c.Do((*http.Request)(req))
	if err != nil {
		return nil, err
	}
	if err := checkResponse(res); err != nil {
		return nil, err
	}
	defer res.Body.Close()

	// Debug output?
	if s.debug {
		s.client.dumpResponse(res)
	}
	// Return operation response
	resp := new(PutTemplateResponse)
	if err := json.NewDecoder(res.Body).Decode(resp); err != nil {
		return nil, err
	}
	return resp, nil
}

// PutTemplateResponse is the response of PutTemplateService.Do.
type PutTemplateResponse struct {
	Id      string `json:"_id"`
	Version int    `json:"_version"`
	Created bool   `json:"created"`
}