Documentation
¶
Overview ¶
Updates certain properties of a transform.
Index ¶
- Variables
- type NewUpdateTransform
- type Request
- type Response
- type UpdateTransform
- func (r *UpdateTransform) DeferValidation(b bool) *UpdateTransform
- func (r UpdateTransform) Do(ctx context.Context) (*Response, error)
- func (r *UpdateTransform) Header(key, value string) *UpdateTransform
- func (r *UpdateTransform) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r UpdateTransform) Perform(ctx context.Context) (*http.Response, error)
- func (r *UpdateTransform) Raw(raw io.Reader) *UpdateTransform
- func (r *UpdateTransform) Request(req *Request) *UpdateTransform
- func (r *UpdateTransform) Timeout(v string) *UpdateTransform
- func (r *UpdateTransform) TransformId(v string) *UpdateTransform
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 NewUpdateTransform ¶
type NewUpdateTransform func(transformid string) *UpdateTransform
NewUpdateTransform type alias for index.
func NewUpdateTransformFunc ¶
func NewUpdateTransformFunc(tp elastictransport.Interface) NewUpdateTransform
NewUpdateTransformFunc returns a new instance of UpdateTransform with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// Description Free text description of the transform.
Description *string `json:"description,omitempty"`
// Dest The destination for the transform.
Dest *types.TransformDestination `json:"dest,omitempty"`
// Frequency The interval between checks for changes in the source indices when the
// transform is running continuously. Also determines the retry interval in
// the event of transient failures while the transform is searching or
// indexing. The minimum value is 1s and the maximum is 1h.
Frequency types.Duration `json:"frequency,omitempty"`
// Meta_ Defines optional transform metadata.
Meta_ map[string]json.RawMessage `json:"_meta,omitempty"`
// RetentionPolicy Defines a retention policy for the transform. Data that meets the defined
// criteria is deleted from the destination index.
RetentionPolicy types.RetentionPolicyContainer `json:"retention_policy,omitempty"`
// Settings Defines optional transform settings.
Settings *types.Settings `json:"settings,omitempty"`
// Source The source of the data for the transform.
Source *types.TransformSource `json:"source,omitempty"`
// Sync Defines the properties transforms require to run continuously.
Sync *types.SyncContainer `json:"sync,omitempty"`
}
Request holds the request body struct for the package updatetransform
type Response ¶
type Response struct {
Authorization *types.TransformAuthorization `json:"authorization,omitempty"`
CreateTime int64 `json:"create_time"`
Description string `json:"description"`
Dest types.ReindexDestination `json:"dest"`
Frequency types.Duration `json:"frequency,omitempty"`
Id string `json:"id"`
Latest *types.Latest `json:"latest,omitempty"`
Meta_ map[string]json.RawMessage `json:"_meta,omitempty"`
Pivot *types.Pivot `json:"pivot,omitempty"`
RetentionPolicy *types.RetentionPolicyContainer `json:"retention_policy,omitempty"`
Settings types.Settings `json:"settings"`
Source types.ReindexSource `json:"source"`
Sync *types.SyncContainer `json:"sync,omitempty"`
Version string `json:"version"`
}
type UpdateTransform ¶
type UpdateTransform struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *UpdateTransform
Updates certain properties of a transform.
https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html
func (*UpdateTransform) DeferValidation ¶
func (r *UpdateTransform) DeferValidation(b bool) *UpdateTransform
DeferValidation When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created. API name: defer_validation
func (UpdateTransform) Do ¶
func (r UpdateTransform) Do(ctx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a updatetransform.Response
func (*UpdateTransform) Header ¶
func (r *UpdateTransform) Header(key, value string) *UpdateTransform
Header set a key, value pair in the UpdateTransform headers map.
func (*UpdateTransform) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (UpdateTransform) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*UpdateTransform) Raw ¶
func (r *UpdateTransform) Raw(raw io.Reader) *UpdateTransform
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*UpdateTransform) Request ¶
func (r *UpdateTransform) Request(req *Request) *UpdateTransform
Request allows to set the request property with the appropriate payload.
func (*UpdateTransform) Timeout ¶
func (r *UpdateTransform) Timeout(v string) *UpdateTransform
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
func (*UpdateTransform) TransformId ¶
func (r *UpdateTransform) TransformId(v string) *UpdateTransform
TransformId Identifier for the transform. API Name: transformid