Documentation
¶
Overview ¶
Returns the details about a search application.
Index ¶
- Variables
- type Get
- func (r Get) Do(providedCtx context.Context) (*Response, error)
- func (r *Get) Header(key, value string) *Get
- func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Get) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Get) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGet
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type Get ¶
type Get struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Get
Returns the details about a search application.
https://www.elastic.co/guide/en/elasticsearch/reference/current/get-search-application.html
func (Get) Do ¶
Do runs the request through the transport, handle the response and returns a get.Response
func (*Get) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
type NewGet ¶
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 struct {
// AnalyticsCollectionName Analytics collection associated to the Search Application.
AnalyticsCollectionName *string `json:"analytics_collection_name,omitempty"`
// Indices Indices that are part of the Search Application.
Indices []string `json:"indices"`
// Name Search Application name.
Name string `json:"name"`
// Template Search template to use on search operations.
Template *types.SearchApplicationTemplate `json:"template,omitempty"`
// UpdatedAtMillis Last time the Search Application was updated.
UpdatedAtMillis int64 `json:"updated_at_millis"`
}
Response holds the response body struct for the package get