putdatastreamoptions

Documentation

Overview

Update data stream options. Update the data stream options of the specified data streams.

Index

• Variables
• type NewPutDataStreamOptions
  • func NewPutDataStreamOptionsFunc(tp elastictransport.Interface) NewPutDataStreamOptions
• type PutDataStreamOptions
  • func New(tp elastictransport.Interface) *PutDataStreamOptions
  • func (r PutDataStreamOptions) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutDataStreamOptions) ErrorTrace(errortrace bool) *PutDataStreamOptions
  • func (r *PutDataStreamOptions) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *PutDataStreamOptions
  • func (r *PutDataStreamOptions) FailureStore(failurestore types.DataStreamFailureStoreVariant) *PutDataStreamOptions
  • func (r *PutDataStreamOptions) FilterPath(filterpaths ...string) *PutDataStreamOptions
  • func (r *PutDataStreamOptions) Header(key, value string) *PutDataStreamOptions
  • func (r *PutDataStreamOptions) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutDataStreamOptions) Human(human bool) *PutDataStreamOptions
  • func (r *PutDataStreamOptions) MasterTimeout(duration string) *PutDataStreamOptions
  • func (r PutDataStreamOptions) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutDataStreamOptions) Pretty(pretty bool) *PutDataStreamOptions
  • func (r *PutDataStreamOptions) Raw(raw io.Reader) *PutDataStreamOptions
  • func (r *PutDataStreamOptions) Request(req *Request) *PutDataStreamOptions
  • func (r *PutDataStreamOptions) Timeout(duration string) *PutDataStreamOptions
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 NewPutDataStreamOptions

type NewPutDataStreamOptions func(name string) *PutDataStreamOptions

NewPutDataStreamOptions type alias for index.

func NewPutDataStreamOptionsFunc

func NewPutDataStreamOptionsFunc(tp elastictransport.Interface) NewPutDataStreamOptions

NewPutDataStreamOptionsFunc returns a new instance of PutDataStreamOptions with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PutDataStreamOptions

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

func New

func New(tp elastictransport.Interface) *PutDataStreamOptions

Update data stream options. Update the data stream options of the specified data streams.

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

func (PutDataStreamOptions) Do

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

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

func (*PutDataStreamOptions) ErrorTrace

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

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

func (*PutDataStreamOptions) ExpandWildcards

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

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

func (*PutDataStreamOptions) FailureStore

func (r *PutDataStreamOptions) FailureStore(failurestore types.DataStreamFailureStoreVariant) *PutDataStreamOptions

If defined, it will update the failure store configuration of every data stream resolved by the name expression. API name: failure_store

func (*PutDataStreamOptions) FilterPath

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

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

func (*PutDataStreamOptions) Header

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

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

func (*PutDataStreamOptions) HttpRequest

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

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

func (*PutDataStreamOptions) Human

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

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 (*PutDataStreamOptions) MasterTimeout

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

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

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

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

func (*PutDataStreamOptions) Pretty

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

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

func (*PutDataStreamOptions) Raw

func (r *PutDataStreamOptions) Raw(raw io.Reader) *PutDataStreamOptions

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PutDataStreamOptions) Request

func (r *PutDataStreamOptions) Request(req *Request) *PutDataStreamOptions

Request allows to set the request property with the appropriate payload.

func (*PutDataStreamOptions) Timeout

func (r *PutDataStreamOptions) Timeout(duration string) *PutDataStreamOptions

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

type Request

type Request struct {

	// FailureStore If defined, it will update the failure store configuration of every data
	// stream resolved by the name expression.
	FailureStore *types.DataStreamFailureStore `json:"failure_store,omitempty"`
}

Request holds the request body struct for the package putdatastreamoptions

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts#L25-L79

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package putdatastreamoptions

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response