Documentation
¶
Overview ¶
Get data stream mappings.
Get mapping information for one or more data streams.
Index ¶
- Variables
- type GetDataStreamMappings
- func (r GetDataStreamMappings) Do(providedCtx context.Context) (*Response, error)
- func (r *GetDataStreamMappings) ErrorTrace(errortrace bool) *GetDataStreamMappings
- func (r *GetDataStreamMappings) FilterPath(filterpaths ...string) *GetDataStreamMappings
- func (r *GetDataStreamMappings) Header(key, value string) *GetDataStreamMappings
- func (r *GetDataStreamMappings) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetDataStreamMappings) Human(human bool) *GetDataStreamMappings
- func (r GetDataStreamMappings) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetDataStreamMappings) MasterTimeout(duration string) *GetDataStreamMappings
- func (r GetDataStreamMappings) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetDataStreamMappings) Pretty(pretty bool) *GetDataStreamMappings
- type NewGetDataStreamMappings
- 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 GetDataStreamMappings ¶
type GetDataStreamMappings struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetDataStreamMappings
Get data stream mappings.
Get mapping information for one or more data streams.
func (GetDataStreamMappings) Do ¶
func (r GetDataStreamMappings) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getdatastreammappings.Response
func (*GetDataStreamMappings) ErrorTrace ¶
func (r *GetDataStreamMappings) ErrorTrace(errortrace bool) *GetDataStreamMappings
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*GetDataStreamMappings) FilterPath ¶
func (r *GetDataStreamMappings) FilterPath(filterpaths ...string) *GetDataStreamMappings
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*GetDataStreamMappings) Header ¶
func (r *GetDataStreamMappings) Header(key, value string) *GetDataStreamMappings
Header set a key, value pair in the GetDataStreamMappings headers map.
func (*GetDataStreamMappings) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetDataStreamMappings) Human ¶
func (r *GetDataStreamMappings) Human(human bool) *GetDataStreamMappings
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (GetDataStreamMappings) IsSuccess ¶
func (r GetDataStreamMappings) 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 (*GetDataStreamMappings) MasterTimeout ¶
func (r *GetDataStreamMappings) MasterTimeout(duration string) *GetDataStreamMappings
MasterTimeout The 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 (GetDataStreamMappings) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetDataStreamMappings) Pretty ¶
func (r *GetDataStreamMappings) Pretty(pretty bool) *GetDataStreamMappings
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewGetDataStreamMappings ¶
type NewGetDataStreamMappings func(name string) *GetDataStreamMappings
NewGetDataStreamMappings type alias for index.
func NewGetDataStreamMappingsFunc ¶
func NewGetDataStreamMappingsFunc(tp elastictransport.Interface) NewGetDataStreamMappings
NewGetDataStreamMappingsFunc returns a new instance of GetDataStreamMappings with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶
type Response struct {
DataStreams []types.DataStreamMappings `json:"data_streams"`
}
Response holds the response body struct for the package getdatastreammappings
Source Files