getdatastream

Documentation

Overview

Get data streams. Retrieves information about one or more data streams.

Index

• Variables
• type GetDataStream
  • func New(tp elastictransport.Interface) *GetDataStream
  • func (r GetDataStream) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetDataStream) ErrorTrace(errortrace bool) *GetDataStream
  • func (r *GetDataStream) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetDataStream
  • func (r *GetDataStream) FilterPath(filterpaths ...string) *GetDataStream
  • func (r *GetDataStream) Header(key, value string) *GetDataStream
  • func (r *GetDataStream) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetDataStream) Human(human bool) *GetDataStream
  • func (r *GetDataStream) IncludeDefaults(includedefaults bool) *GetDataStream
  • func (r GetDataStream) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetDataStream) MasterTimeout(duration string) *GetDataStream
  • func (r *GetDataStream) Name(name string) *GetDataStream
  • func (r GetDataStream) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetDataStream) Pretty(pretty bool) *GetDataStream
  • func (r *GetDataStream) Verbose(verbose bool) *GetDataStream
• type NewGetDataStream
  • func NewGetDataStreamFunc(tp elastictransport.Interface) NewGetDataStream
• type Response
  • func NewResponse() *Response

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.

Types

type GetDataStream

type GetDataStream struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *GetDataStream

Get data streams. Retrieves information about one or more data streams.

https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html

func (GetDataStream) Do

func (r GetDataStream) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a getdatastream.Response

func (*GetDataStream) ErrorTrace

func (r *GetDataStream) ErrorTrace(errortrace bool) *GetDataStream

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*GetDataStream) ExpandWildcards

func (r *GetDataStream) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetDataStream

ExpandWildcards Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. API name: expand_wildcards

func (*GetDataStream) FilterPath

func (r *GetDataStream) FilterPath(filterpaths ...string) *GetDataStream

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*GetDataStream) Header

func (r *GetDataStream) Header(key, value string) *GetDataStream

Header set a key, value pair in the GetDataStream headers map.

func (*GetDataStream) HttpRequest

func (r *GetDataStream) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*GetDataStream) Human

func (r *GetDataStream) Human(human bool) *GetDataStream

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_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 (*GetDataStream) IncludeDefaults

func (r *GetDataStream) IncludeDefaults(includedefaults bool) *GetDataStream

IncludeDefaults If true, returns all relevant default configurations for the index template. API name: include_defaults

func (GetDataStream) IsSuccess

func (r GetDataStream) 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 (*GetDataStream) MasterTimeout

func (r *GetDataStream) MasterTimeout(duration string) *GetDataStream

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 (*GetDataStream) Name

func (r *GetDataStream) Name(name string) *GetDataStream

Name Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are returned. API Name: name

func (GetDataStream) Perform

func (r GetDataStream) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*GetDataStream) Pretty

func (r *GetDataStream) Pretty(pretty bool) *GetDataStream

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*GetDataStream) Verbose

func (r *GetDataStream) Verbose(verbose bool) *GetDataStream

Verbose Whether the maximum timestamp for each data stream should be calculated and returned. API name: verbose

type NewGetDataStream

type NewGetDataStream func() *GetDataStream

NewGetDataStream type alias for index.

func NewGetDataStreamFunc

func NewGetDataStreamFunc(tp elastictransport.Interface) NewGetDataStream

NewGetDataStreamFunc returns a new instance of GetDataStream 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.DataStream `json:"data_streams"`
}

Response holds the response body struct for the package getdatastream

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/get_data_stream/IndicesGetDataStreamResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response