The highest tagged major version is
Documentation
¶
Overview ¶
Simulate matching the given index name against the index templates in the system
Index ¶
- Variables
- type NewSimulateIndexTemplate
- type Request
- type RequestBuilder
- func (rb *RequestBuilder) AllowAutoCreate(allowautocreate bool) *RequestBuilder
- func (rb *RequestBuilder) Build() *Request
- func (rb *RequestBuilder) ComposedOf(composed_of ...types.Name) *RequestBuilder
- func (rb *RequestBuilder) DataStream(datastream *types.DataStreamVisibilityBuilder) *RequestBuilder
- func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
- func (rb *RequestBuilder) IndexPatterns(indexpatterns *types.IndicesBuilder) *RequestBuilder
- func (rb *RequestBuilder) Meta_(meta_ *types.MetadataBuilder) *RequestBuilder
- func (rb *RequestBuilder) Priority(priority int) *RequestBuilder
- func (rb *RequestBuilder) Template(template *types.IndexTemplateMappingBuilder) *RequestBuilder
- func (rb *RequestBuilder) Version(version types.VersionNumber) *RequestBuilder
- type SimulateIndexTemplate
- func (r *SimulateIndexTemplate) Create(b bool) *SimulateIndexTemplate
- func (r SimulateIndexTemplate) Do(ctx context.Context) (*http.Response, error)
- func (r *SimulateIndexTemplate) Header(key, value string) *SimulateIndexTemplate
- func (r *SimulateIndexTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *SimulateIndexTemplate) MasterTimeout(value string) *SimulateIndexTemplate
- func (r *SimulateIndexTemplate) Name(v string) *SimulateIndexTemplate
- func (r *SimulateIndexTemplate) Raw(raw json.RawMessage) *SimulateIndexTemplate
- func (r *SimulateIndexTemplate) Request(req *Request) *SimulateIndexTemplate
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 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 []types.Name `json:"composed_of,omitempty"`
DataStream *types.DataStreamVisibility `json:"data_stream,omitempty"`
IndexPatterns *types.Indices `json:"index_patterns,omitempty"`
Meta_ *types.Metadata `json:"_meta,omitempty"`
Priority *int `json:"priority,omitempty"`
Template *types.IndexTemplateMapping `json:"template,omitempty"`
Version *types.VersionNumber `json:"version,omitempty"`
}
Request holds the request body struct for the package simulateindextemplate
type RequestBuilder ¶
type RequestBuilder struct {
// contains filtered or unexported fields
}
RequestBuilder is the builder API for the simulateindextemplate.Request
func NewRequestBuilder ¶
func NewRequestBuilder() *RequestBuilder
NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder
func (*RequestBuilder) AllowAutoCreate ¶
func (rb *RequestBuilder) AllowAutoCreate(allowautocreate bool) *RequestBuilder
func (*RequestBuilder) Build ¶
func (rb *RequestBuilder) Build() *Request
Build finalize the chain and returns the Request struct.
func (*RequestBuilder) ComposedOf ¶
func (rb *RequestBuilder) ComposedOf(composed_of ...types.Name) *RequestBuilder
func (*RequestBuilder) DataStream ¶
func (rb *RequestBuilder) DataStream(datastream *types.DataStreamVisibilityBuilder) *RequestBuilder
func (*RequestBuilder) FromJSON ¶
func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
FromJSON allows to load an arbitrary json into the request structure
func (*RequestBuilder) IndexPatterns ¶
func (rb *RequestBuilder) IndexPatterns(indexpatterns *types.IndicesBuilder) *RequestBuilder
func (*RequestBuilder) Meta_ ¶
func (rb *RequestBuilder) Meta_(meta_ *types.MetadataBuilder) *RequestBuilder
func (*RequestBuilder) Priority ¶
func (rb *RequestBuilder) Priority(priority int) *RequestBuilder
func (*RequestBuilder) Template ¶
func (rb *RequestBuilder) Template(template *types.IndexTemplateMappingBuilder) *RequestBuilder
func (*RequestBuilder) Version ¶
func (rb *RequestBuilder) Version(version types.VersionNumber) *RequestBuilder
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) Header ¶
func (r *SimulateIndexTemplate) Header(key, value string) *SimulateIndexTemplate
Header set a key, value pair in the SimulateIndexTemplate headers map.
func (*SimulateIndexTemplate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*SimulateIndexTemplate) MasterTimeout ¶
func (r *SimulateIndexTemplate) MasterTimeout(value 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) Raw ¶
func (r *SimulateIndexTemplate) Raw(raw json.RawMessage) *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.
Source Files