Documentation ¶
Overview ¶
Get a connector sync job.
Index ¶
- Variables
- type NewSyncJobGet
- type Response
- type SyncJobGet
- func (r SyncJobGet) Do(providedCtx context.Context) (*Response, error)
- func (r *SyncJobGet) ErrorTrace(errortrace bool) *SyncJobGet
- func (r *SyncJobGet) FilterPath(filterpaths ...string) *SyncJobGet
- func (r *SyncJobGet) Header(key, value string) *SyncJobGet
- func (r *SyncJobGet) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *SyncJobGet) Human(human bool) *SyncJobGet
- func (r SyncJobGet) IsSuccess(providedCtx context.Context) (bool, error)
- func (r SyncJobGet) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *SyncJobGet) Pretty(pretty bool) *SyncJobGet
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 NewSyncJobGet ¶
type NewSyncJobGet func(connectorsyncjobid string) *SyncJobGet
NewSyncJobGet type alias for index.
func NewSyncJobGetFunc ¶
func NewSyncJobGetFunc(tp elastictransport.Interface) NewSyncJobGet
NewSyncJobGetFunc returns a new instance of SyncJobGet 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 { CancelationRequestedAt types.DateTime `json:"cancelation_requested_at,omitempty"` CanceledAt types.DateTime `json:"canceled_at,omitempty"` CompletedAt types.DateTime `json:"completed_at,omitempty"` Connector types.SyncJobConnectorReference `json:"connector"` CreatedAt types.DateTime `json:"created_at"` DeletedDocumentCount int64 `json:"deleted_document_count"` Error *string `json:"error,omitempty"` Id string `json:"id"` IndexedDocumentCount int64 `json:"indexed_document_count"` IndexedDocumentVolume int64 `json:"indexed_document_volume"` JobType syncjobtype.SyncJobType `json:"job_type"` LastSeen types.DateTime `json:"last_seen,omitempty"` Metadata map[string]json.RawMessage `json:"metadata"` StartedAt types.DateTime `json:"started_at,omitempty"` Status syncstatus.SyncStatus `json:"status"` TotalDocumentCount int64 `json:"total_document_count"` TriggerMethod syncjobtriggermethod.SyncJobTriggerMethod `json:"trigger_method"` WorkerHostname *string `json:"worker_hostname,omitempty"` }
Response holds the response body struct for the package syncjobget
func (*Response) UnmarshalJSON ¶
type SyncJobGet ¶
type SyncJobGet struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *SyncJobGet
Get a connector sync job.
https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-sync-job-api.html
func (SyncJobGet) Do ¶
func (r SyncJobGet) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a syncjobget.Response
func (*SyncJobGet) ErrorTrace ¶
func (r *SyncJobGet) ErrorTrace(errortrace bool) *SyncJobGet
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*SyncJobGet) FilterPath ¶
func (r *SyncJobGet) FilterPath(filterpaths ...string) *SyncJobGet
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*SyncJobGet) Header ¶
func (r *SyncJobGet) Header(key, value string) *SyncJobGet
Header set a key, value pair in the SyncJobGet headers map.
func (*SyncJobGet) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*SyncJobGet) Human ¶
func (r *SyncJobGet) Human(human bool) *SyncJobGet
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (SyncJobGet) IsSuccess ¶
func (r SyncJobGet) 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 (SyncJobGet) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*SyncJobGet) Pretty ¶
func (r *SyncJobGet) Pretty(pretty bool) *SyncJobGet
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty