create

Documentation

Overview

Creates an index with optional settings and mappings.

Index

• Variables
• type Create
  • func New(tp elastictransport.Interface) *Create
  • func (r Create) Do(ctx context.Context) (*http.Response, error)
  • func (r *Create) Header(key, value string) *Create
  • func (r *Create) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Create) Index(v string) *Create
  • func (r *Create) MasterTimeout(value string) *Create
  • func (r *Create) Raw(raw json.RawMessage) *Create
  • func (r *Create) Request(req *Request) *Create
  • func (r *Create) Timeout(value string) *Create
  • func (r *Create) WaitForActiveShards(value string) *Create
• type NewCreate
  • func NewCreateFunc(tp elastictransport.Interface) NewCreate
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Aliases(values map[types.Name]*types.AliasBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Mappings(mappings *types.TypeMappingBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Settings(settings *types.IndexSettingsBuilder) *RequestBuilder

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/master/indices-create-index.html

func (Create) Do

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

Do runs the http.Request through the provided transport.

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) Index

func (r *Create) Index(v string) *Create

Index The name of the index API Name: index

func (*Create) MasterTimeout

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (*Create) Raw

func (r *Create) Raw(raw json.RawMessage) *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) Timeout

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

Timeout Explicit operation timeout API name: timeout

func (*Create) WaitForActiveShards

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

WaitForActiveShards Set the number of active shards to wait for before the operation returns. 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 map[types.Name]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 *types.IndexSettings `json:"settings,omitempty"`
}

Request holds the request body struct for the package create

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/indices/create/IndicesCreateRequest.ts#L28-L56

type RequestBuilder

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

RequestBuilder is the builder API for the create.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Aliases

func (rb *RequestBuilder) Aliases(values map[types.Name]*types.AliasBuilder) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Mappings

func (rb *RequestBuilder) Mappings(mappings *types.TypeMappingBuilder) *RequestBuilder

func (*RequestBuilder) Settings

func (rb *RequestBuilder) Settings(settings *types.IndexSettingsBuilder) *RequestBuilder