getdatastreamoptions

Documentation

Overview

Get data stream options.

Get the data stream options configuration of one or more data streams.

Index

• Variables
• type GetDataStreamOptions
  • func New(tp elastictransport.Interface) *GetDataStreamOptions
  • func (r GetDataStreamOptions) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetDataStreamOptions) ErrorTrace(errortrace bool) *GetDataStreamOptions
  • func (r *GetDataStreamOptions) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetDataStreamOptions
  • func (r *GetDataStreamOptions) FilterPath(filterpaths ...string) *GetDataStreamOptions
  • func (r *GetDataStreamOptions) Header(key, value string) *GetDataStreamOptions
  • func (r *GetDataStreamOptions) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetDataStreamOptions) Human(human bool) *GetDataStreamOptions
  • func (r GetDataStreamOptions) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetDataStreamOptions) MasterTimeout(duration string) *GetDataStreamOptions
  • func (r GetDataStreamOptions) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetDataStreamOptions) Pretty(pretty bool) *GetDataStreamOptions
• type NewGetDataStreamOptions
  • func NewGetDataStreamOptionsFunc(tp elastictransport.Interface) NewGetDataStreamOptions
• 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 GetDataStreamOptions

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

func New

func New(tp elastictransport.Interface) *GetDataStreamOptions

Get data stream options.

Get the data stream options configuration of one or more data streams.

https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html

func (GetDataStreamOptions) Do

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

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

func (*GetDataStreamOptions) ErrorTrace

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

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

func (*GetDataStreamOptions) ExpandWildcards

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

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

func (*GetDataStreamOptions) FilterPath

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

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

func (*GetDataStreamOptions) Header

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

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

func (*GetDataStreamOptions) HttpRequest

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

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

func (*GetDataStreamOptions) Human

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

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 (GetDataStreamOptions) IsSuccess

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

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

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 (GetDataStreamOptions) Perform

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

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

func (*GetDataStreamOptions) Pretty

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

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

type NewGetDataStreamOptions

type NewGetDataStreamOptions func(name string) *GetDataStreamOptions

NewGetDataStreamOptions type alias for index.

func NewGetDataStreamOptionsFunc

func NewGetDataStreamOptionsFunc(tp elastictransport.Interface) NewGetDataStreamOptions

NewGetDataStreamOptionsFunc returns a new instance of GetDataStreamOptions 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.DataStreamWithOptions `json:"data_streams"`
}

Response holds the response body struct for the package getdatastreamoptions

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/indices/get_data_stream_options/IndicesGetDataStreamOptionsResponse.ts#L23-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response