Documentation
¶
Overview ¶
Schedules now a transform.
Index ¶
- Variables
- type NewScheduleNowTransform
- type Response
- type ScheduleNowTransform
- func (r ScheduleNowTransform) Do(providedCtx context.Context) (*Response, error)
- func (r *ScheduleNowTransform) Header(key, value string) *ScheduleNowTransform
- func (r *ScheduleNowTransform) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r ScheduleNowTransform) IsSuccess(providedCtx context.Context) (bool, error)
- func (r ScheduleNowTransform) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ScheduleNowTransform) Timeout(duration string) *ScheduleNowTransform
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 NewScheduleNowTransform ¶
type NewScheduleNowTransform func(transformid string) *ScheduleNowTransform
NewScheduleNowTransform type alias for index.
func NewScheduleNowTransformFunc ¶
func NewScheduleNowTransformFunc(tp elastictransport.Interface) NewScheduleNowTransform
NewScheduleNowTransformFunc returns a new instance of ScheduleNowTransform 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 {
// Acknowledged For a successful response, this value is always true. On failure, an
// exception is returned instead.
Acknowledged bool `json:"acknowledged"`
}
Response holds the response body struct for the package schedulenowtransform
type ScheduleNowTransform ¶
type ScheduleNowTransform struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ScheduleNowTransform
Schedules now a transform.
https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html
func (ScheduleNowTransform) Do ¶
func (r ScheduleNowTransform) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a schedulenowtransform.Response
func (*ScheduleNowTransform) Header ¶
func (r *ScheduleNowTransform) Header(key, value string) *ScheduleNowTransform
Header set a key, value pair in the ScheduleNowTransform headers map.
func (*ScheduleNowTransform) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (ScheduleNowTransform) IsSuccess ¶
func (r ScheduleNowTransform) IsSuccess(providedCtx 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 (ScheduleNowTransform) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ScheduleNowTransform) Timeout ¶
func (r *ScheduleNowTransform) Timeout(duration string) *ScheduleNowTransform
Timeout Controls the time to wait for the scheduling to take place API name: timeout
Source Files