typedapi/ccr/follow/follow.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

// Code generated from the elasticsearch-specification DO NOT EDIT.
// https://github.com/elastic/elasticsearch-specification/tree/cbfcc73d01310bed2a480ec35aaef98138b598e5

// Create a follower.
// Create a cross-cluster replication follower index that follows a specific
// leader index.
// When the API returns, the follower index exists and cross-cluster replication
// starts replicating operations from the leader index to the follower index.
package follow

import (
	gobytes "bytes"
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"net/http"
	"net/url"
	"strconv"
	"strings"

	"github.com/elastic/elastic-transport-go/v8/elastictransport"
	"github.com/elastic/go-elasticsearch/v9/typedapi/types"
)

const (
	indexMask = iota + 1
)

// ErrBuildPath is returned in case of missing parameters within the build of the request.
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

type Follow struct {
	transport elastictransport.Interface

	headers http.Header
	values  url.Values
	path    url.URL

	raw io.Reader

	req      *Request
	deferred []func(request *Request) error
	buf      *gobytes.Buffer

	paramSet int

	index string

	spanStarted bool

	instrument elastictransport.Instrumentation
}

// NewFollow type alias for index.
type NewFollow func(index string) *Follow

// NewFollowFunc returns a new instance of Follow with the provided transport.
// Used in the index of the library this allows to retrieve every apis in once place.
func NewFollowFunc(tp elastictransport.Interface) NewFollow {
	return func(index string) *Follow {
		n := New(tp)

		n._index(index)

		return n
	}
}

// Create a follower.
// Create a cross-cluster replication follower index that follows a specific
// leader index.
// When the API returns, the follower index exists and cross-cluster replication
// starts replicating operations from the leader index to the follower index.
//
// https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ccr-follow
func New(tp elastictransport.Interface) *Follow {
	r := &Follow{
		transport: tp,
		values:    make(url.Values),
		headers:   make(http.Header),

		buf: gobytes.NewBuffer(nil),
	}

	if instrumented, ok := r.transport.(elastictransport.Instrumented); ok {
		if instrument := instrumented.InstrumentationEnabled(); instrument != nil {
			r.instrument = instrument
		}
	}

	return r
}

// Raw takes a json payload as input which is then passed to the http.Request
// If specified Raw takes precedence on Request method.
func (r *Follow) Raw(raw io.Reader) *Follow {
	r.raw = raw

	return r
}

// Request allows to set the request property with the appropriate payload.
func (r *Follow) Request(req *Request) *Follow {
	r.req = req

	return r
}

// HttpRequest returns the http.Request object built from the
// given parameters.
func (r *Follow) HttpRequest(ctx context.Context) (*http.Request, error) {
	var path strings.Builder
	var method string
	var req *http.Request

	var err error

	if len(r.deferred) > 0 {
		for _, f := range r.deferred {
			deferredErr := f(r.req)
			if deferredErr != nil {
				return nil, deferredErr
			}
		}
	}

	if r.raw == nil && r.req != nil {

		data, err := json.Marshal(r.req)

		if err != nil {
			return nil, fmt.Errorf("could not serialise request for Follow: %w", err)
		}

		r.buf.Write(data)

	}

	if r.buf.Len() > 0 {
		r.raw = r.buf
	}

	r.path.Scheme = "http"

	switch {
	case r.paramSet == indexMask:
		path.WriteString("/")

		if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
			instrument.RecordPathPart(ctx, "index", r.index)
		}
		path.WriteString(r.index)
		path.WriteString("/")
		path.WriteString("_ccr")
		path.WriteString("/")
		path.WriteString("follow")

		method = http.MethodPut
	}

	r.path.Path = path.String()
	r.path.RawQuery = r.values.Encode()

	if r.path.Path == "" {
		return nil, ErrBuildPath
	}

	if ctx != nil {
		req, err = http.NewRequestWithContext(ctx, method, r.path.String(), r.raw)
	} else {
		req, err = http.NewRequest(method, r.path.String(), r.raw)
	}

	req.Header = r.headers.Clone()

	if req.Header.Get("Content-Type") == "" {
		if r.raw != nil {
			req.Header.Set("Content-Type", "application/vnd.elasticsearch+json;compatible-with=9")
		}
	}

	if req.Header.Get("Accept") == "" {
		req.Header.Set("Accept", "application/vnd.elasticsearch+json;compatible-with=9")
	}

	if err != nil {
		return req, fmt.Errorf("could not build http.Request: %w", err)
	}

	return req, nil
}

