puttransform

Documentation

Overview

Instantiates a transform.

Index

• Variables
• type NewPutTransform
  • func NewPutTransformFunc(tp elastictransport.Interface) NewPutTransform
• type PutTransform
  • func New(tp elastictransport.Interface) *PutTransform
  • func (r *PutTransform) DeferValidation(b bool) *PutTransform
  • func (r PutTransform) Do(ctx context.Context) (*Response, error)
  • func (r *PutTransform) Header(key, value string) *PutTransform
  • func (r *PutTransform) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r PutTransform) Perform(ctx context.Context) (*http.Response, error)
  • func (r *PutTransform) Raw(raw io.Reader) *PutTransform
  • func (r *PutTransform) Request(req *Request) *PutTransform
  • func (r *PutTransform) Timeout(v string) *PutTransform
  • func (r *PutTransform) TransformId(v string) *PutTransform
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response

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.

Types

type NewPutTransform

type NewPutTransform func(transformid string) *PutTransform

NewPutTransform type alias for index.

func NewPutTransformFunc

func NewPutTransformFunc(tp elastictransport.Interface) NewPutTransform

NewPutTransformFunc returns a new instance of PutTransform with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PutTransform

type PutTransform struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *PutTransform

Instantiates a transform.

https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html

func (*PutTransform) DeferValidation

func (r *PutTransform) DeferValidation(b bool) *PutTransform

DeferValidation When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks. API name: defer_validation

func (PutTransform) Do

func (r PutTransform) Do(ctx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a puttransform.Response

func (*PutTransform) Header

func (r *PutTransform) Header(key, value string) *PutTransform

Header set a key, value pair in the PutTransform headers map.

func (*PutTransform) HttpRequest

func (r *PutTransform) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (PutTransform) Perform

func (r PutTransform) Perform(ctx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*PutTransform) Raw

func (r *PutTransform) Raw(raw io.Reader) *PutTransform

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PutTransform) Request

func (r *PutTransform) Request(req *Request) *PutTransform

Request allows to set the request property with the appropriate payload.

func (*PutTransform) Timeout

func (r *PutTransform) Timeout(v string) *PutTransform

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 (*PutTransform) TransformId

func (r *PutTransform) TransformId(v string) *PutTransform

TransformId Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. API Name: transformid

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"`
	// 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"`
	// Latest The latest method transforms the data by finding the latest document for each
	// unique key.
	Latest *types.Latest `json:"latest,omitempty"`
	// Meta_ Defines optional transform metadata.
	Meta_ map[string]json.RawMessage `json:"_meta,omitempty"`
	// Pivot The pivot method transforms the data by aggregating and grouping it. These
	// objects define the group by fields
	// and the aggregation to reduce the data.
	Pivot *types.Pivot `json:"pivot,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"`
	// Sync Defines the properties transforms require to run continuously.
	Sync *types.SyncContainer `json:"sync,omitempty"`
}

Request holds the request body struct for the package puttransform

https://github.com/elastic/elasticsearch-specification/blob/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/transform/put_transform/PutTransformRequest.ts#L33-L122

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response