v1

Documentation

Index

• Constants
• type Client
  • func New(searchReindexAPIURL, serviceToken string) *Client
  • func NewWithHealthClient(serviceToken string, hcCli *healthcheck.Client) (*Client, error)
  • func (cli *Client) Checker(ctx context.Context, check *health.CheckState) error
  • func (cli *Client) GetJob(ctx context.Context, reqheader client.Headers, jobID string) (*client.RespHeaders, *models.Job, error)
  • func (cli *Client) GetJobs(ctx context.Context, reqheader client.Headers, options client.Options) (*client.RespHeaders, *models.Jobs, error)
  • func (cli *Client) GetTask(ctx context.Context, reqHeaders client.Headers, jobID, taskName string) (*client.RespHeaders, *models.Task, error)
  • func (cli *Client) GetTasks(ctx context.Context, reqHeaders client.Headers, jobID string) (*client.RespHeaders, *models.Tasks, error)
  • func (cli *Client) Health() *healthcheck.Client
  • func (cli *Client) PatchJob(ctx context.Context, reqHeaders client.Headers, jobID string, ...) (*client.RespHeaders, error)
  • func (cli *Client) PostJob(ctx context.Context, reqHeaders client.Headers) (*client.RespHeaders, *models.Job, error)
  • func (cli *Client) PostTask(ctx context.Context, reqHeaders client.Headers, jobID string, ...) (*client.RespHeaders, *models.Task, error)
  • func (cli *Client) PutJobNumberOfTasks(ctx context.Context, reqHeaders client.Headers, jobID, numTasks string) (*client.RespHeaders, error)
  • func (cli *Client) PutTaskNumberOfDocs(ctx context.Context, reqHeaders client.Headers, ...) (*client.RespHeaders, error)
  • func (cli *Client) URL() string
  • func (cli *Client) ValidateOptions(option int) (validOption string, err error)

Constants

const (
	ETagHeader = "ETag"
)

Types

type Client

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

func New

func New(searchReindexAPIURL, serviceToken string) *Client

New creates a new instance of Client with a given search reindex api url

func NewWithHealthClient

func NewWithHealthClient(serviceToken string, hcCli *healthcheck.Client) (*Client, error)

NewWithHealthClient creates a new instance of SearchReindexAPI Client, reusing the URL and Clienter from the provided healthcheck client

func (*Client) Checker

func (cli *Client) Checker(ctx context.Context, check *health.CheckState) error

Checker calls search reindex api health endpoint and returns a check object to the caller

func (*Client) GetJob

func (cli *Client) GetJob(ctx context.Context, reqheader client.Headers, jobID string) (*client.RespHeaders, *models.Job, error)

GetJob Get the specific search reindex job that has the id given in the path.

func (*Client) GetJobs

func (cli *Client) GetJobs(ctx context.Context, reqheader client.Headers, options client.Options) (*client.RespHeaders, *models.Jobs, error)

func (*Client) GetTask

func (cli *Client) GetTask(ctx context.Context, reqHeaders client.Headers, jobID, taskName string) (*client.RespHeaders, *models.Task, error)

GetTask Get a specific task for a given reindex job

func (*Client) GetTasks

func (cli *Client) GetTasks(ctx context.Context, reqHeaders client.Headers, jobID string) (*client.RespHeaders, *models.Tasks, error)

GetTasks Get all tasks for a given reindex job

func (*Client) Health

func (cli *Client) Health() *healthcheck.Client

Health returns the underlying Healthcheck Client for this search reindex API client

func (*Client) PatchJob

func (cli *Client) PatchJob(ctx context.Context, reqHeaders client.Headers, jobID string, patchList []client.PatchOperation) (*client.RespHeaders, error)

PatchJob applies the patch operations, provided in the body, to the job with id = jobID It returns the ETag from the response header

func (*Client) PostJob

func (cli *Client) PostJob(ctx context.Context, reqHeaders client.Headers) (*client.RespHeaders, *models.Job, error)

PostJob creates a new reindex job for processing

func (*Client) PostTask

func (cli *Client) PostTask(ctx context.Context, reqHeaders client.Headers, jobID string, taskToCreate models.TaskToCreate) (*client.RespHeaders, *models.Task, error)

PostTask creates or updates a task, for the job with id = jobID, containing the number of documents to be processed

func (*Client) PutJobNumberOfTasks

func (cli *Client) PutJobNumberOfTasks(ctx context.Context, reqHeaders client.Headers, jobID, numTasks string) (*client.RespHeaders, error)

PutJobNumberOfTasks updates the number of tasks field, with the provided count, for the job specified by the provided jobID.

func (*Client) PutTaskNumberOfDocs

func (cli *Client) PutTaskNumberOfDocs(ctx context.Context, reqHeaders client.Headers, jobID, taskName, docCount string) (*client.RespHeaders, error)

PutTaskNumberOfDocs updates the number of documents, with the provided count, for a task associated with the job specified by the jobID.

func (*Client) URL

func (cli *Client) URL() string

URL returns the URL used by this client

func (*Client) ValidateOptions

func (cli *Client) ValidateOptions(option int) (validOption string, err error)