explore

Documentation

Overview

Explore extracted and summarized information about the documents and terms in an index.

Index

• Variables
• type Explore
  • func New(tp elastictransport.Interface) *Explore
  • func (r *Explore) Connections(connections *types.Hop) *Explore
  • func (r *Explore) Controls(controls *types.ExploreControls) *Explore
  • func (r Explore) Do(providedCtx context.Context) (*Response, error)
  • func (r *Explore) Header(key, value string) *Explore
  • func (r *Explore) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Explore) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Explore) Query(query *types.Query) *Explore
  • func (r *Explore) Raw(raw io.Reader) *Explore
  • func (r *Explore) Request(req *Request) *Explore
  • func (r *Explore) Routing(routing string) *Explore
  • func (r *Explore) Timeout(duration string) *Explore
  • func (r *Explore) Vertices(vertices ...types.VertexDefinition) *Explore
• type NewExplore
  • func NewExploreFunc(tp elastictransport.Interface) NewExplore
• 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 Explore

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

func New

func New(tp elastictransport.Interface) *Explore

Explore extracted and summarized information about the documents and terms in an index.

https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html

func (*Explore) Connections

func (r *Explore) Connections(connections *types.Hop) *Explore

Connections Specifies or more fields from which you want to extract terms that are associated with the specified vertices. API name: connections

func (*Explore) Controls

func (r *Explore) Controls(controls *types.ExploreControls) *Explore

Controls Direct the Graph API how to build the graph. API name: controls

func (Explore) Do

func (r Explore) Do(providedCtx context.Context) (*Response, error)

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

func (*Explore) Header

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

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

func (*Explore) HttpRequest

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

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

func (Explore) Perform

func (r Explore) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*Explore) Query

func (r *Explore) Query(query *types.Query) *Explore

Query A seed query that identifies the documents of interest. Can be any valid Elasticsearch query. API name: query

func (*Explore) Raw

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

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

func (*Explore) Request

func (r *Explore) Request(req *Request) *Explore

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

func (*Explore) Routing

func (r *Explore) Routing(routing string) *Explore

Routing Custom value used to route operations to a specific shard. API name: routing

func (*Explore) Timeout

func (r *Explore) Timeout(duration string) *Explore

Timeout Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. API name: timeout

func (*Explore) Vertices

func (r *Explore) Vertices(vertices ...types.VertexDefinition) *Explore

Vertices Specifies one or more fields that contain the terms you want to include in the graph as vertices. API name: vertices

type NewExplore

type NewExplore func(index string) *Explore

NewExplore type alias for index.

func NewExploreFunc

func NewExploreFunc(tp elastictransport.Interface) NewExplore

NewExploreFunc returns a new instance of Explore 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 {

	// Connections Specifies or more fields from which you want to extract terms that are
	// associated with the specified vertices.
	Connections *types.Hop `json:"connections,omitempty"`
	// Controls Direct the Graph API how to build the graph.
	Controls *types.ExploreControls `json:"controls,omitempty"`
	// Query A seed query that identifies the documents of interest. Can be any valid
	// Elasticsearch query.
	Query *types.Query `json:"query,omitempty"`
	// Vertices Specifies one or more fields that contain the terms you want to include in
	// the graph as vertices.
	Vertices []types.VertexDefinition `json:"vertices,omitempty"`
}

Request holds the request body struct for the package explore

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/graph/explore/GraphExploreRequest.ts#L28-L72

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 {
	Connections []types.Connection   `json:"connections"`
	Failures    []types.ShardFailure `json:"failures"`
	TimedOut    bool                 `json:"timed_out"`
	Took        int64                `json:"took"`
	Vertices    []types.Vertex       `json:"vertices"`
}

Response holds the response body struct for the package explore

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/graph/explore/GraphExploreResponse.ts#L25-L33

func NewResponse

func NewResponse() *Response

NewResponse returns a Response