Documentation
¶
Overview ¶
Returns information about whether a particular index template exists.
Index ¶
- Variables
- type ExistsIndexTemplate
- func (r ExistsIndexTemplate) Do(ctx context.Context) (bool, error)
- func (r *ExistsIndexTemplate) Header(key, value string) *ExistsIndexTemplate
- func (r *ExistsIndexTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r ExistsIndexTemplate) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *ExistsIndexTemplate) MasterTimeout(duration string) *ExistsIndexTemplate
- func (r ExistsIndexTemplate) Perform(providedCtx context.Context) (*http.Response, error)
- type NewExistsIndexTemplate
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 ExistsIndexTemplate ¶
type ExistsIndexTemplate struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ExistsIndexTemplate
Returns information about whether a particular index template exists.
https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html
func (ExistsIndexTemplate) Do ¶
func (r ExistsIndexTemplate) Do(ctx context.Context) (bool, error)
Do runs the request through the transport, handle the response and returns a existsindextemplate.Response
func (*ExistsIndexTemplate) Header ¶
func (r *ExistsIndexTemplate) Header(key, value string) *ExistsIndexTemplate
Header set a key, value pair in the ExistsIndexTemplate headers map.
func (*ExistsIndexTemplate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (ExistsIndexTemplate) IsSuccess ¶
func (r ExistsIndexTemplate) IsSuccess(providedCtx context.Context) (bool, error)
IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.
func (*ExistsIndexTemplate) MasterTimeout ¶
func (r *ExistsIndexTemplate) MasterTimeout(duration string) *ExistsIndexTemplate
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
type NewExistsIndexTemplate ¶
type NewExistsIndexTemplate func(name string) *ExistsIndexTemplate
NewExistsIndexTemplate type alias for index.
func NewExistsIndexTemplateFunc ¶
func NewExistsIndexTemplateFunc(tp elastictransport.Interface) NewExistsIndexTemplate
NewExistsIndexTemplateFunc returns a new instance of ExistsIndexTemplate with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files