Documentation
¶
Overview ¶
Returns data streams.
Index ¶
- Variables
- type GetDataStream
- func (r GetDataStream) Do(providedCtx context.Context) (*Response, error)
- func (r *GetDataStream) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetDataStream
- func (r *GetDataStream) Header(key, value string) *GetDataStream
- func (r *GetDataStream) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetDataStream) IncludeDefaults(includedefaults bool) *GetDataStream
- func (r GetDataStream) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetDataStream) Name(name string) *GetDataStream
- func (r GetDataStream) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetDataStream
- 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 GetDataStream ¶
type GetDataStream struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetDataStream
Returns 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) 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) Header ¶
func (r *GetDataStream) Header(key, value string) *GetDataStream
Header set a key, value pair in the GetDataStream headers map.
func (*GetDataStream) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetDataStream) IncludeDefaults ¶ added in v8.8.0
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) 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
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 ¶ added in v8.7.0
type Response struct {
DataStreams []types.DataStream `json:"data_streams"`
}
Response holds the response body struct for the package getdatastream
Source Files