Documentation
¶
Overview ¶
Creates an index with optional settings and mappings.
Index ¶
- Variables
- type 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
- type Request
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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) Do ¶
Do runs the request through the transport, handle the response and returns a create.Response
func (*Create) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Create) Mappings ¶ added in v8.9.0
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 ¶
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Create) Raw ¶
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) Settings ¶ added in v8.9.0
func (r *Create) Settings(settings *types.IndexSettings) *Create
Settings Configuration options for the index. API name: settings
func (*Create) Timeout ¶
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 ¶
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 ¶
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
Source Files