// Perform runs the http.Request through the provided transport and returns an http.Response.
func (r Follow) Perform(providedCtx context.Context) (*http.Response, error) {
	var ctx context.Context
	if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
		if r.spanStarted == false {
			ctx := instrument.Start(providedCtx, "ccr.follow")
			defer instrument.Close(ctx)
		}
	}
	if ctx == nil {
		ctx = providedCtx
	}

	req, err := r.HttpRequest(ctx)
	if err != nil {
		if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
			instrument.RecordError(ctx, err)
		}
		return nil, err
	}

	if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
		instrument.BeforeRequest(req, "ccr.follow")
		if reader := instrument.RecordRequestBody(ctx, "ccr.follow", r.raw); reader != nil {
			req.Body = reader
		}
	}
	res, err := r.transport.Perform(req)
	if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
		instrument.AfterRequest(req, "elasticsearch", "ccr.follow")
	}
	if err != nil {
		localErr := fmt.Errorf("an error happened during the Follow query execution: %w", err)
		if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
			instrument.RecordError(ctx, localErr)
		}
		return nil, localErr
	}

	return res, nil
}

// Do runs the request through the transport, handle the response and returns a follow.Response
func (r Follow) Do(providedCtx context.Context) (*Response, error) {
	var ctx context.Context
	r.spanStarted = true
	if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
		ctx = instrument.Start(providedCtx, "ccr.follow")
		defer instrument.Close(ctx)
	}
	if ctx == nil {
		ctx = providedCtx
	}

	response := NewResponse()

	res, err := r.Perform(ctx)
	if err != nil {
		if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
			instrument.RecordError(ctx, err)
		}
		return nil, err
	}
	defer res.Body.Close()

	if res.StatusCode < 299 {
		err = json.NewDecoder(res.Body).Decode(response)
		if err != nil {
			if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
				instrument.RecordError(ctx, err)
			}
			return nil, err
		}

		return response, nil
	}

	errorResponse := types.NewElasticsearchError()
	err = json.NewDecoder(res.Body).Decode(errorResponse)
	if err != nil {
		if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
			instrument.RecordError(ctx, err)
		}
		return nil, err
	}

	if errorResponse.Status == 0 {
		errorResponse.Status = res.StatusCode
	}

	if instrument, ok := r.instrument.(elastictransport.Instrumentation); ok {
		instrument.RecordError(ctx, errorResponse)
	}
	return nil, errorResponse
}

// Header set a key, value pair in the Follow headers map.
func (r *Follow) Header(key, value string) *Follow {
	r.headers.Set(key, value)

	return r
}

// Index The name of the follower index.
// API Name: index
func (r *Follow) _index(index string) *Follow {
	r.paramSet |= indexMask
	r.index = index

	return r
}

// MasterTimeout Period to wait for a connection to the master node.
// API name: master_timeout
func (r *Follow) MasterTimeout(duration string) *Follow {
	r.values.Set("master_timeout", duration)

	return r
}

// WaitForActiveShards Specifies the number of shards to wait on being active before responding.
// This defaults to waiting on none of the shards to be
// active.
// A shard must be restored from the leader index before being active. Restoring
// a follower shard requires transferring all the
// remote Lucene segment files to the follower index.
// API name: wait_for_active_shards
func (r *Follow) WaitForActiveShards(waitforactiveshards string) *Follow {
	r.values.Set("wait_for_active_shards", waitforactiveshards)

	return r
}

// ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors
// when they occur.
// API name: error_trace
func (r *Follow) ErrorTrace(errortrace bool) *Follow {
	r.values.Set("error_trace", strconv.FormatBool(errortrace))

	return r
}

// FilterPath Comma-separated list of filters in dot notation which reduce the response
// returned by Elasticsearch.
// API name: filter_path
func (r *Follow) FilterPath(filterpaths ...string) *Follow {
	tmp := []string{}
	for _, item := range filterpaths {
		tmp = append(tmp, fmt.Sprintf("%v", item))
	}
	r.values.Set("filter_path", strings.Join(tmp, ","))

	return r
}

// Human When set to `true` will return statistics in a format suitable for humans.
// For example `"exists_time": "1h"` for humans and
// `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
// readable values will be omitted. This makes sense for responses being
// consumed
// only by machines.
// API name: human
func (r *Follow) Human(human bool) *Follow {
	r.values.Set("human", strconv.FormatBool(human))

	return r
}

// Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
// this option for debugging only.
// API name: pretty
func (r *Follow) Pretty(pretty bool) *Follow {
	r.values.Set("pretty", strconv.FormatBool(pretty))

	return r
}

// If the leader index is part of a data stream, the name to which the local
// data stream for the followed index should be renamed.
// API name: data_stream_name
func (r *Follow) DataStreamName(datastreamname string) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.DataStreamName = &datastreamname

	return r
}

// The name of the index in the leader cluster to follow.
// API name: leader_index
func (r *Follow) LeaderIndex(indexname string) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.LeaderIndex = indexname

	return r
}

// The maximum number of outstanding reads requests from the remote cluster.
// API name: max_outstanding_read_requests
func (r *Follow) MaxOutstandingReadRequests(maxoutstandingreadrequests int64) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.MaxOutstandingReadRequests = &maxoutstandingreadrequests

	return r
}

// The maximum number of outstanding write requests on the follower.
// API name: max_outstanding_write_requests
func (r *Follow) MaxOutstandingWriteRequests(maxoutstandingwriterequests int) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.MaxOutstandingWriteRequests = &maxoutstandingwriterequests

	return r
}

// The maximum number of operations to pull per read from the remote cluster.
// API name: max_read_request_operation_count
func (r *Follow) MaxReadRequestOperationCount(maxreadrequestoperationcount int) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.MaxReadRequestOperationCount = &maxreadrequestoperationcount

	return r
}

// The maximum size in bytes of per read of a batch of operations pulled from
// the remote cluster.
// API name: max_read_request_size
func (r *Follow) MaxReadRequestSize(bytesize types.ByteSizeVariant) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.MaxReadRequestSize = *bytesize.ByteSizeCaster()

	return r
}

// The maximum time to wait before retrying an operation that failed
// exceptionally. An exponential backoff strategy is employed when
// retrying.
// API name: max_retry_delay
func (r *Follow) MaxRetryDelay(duration types.DurationVariant) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.MaxRetryDelay = *duration.DurationCaster()

	return r
}

// The maximum number of operations that can be queued for writing. When this
// limit is reached, reads from the remote cluster will be
// deferred until the number of queued operations goes below the limit.
// API name: max_write_buffer_count
func (r *Follow) MaxWriteBufferCount(maxwritebuffercount int) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.MaxWriteBufferCount = &maxwritebuffercount

	return r
}

// The maximum total bytes of operations that can be queued for writing. When
// this limit is reached, reads from the remote cluster will
// be deferred until the total bytes of queued operations goes below the limit.
// API name: max_write_buffer_size
func (r *Follow) MaxWriteBufferSize(bytesize types.ByteSizeVariant) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.MaxWriteBufferSize = *bytesize.ByteSizeCaster()

	return r
}

// The maximum number of operations per bulk write request executed on the
// follower.
// API name: max_write_request_operation_count
func (r *Follow) MaxWriteRequestOperationCount(maxwriterequestoperationcount int) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.MaxWriteRequestOperationCount = &maxwriterequestoperationcount

	return r
}

// The maximum total bytes of operations per bulk write request executed on the
// follower.
// API name: max_write_request_size
func (r *Follow) MaxWriteRequestSize(bytesize types.ByteSizeVariant) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.MaxWriteRequestSize = *bytesize.ByteSizeCaster()

	return r
}

// The maximum time to wait for new operations on the remote cluster when the
// follower index is synchronized with the leader index.
// When the timeout has elapsed, the poll for operations will return to the
// follower so that it can update some statistics.
// Then the follower will immediately attempt to read from the leader again.
// API name: read_poll_timeout
func (r *Follow) ReadPollTimeout(duration types.DurationVariant) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.ReadPollTimeout = *duration.DurationCaster()

	return r
}

// The remote cluster containing the leader index.
// API name: remote_cluster
func (r *Follow) RemoteCluster(remotecluster string) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.RemoteCluster = remotecluster

	return r
}

// Settings to override from the leader index.
// API name: settings
func (r *Follow) Settings(settings types.IndexSettingsVariant) *Follow {
	// Initialize the request if it is not already initialized
	if r.req == nil {
		r.req = NewRequest()
	}

	r.req.Settings = settings.IndexSettingsCaster()

	return r
}