Documentation
¶
Overview ¶
Returns the specified policy definition. Includes the policy version and last modified date.
Index ¶
- Variables
- type GetLifecycle
- func (r GetLifecycle) Do(providedCtx context.Context) (Response, error)
- func (r *GetLifecycle) Header(key, value string) *GetLifecycle
- func (r *GetLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetLifecycle) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetLifecycle) MasterTimeout(duration string) *GetLifecycle
- func (r GetLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetLifecycle) Policy(policy string) *GetLifecycle
- func (r *GetLifecycle) Timeout(duration string) *GetLifecycle
- type NewGetLifecycle
- 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 GetLifecycle ¶
type GetLifecycle struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetLifecycle
Returns the specified policy definition. Includes the policy version and last modified date.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html
func (GetLifecycle) Do ¶
func (r GetLifecycle) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a getlifecycle.Response
func (*GetLifecycle) Header ¶
func (r *GetLifecycle) Header(key, value string) *GetLifecycle
Header set a key, value pair in the GetLifecycle headers map.
func (*GetLifecycle) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetLifecycle) IsSuccess ¶
func (r GetLifecycle) 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 (*GetLifecycle) MasterTimeout ¶
func (r *GetLifecycle) MasterTimeout(duration string) *GetLifecycle
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 (GetLifecycle) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetLifecycle) Policy ¶
func (r *GetLifecycle) Policy(policy string) *GetLifecycle
Policy Identifier for the policy. API Name: policy
func (*GetLifecycle) Timeout ¶
func (r *GetLifecycle) Timeout(duration string) *GetLifecycle
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 NewGetLifecycle ¶
type NewGetLifecycle func() *GetLifecycle
NewGetLifecycle type alias for index.
func NewGetLifecycleFunc ¶
func NewGetLifecycleFunc(tp elastictransport.Interface) NewGetLifecycle
NewGetLifecycleFunc returns a new instance of GetLifecycle with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files