simulateindextemplate

Documentation

Overview

Simulate matching the given index name against the index templates in the system

Index

• Variables
• type NewSimulateIndexTemplate
  • func NewSimulateIndexTemplateFunc(tp elastictransport.Interface) NewSimulateIndexTemplate
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type SimulateIndexTemplate
  • func New(tp elastictransport.Interface) *SimulateIndexTemplate
  • func (r *SimulateIndexTemplate) Create(b bool) *SimulateIndexTemplate
  • func (r SimulateIndexTemplate) Do(ctx context.Context) (*Response, error)
  • func (r *SimulateIndexTemplate) Header(key, value string) *SimulateIndexTemplate
  • func (r *SimulateIndexTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SimulateIndexTemplate) MasterTimeout(v string) *SimulateIndexTemplate
  • func (r *SimulateIndexTemplate) Name(v string) *SimulateIndexTemplate
  • func (r SimulateIndexTemplate) Perform(ctx context.Context) (*http.Response, error)
  • func (r *SimulateIndexTemplate) Raw(raw io.Reader) *SimulateIndexTemplate
  • func (r *SimulateIndexTemplate) Request(req *Request) *SimulateIndexTemplate

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 NewSimulateIndexTemplate

type NewSimulateIndexTemplate func(name string) *SimulateIndexTemplate

NewSimulateIndexTemplate type alias for index.

func NewSimulateIndexTemplateFunc

func NewSimulateIndexTemplateFunc(tp elastictransport.Interface) NewSimulateIndexTemplate

NewSimulateIndexTemplateFunc returns a new instance of SimulateIndexTemplate 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 {
	AllowAutoCreate *bool                       `json:"allow_auto_create,omitempty"`
	ComposedOf      []string                    `json:"composed_of,omitempty"`
	DataStream      *types.DataStreamVisibility `json:"data_stream,omitempty"`
	IndexPatterns   []string                    `json:"index_patterns,omitempty"`
	Meta_           map[string]json.RawMessage  `json:"_meta,omitempty"`
	Priority        *int                        `json:"priority,omitempty"`
	Template        *types.IndexTemplateMapping `json:"template,omitempty"`
	Version         *int64                      `json:"version,omitempty"`
}

Request holds the request body struct for the package simulateindextemplate

https://github.com/elastic/elasticsearch-specification/blob/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L33-L71

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 {
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SimulateIndexTemplate

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

func New

func New(tp elastictransport.Interface) *SimulateIndexTemplate

Simulate matching the given index name against the index templates in the system

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html

func (*SimulateIndexTemplate) Create

func (r *SimulateIndexTemplate) Create(b bool) *SimulateIndexTemplate

Create If `true`, the template passed in the body is only used if no existing templates match the same index patterns. If `false`, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. API name: create

func (SimulateIndexTemplate) Do

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

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

func (*SimulateIndexTemplate) Header

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

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

func (*SimulateIndexTemplate) HttpRequest

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

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

func (*SimulateIndexTemplate) MasterTimeout

func (r *SimulateIndexTemplate) MasterTimeout(v string) *SimulateIndexTemplate

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 (*SimulateIndexTemplate) Name

func (r *SimulateIndexTemplate) Name(v string) *SimulateIndexTemplate

Name Index or template name to simulate API Name: name

func (SimulateIndexTemplate) Perform

func (r SimulateIndexTemplate) Perform(ctx context.Context) (*http.Response, error)

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

func (*SimulateIndexTemplate) Raw

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

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

func (*SimulateIndexTemplate) Request

func (r *SimulateIndexTemplate) Request(req *Request) *SimulateIndexTemplate

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