Documentation
¶
Overview ¶
Returns the data stream lifecycle of the selected data streams.
Index ¶
- Variables
- type GetDataLifecycle
- func (r GetDataLifecycle) Do(providedCtx context.Context) (*Response, error)
- func (r *GetDataLifecycle) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetDataLifecycle
- func (r *GetDataLifecycle) Header(key, value string) *GetDataLifecycle
- func (r *GetDataLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetDataLifecycle) IncludeDefaults(includedefaults bool) *GetDataLifecycle
- func (r GetDataLifecycle) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetDataLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetDataLifecycle
- 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 GetDataLifecycle ¶
type GetDataLifecycle struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetDataLifecycle
Returns the data stream lifecycle of the selected data streams.
https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-get-lifecycle.html
func (GetDataLifecycle) Do ¶
func (r GetDataLifecycle) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getdatalifecycle.Response
func (*GetDataLifecycle) ExpandWildcards ¶
func (r *GetDataLifecycle) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetDataLifecycle
ExpandWildcards Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. API name: expand_wildcards
func (*GetDataLifecycle) Header ¶
func (r *GetDataLifecycle) Header(key, value string) *GetDataLifecycle
Header set a key, value pair in the GetDataLifecycle headers map.
func (*GetDataLifecycle) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetDataLifecycle) IncludeDefaults ¶
func (r *GetDataLifecycle) IncludeDefaults(includedefaults bool) *GetDataLifecycle
IncludeDefaults If `true`, return all default settings in the response. API name: include_defaults
type NewGetDataLifecycle ¶
type NewGetDataLifecycle func(name string) *GetDataLifecycle
NewGetDataLifecycle type alias for index.
func NewGetDataLifecycleFunc ¶
func NewGetDataLifecycleFunc(tp elastictransport.Interface) NewGetDataLifecycle
NewGetDataLifecycleFunc returns a new instance of GetDataLifecycle 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.DataStreamWithLifecycle `json:"data_streams"`
}
Response holds the response body struct for the package getdatalifecycle
Source Files