getdatastreamsettings

Documentation

Overview

Get data stream settings.

Get setting information for one or more data streams.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetDataStreamSettings

Get data stream settings.

Get setting information for one or more data streams.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-data-stream-settings

func (GetDataStreamSettings) Do

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

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

func (*GetDataStreamSettings) ErrorTrace

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

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

func (*GetDataStreamSettings) FilterPath

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

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

func (*GetDataStreamSettings) Header

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

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

func (*GetDataStreamSettings) HttpRequest

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

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

func (*GetDataStreamSettings) Human

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

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

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

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

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

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

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

func (*GetDataStreamSettings) Pretty

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

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

type NewGetDataStreamSettings

type NewGetDataStreamSettings func(name string) *GetDataStreamSettings

NewGetDataStreamSettings type alias for index.

func NewGetDataStreamSettingsFunc

func NewGetDataStreamSettingsFunc(tp elastictransport.Interface) NewGetDataStreamSettings

NewGetDataStreamSettingsFunc returns a new instance of GetDataStreamSettings 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.DataStreamSettings `json:"data_streams"`
}

Response holds the response body struct for the package getdatastreamsettings

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/indices/get_data_stream_settings/IndicesGetDataStreamSettingsResponse.ts#L22-L27

func NewResponse

func NewResponse() *Response

NewResponse returns a Response