get

Documentation

Overview

Returns information about one or more indices.

Index

• Variables
• type Get
  • func New(tp elastictransport.Interface) *Get
  • func (r *Get) AllowNoIndices(b bool) *Get
  • func (r Get) Do(ctx context.Context) (Response, error)
  • func (r *Get) ExpandWildcards(v string) *Get
  • func (r *Get) Features(v string) *Get
  • func (r *Get) FlatSettings(b bool) *Get
  • func (r *Get) Header(key, value string) *Get
  • func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Get) IgnoreUnavailable(b bool) *Get
  • func (r *Get) IncludeDefaults(b bool) *Get
  • func (r *Get) Index(v string) *Get
  • func (r Get) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Get) Local(b bool) *Get
  • func (r *Get) MasterTimeout(v string) *Get
  • func (r Get) Perform(ctx context.Context) (*http.Response, error)
• type NewGet
  • func NewGetFunc(tp elastictransport.Interface) NewGet
• 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 Get

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

func New

func New(tp elastictransport.Interface) *Get

Returns information about one or more indices.

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html

func (*Get) AllowNoIndices

func (r *Get) AllowNoIndices(b bool) *Get

AllowNoIndices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. API name: allow_no_indices

func (Get) Do

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

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

func (*Get) ExpandWildcards

func (r *Get) ExpandWildcards(v string) *Get

ExpandWildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. API name: expand_wildcards

func (*Get) Features

func (r *Get) Features(v string) *Get

Features Return only information on specified index features API name: features

func (*Get) FlatSettings

func (r *Get) FlatSettings(b bool) *Get

FlatSettings If true, returns settings in flat format. API name: flat_settings

func (*Get) Header

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

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

func (*Get) HttpRequest

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

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

func (*Get) IgnoreUnavailable

func (r *Get) IgnoreUnavailable(b bool) *Get

IgnoreUnavailable If false, requests that target a missing index return an error. API name: ignore_unavailable

func (*Get) IncludeDefaults

func (r *Get) IncludeDefaults(b bool) *Get

IncludeDefaults If true, return all default settings in the response. API name: include_defaults

func (*Get) Index

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

Index Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. API Name: index

func (Get) IsSuccess

func (r Get) IsSuccess(ctx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (*Get) Local

func (r *Get) Local(b bool) *Get

Local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. API name: local

func (*Get) MasterTimeout

func (r *Get) MasterTimeout(v string) *Get

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (Get) Perform

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

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

type NewGet

type NewGet func(index string) *Get

NewGet type alias for index.

func NewGetFunc

func NewGetFunc(tp elastictransport.Interface) NewGet

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

type Response

type Response map[string]types.IndexState

func NewResponse

func NewResponse() Response

NewResponse returns a Response