Documentation ¶
Overview ¶
Returns the details about a query ruleset.
Index ¶
- Variables
- type Get
- func (r Get) Do(ctx 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(ctx context.Context) (bool, error)
- func (r Get) Perform(ctx context.Context) (*http.Response, error)
- func (r *Get) RulesetId(rulesetid string) *Get
- 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 query ruleset.
https://www.elastic.co/guide/en/elasticsearch/reference/master/get-query-ruleset.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.
func (Get) IsSuccess ¶
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.
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.