Documentation ¶
Overview ¶
Returns one or more component templates
Index ¶
- Variables
- type GetComponentTemplate
- func (r GetComponentTemplate) Do(ctx context.Context) (*http.Response, error)
- func (r *GetComponentTemplate) FlatSettings(b bool) *GetComponentTemplate
- func (r *GetComponentTemplate) Header(key, value string) *GetComponentTemplate
- func (r *GetComponentTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetComponentTemplate) IsSuccess(ctx context.Context) (bool, error)
- func (r *GetComponentTemplate) Local(b bool) *GetComponentTemplate
- func (r *GetComponentTemplate) MasterTimeout(value string) *GetComponentTemplate
- func (r *GetComponentTemplate) Name(v string) *GetComponentTemplate
- type NewGetComponentTemplate
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 GetComponentTemplate ¶
type GetComponentTemplate struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetComponentTemplate
Returns one or more component templates
https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-component-template.html
func (*GetComponentTemplate) FlatSettings ¶
func (r *GetComponentTemplate) FlatSettings(b bool) *GetComponentTemplate
API name: flat_settings
func (*GetComponentTemplate) Header ¶
func (r *GetComponentTemplate) Header(key, value string) *GetComponentTemplate
Header set a key, value pair in the GetComponentTemplate headers map.
func (*GetComponentTemplate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetComponentTemplate) IsSuccess ¶
func (r GetComponentTemplate) IsSuccess(ctx 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 (*GetComponentTemplate) Local ¶
func (r *GetComponentTemplate) Local(b bool) *GetComponentTemplate
Local Return local information, do not retrieve the state from master node (default: false) API name: local
func (*GetComponentTemplate) MasterTimeout ¶
func (r *GetComponentTemplate) MasterTimeout(value string) *GetComponentTemplate
MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout
func (*GetComponentTemplate) Name ¶
func (r *GetComponentTemplate) Name(v string) *GetComponentTemplate
Name The comma separated names of the component templates API Name: name
type NewGetComponentTemplate ¶
type NewGetComponentTemplate func() *GetComponentTemplate
NewGetComponentTemplate type alias for index.
func NewGetComponentTemplateFunc ¶
func NewGetComponentTemplateFunc(tp elastictransport.Interface) NewGetComponentTemplate
NewGetComponentTemplateFunc returns a new instance of GetComponentTemplate with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.