Documentation
¶
Overview ¶
Returns information about whether a particular component template exist
Index ¶
- Variables
- type ExistsComponentTemplate
- func (r ExistsComponentTemplate) Do(ctx context.Context) (bool, error)
- func (r *ExistsComponentTemplate) Header(key, value string) *ExistsComponentTemplate
- func (r *ExistsComponentTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r ExistsComponentTemplate) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *ExistsComponentTemplate) Local(local bool) *ExistsComponentTemplate
- func (r *ExistsComponentTemplate) MasterTimeout(duration string) *ExistsComponentTemplate
- func (r ExistsComponentTemplate) Perform(providedCtx context.Context) (*http.Response, error)
- type NewExistsComponentTemplate
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 ExistsComponentTemplate ¶
type ExistsComponentTemplate struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ExistsComponentTemplate
Returns information about whether a particular component template exist
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
func (ExistsComponentTemplate) Do ¶
func (r ExistsComponentTemplate) Do(ctx context.Context) (bool, error)
Do runs the request through the transport, handle the response and returns a existscomponenttemplate.Response
func (*ExistsComponentTemplate) Header ¶
func (r *ExistsComponentTemplate) Header(key, value string) *ExistsComponentTemplate
Header set a key, value pair in the ExistsComponentTemplate headers map.
func (*ExistsComponentTemplate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (ExistsComponentTemplate) IsSuccess ¶
func (r ExistsComponentTemplate) 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 (*ExistsComponentTemplate) Local ¶
func (r *ExistsComponentTemplate) Local(local bool) *ExistsComponentTemplate
Local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. API name: local
func (*ExistsComponentTemplate) MasterTimeout ¶
func (r *ExistsComponentTemplate) MasterTimeout(duration string) *ExistsComponentTemplate
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 NewExistsComponentTemplate ¶
type NewExistsComponentTemplate func(name string) *ExistsComponentTemplate
NewExistsComponentTemplate type alias for index.
func NewExistsComponentTemplateFunc ¶
func NewExistsComponentTemplateFunc(tp elastictransport.Interface) NewExistsComponentTemplate
NewExistsComponentTemplateFunc returns a new instance of ExistsComponentTemplate with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files