create

Documentation

Overview

Creates an index with optional settings and mappings.

Index

• Variables
• type Create
  • func New(tp elastictransport.Interface) *Create
  • func (r *Create) Aliases(aliases map[string]types.Alias) *Create
  • func (r Create) Do(providedCtx context.Context) (*Response, error)
  • func (r *Create) Header(key, value string) *Create
  • func (r *Create) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Create) Mappings(mappings *types.TypeMapping) *Create
  • func (r *Create) MasterTimeout(duration string) *Create
  • func (r Create) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Create) Raw(raw io.Reader) *Create
  • func (r *Create) Request(req *Request) *Create
  • func (r *Create) Settings(settings *types.IndexSettings) *Create
  • func (r *Create) Timeout(duration string) *Create
  • func (r *Create) WaitForActiveShards(waitforactiveshards string) *Create
• type NewCreate
  • func NewCreateFunc(tp elastictransport.Interface) NewCreate
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type Create

type Create struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *Create

Creates an index with optional settings and mappings.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html

func (*Create) Aliases

func (r *Create) Aliases(aliases map[string]types.Alias) *Create

Aliases Aliases for the index. API name: aliases

func (Create) Do

func (r Create) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a create.Response

func (*Create) Header

func (r *Create) Header(key, value string) *Create

Header set a key, value pair in the Create headers map.

func (*Create) HttpRequest

func (r *Create) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Create) Mappings

func (r *Create) Mappings(mappings *types.TypeMapping) *Create

Mappings Mapping for fields in the index. If specified, this mapping can include: - Field names - Field data types - Mapping parameters API name: mappings

func (*Create) MasterTimeout

func (r *Create) MasterTimeout(duration string) *Create

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (Create) Perform

func (r Create) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Create) Raw

func (r *Create) Raw(raw io.Reader) *Create

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*Create) Request

func (r *Create) Request(req *Request) *Create

Request allows to set the request property with the appropriate payload.

func (*Create) Settings

func (r *Create) Settings(settings *types.IndexSettings) *Create

Settings Configuration options for the index. API name: settings

func (*Create) Timeout

func (r *Create) Timeout(duration string) *Create

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

func (*Create) WaitForActiveShards

func (r *Create) WaitForActiveShards(waitforactiveshards string) *Create

WaitForActiveShards The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). API name: wait_for_active_shards

type NewCreate

type NewCreate func(index string) *Create

NewCreate type alias for index.

func NewCreateFunc

func NewCreateFunc(tp elastictransport.Interface) NewCreate

NewCreateFunc returns a new instance of Create with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request

type Request struct {

	// Aliases Aliases for the index.
	Aliases map[string]types.Alias `json:"aliases,omitempty"`
	// Mappings Mapping for fields in the index. If specified, this mapping can include:
	// - Field names
	// - Field data types
	// - Mapping parameters
	Mappings *types.TypeMapping `json:"mappings,omitempty"`
	// Settings Configuration options for the index.
	Settings *types.IndexSettings `json:"settings,omitempty"`
}

Request holds the request body struct for the package create

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/indices/create/IndicesCreateRequest.ts#L28-L81

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Acknowledged       bool   `json:"acknowledged"`
	Index              string `json:"index"`
	ShardsAcknowledged bool   `json:"shards_acknowledged"`
}

Response holds the response body struct for the package create

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/indices/create/IndicesCreateResponse.ts#L22-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response