Documentation
¶
Overview ¶
Open a point in time that can be used in subsequent searches
Index ¶
- Variables
- type NewOpenPointInTime
- type OpenPointInTime
- func (r OpenPointInTime) Do(providedCtx context.Context) (*Response, error)
- func (r *OpenPointInTime) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *OpenPointInTime
- func (r *OpenPointInTime) Header(key, value string) *OpenPointInTime
- func (r *OpenPointInTime) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *OpenPointInTime) IgnoreUnavailable(ignoreunavailable bool) *OpenPointInTime
- func (r OpenPointInTime) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *OpenPointInTime) KeepAlive(duration string) *OpenPointInTime
- func (r OpenPointInTime) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *OpenPointInTime) Preference(preference string) *OpenPointInTime
- func (r *OpenPointInTime) Routing(routing string) *OpenPointInTime
- 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 NewOpenPointInTime ¶
type NewOpenPointInTime func(index string) *OpenPointInTime
NewOpenPointInTime type alias for index.
func NewOpenPointInTimeFunc ¶
func NewOpenPointInTimeFunc(tp elastictransport.Interface) NewOpenPointInTime
NewOpenPointInTimeFunc returns a new instance of OpenPointInTime with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type OpenPointInTime ¶
type OpenPointInTime struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *OpenPointInTime
Open a point in time that can be used in subsequent searches
https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
func (OpenPointInTime) Do ¶
func (r OpenPointInTime) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a openpointintime.Response
func (*OpenPointInTime) ExpandWildcards ¶ added in v8.7.0
func (r *OpenPointInTime) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *OpenPointInTime
ExpandWildcards Type of index that wildcard patterns 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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. API name: expand_wildcards
func (*OpenPointInTime) Header ¶
func (r *OpenPointInTime) Header(key, value string) *OpenPointInTime
Header set a key, value pair in the OpenPointInTime headers map.
func (*OpenPointInTime) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*OpenPointInTime) IgnoreUnavailable ¶
func (r *OpenPointInTime) IgnoreUnavailable(ignoreunavailable bool) *OpenPointInTime
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (OpenPointInTime) IsSuccess ¶
func (r OpenPointInTime) 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 (*OpenPointInTime) KeepAlive ¶
func (r *OpenPointInTime) KeepAlive(duration string) *OpenPointInTime
KeepAlive Extends the time to live of the corresponding point in time. API name: keep_alive
func (OpenPointInTime) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*OpenPointInTime) Preference ¶ added in v8.7.0
func (r *OpenPointInTime) Preference(preference string) *OpenPointInTime
Preference Specifies the node or shard the operation should be performed on. Random by default. API name: preference
func (*OpenPointInTime) Routing ¶ added in v8.7.0
func (r *OpenPointInTime) Routing(routing string) *OpenPointInTime
Routing Custom value used to route operations to a specific shard. API name: routing
Source Files