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) Do(ctx context.Context) (*http.Response, error)
  • func (r *Explore) Header(key, value string) *Explore
  • func (r *Explore) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Explore) Index(v string) *Explore
  • func (r *Explore) Raw(raw json.RawMessage) *Explore
  • func (r *Explore) Request(req *Request) *Explore
  • func (r *Explore) Routing(value string) *Explore
  • func (r *Explore) Timeout(value string) *Explore
• type NewExplore
  • func NewExploreFunc(tp elastictransport.Interface) NewExplore
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Connections(connections *types.HopBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Controls(controls *types.ExploreControlsBuilder) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Query(query *types.QueryContainerBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Vertices(vertices []types.VertexDefinitionBuilder) *RequestBuilder

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) Do

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

Do runs the http.Request through the provided transport.

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) Index

func (r *Explore) Index(v string) *Explore

Index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices API Name: index

func (*Explore) Raw

func (r *Explore) Raw(raw json.RawMessage) *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(value string) *Explore

Routing Specific routing value API name: routing

func (*Explore) Timeout

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

Timeout Explicit operation timeout API name: timeout

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 *types.Hop `json:"connections,omitempty"`

	Controls *types.ExploreControls `json:"controls,omitempty"`

	Query *types.QueryContainer `json:"query,omitempty"`

	Vertices []types.VertexDefinition `json:"vertices,omitempty"`
}

Request holds the request body struct for the package explore

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/graph/explore/GraphExploreRequest.ts#L28-L47

type RequestBuilder

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

RequestBuilder is the builder API for the explore.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Connections

func (rb *RequestBuilder) Connections(connections *types.HopBuilder) *RequestBuilder

func (*RequestBuilder) Controls

func (rb *RequestBuilder) Controls(controls *types.ExploreControlsBuilder) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Query

func (rb *RequestBuilder) Query(query *types.QueryContainerBuilder) *RequestBuilder

func (*RequestBuilder) Vertices

func (rb *RequestBuilder) Vertices(vertices []types.VertexDefinitionBuilder) *RequestBuilder