Documentation
¶
Overview ¶
Gets information about an enrich policy.
Index ¶
- Variables
- type GetPolicy
- func (r GetPolicy) Do(providedCtx context.Context) (*Response, error)
- func (r *GetPolicy) Header(key, value string) *GetPolicy
- func (r *GetPolicy) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetPolicy) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetPolicy) Name(name string) *GetPolicy
- func (r GetPolicy) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetPolicy
- 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 GetPolicy ¶
type GetPolicy struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetPolicy
Gets information about an enrich policy.
https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html
func (GetPolicy) Do ¶
Do runs the request through the transport, handle the response and returns a getpolicy.Response
func (*GetPolicy) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetPolicy) 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 NewGetPolicy ¶
type NewGetPolicy func() *GetPolicy
NewGetPolicy type alias for index.
func NewGetPolicyFunc ¶
func NewGetPolicyFunc(tp elastictransport.Interface) NewGetPolicy
NewGetPolicyFunc returns a new instance of GetPolicy with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files