Documentation
¶
Overview ¶
Returns one or more component templates
Index ¶
- Variables
- type GetComponentTemplate
- func (r GetComponentTemplate) Do(providedCtx context.Context) (*Response, error)
- func (r *GetComponentTemplate) FlatSettings(flatsettings bool) *GetComponentTemplate
- func (r *GetComponentTemplate) Header(key, value string) *GetComponentTemplate
- func (r *GetComponentTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetComponentTemplate) IncludeDefaults(includedefaults bool) *GetComponentTemplate
- func (r GetComponentTemplate) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetComponentTemplate) Local(local bool) *GetComponentTemplate
- func (r *GetComponentTemplate) MasterTimeout(duration string) *GetComponentTemplate
- func (r *GetComponentTemplate) Name(name string) *GetComponentTemplate
- func (r GetComponentTemplate) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetComponentTemplate
- type Response
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/current/indices-component-template.html
func (GetComponentTemplate) Do ¶
func (r GetComponentTemplate) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getcomponenttemplate.Response
func (*GetComponentTemplate) FlatSettings ¶
func (r *GetComponentTemplate) FlatSettings(flatsettings bool) *GetComponentTemplate
FlatSettings If `true`, returns settings in flat format. 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) IncludeDefaults ¶ added in v8.8.0
func (r *GetComponentTemplate) IncludeDefaults(includedefaults bool) *GetComponentTemplate
IncludeDefaults Return all default configurations for the component template (default: false) API name: include_defaults
func (GetComponentTemplate) IsSuccess ¶
func (r GetComponentTemplate) 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 (*GetComponentTemplate) Local ¶
func (r *GetComponentTemplate) Local(local bool) *GetComponentTemplate
Local If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. API name: local
func (*GetComponentTemplate) MasterTimeout ¶
func (r *GetComponentTemplate) MasterTimeout(duration string) *GetComponentTemplate
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 (*GetComponentTemplate) Name ¶
func (r *GetComponentTemplate) Name(name string) *GetComponentTemplate
Name Comma-separated list of component template names used to limit the request. Wildcard (`*`) expressions are supported. 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.
type Response ¶ added in v8.7.0
type Response struct {
ComponentTemplates []types.ClusterComponentTemplate `json:"component_templates"`
}
Response holds the response body struct for the package getcomponenttemplate
Source Files