Documentation
¶
Overview ¶
Creates or updates a snapshot lifecycle policy.
Index ¶
- Variables
- type NewPutLifecycle
- type PutLifecycle
- func (r *PutLifecycle) Config(config *types.Configuration) *PutLifecycle
- func (r PutLifecycle) Do(providedCtx context.Context) (*Response, error)
- func (r *PutLifecycle) Header(key, value string) *PutLifecycle
- func (r *PutLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutLifecycle) MasterTimeout(duration string) *PutLifecycle
- func (r *PutLifecycle) Name(name string) *PutLifecycle
- func (r PutLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutLifecycle) Raw(raw io.Reader) *PutLifecycle
- func (r *PutLifecycle) Repository(repository string) *PutLifecycle
- func (r *PutLifecycle) Request(req *Request) *PutLifecycle
- func (r *PutLifecycle) Retention(retention *types.Retention) *PutLifecycle
- func (r *PutLifecycle) Schedule(cronexpression string) *PutLifecycle
- func (r *PutLifecycle) Timeout(duration string) *PutLifecycle
- type Request
- 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 NewPutLifecycle ¶
type NewPutLifecycle func(policyid string) *PutLifecycle
NewPutLifecycle type alias for index.
func NewPutLifecycleFunc ¶
func NewPutLifecycleFunc(tp elastictransport.Interface) NewPutLifecycle
NewPutLifecycleFunc returns a new instance of PutLifecycle with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutLifecycle ¶
type PutLifecycle struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PutLifecycle
Creates or updates a snapshot lifecycle policy.
https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html
func (*PutLifecycle) Config ¶ added in v8.9.0
func (r *PutLifecycle) Config(config *types.Configuration) *PutLifecycle
Config Configuration for each snapshot created by the policy. API name: config
func (PutLifecycle) Do ¶
func (r PutLifecycle) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a putlifecycle.Response
func (*PutLifecycle) Header ¶
func (r *PutLifecycle) Header(key, value string) *PutLifecycle
Header set a key, value pair in the PutLifecycle headers map.
func (*PutLifecycle) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutLifecycle) MasterTimeout ¶
func (r *PutLifecycle) MasterTimeout(duration string) *PutLifecycle
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 (*PutLifecycle) Name ¶ added in v8.9.0
func (r *PutLifecycle) Name(name string) *PutLifecycle
Name Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. API name: name
func (PutLifecycle) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutLifecycle) Raw ¶
func (r *PutLifecycle) Raw(raw io.Reader) *PutLifecycle
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutLifecycle) Repository ¶ added in v8.9.0
func (r *PutLifecycle) Repository(repository string) *PutLifecycle
Repository Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. API name: repository
func (*PutLifecycle) Request ¶
func (r *PutLifecycle) Request(req *Request) *PutLifecycle
Request allows to set the request property with the appropriate payload.
func (*PutLifecycle) Retention ¶ added in v8.9.0
func (r *PutLifecycle) Retention(retention *types.Retention) *PutLifecycle
Retention Retention rules used to retain and delete snapshots created by the policy. API name: retention
func (*PutLifecycle) Schedule ¶ added in v8.9.0
func (r *PutLifecycle) Schedule(cronexpression string) *PutLifecycle
Schedule Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. API name: schedule
func (*PutLifecycle) Timeout ¶
func (r *PutLifecycle) Timeout(duration string) *PutLifecycle
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 {
// Config Configuration for each snapshot created by the policy.
Config *types.Configuration `json:"config,omitempty"`
// Name Name automatically assigned to each snapshot created by the policy. Date math
// is supported. To prevent conflicting snapshot names, a UUID is automatically
// appended to each snapshot name.
Name *string `json:"name,omitempty"`
// Repository Repository used to store snapshots created by this policy. This repository
// must exist prior to the policy’s creation. You can create a repository using
// the snapshot repository API.
Repository *string `json:"repository,omitempty"`
// Retention Retention rules used to retain and delete snapshots created by the policy.
Retention *types.Retention `json:"retention,omitempty"`
// Schedule Periodic or absolute schedule at which the policy creates snapshots. SLM
// applies schedule changes immediately.
Schedule *string `json:"schedule,omitempty"`
}
Request holds the request body struct for the package putlifecycle
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
Source Files