Documentation
¶
Overview ¶
Turns on snapshot lifecycle management (SLM).
Index ¶
- Variables
- type NewStart
- type Response
- type Start
- func (r Start) Do(providedCtx context.Context) (*Response, error)
- func (r *Start) Header(key, value string) *Start
- func (r *Start) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Start) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Start) Perform(providedCtx context.Context) (*http.Response, error)
Constants ¶
This section is empty.
Variables ¶
View Source
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 NewStart ¶
type NewStart func() *Start
NewStart type alias for index.
func NewStartFunc ¶
func NewStartFunc(tp elastictransport.Interface) NewStart
NewStartFunc returns a new instance of Start 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 {
// 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 start
type Start ¶
type Start struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Start
Turns on snapshot lifecycle management (SLM).
https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html
func (Start) Do ¶
Do runs the request through the transport, handle the response and returns a start.Response
func (*Start) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
Source Files
Click to show internal directories.
Click to hide internal directories.