get

Documentation

Overview

Get a connector.

Get the details about a connector.

Index

• Variables
• type Get
  • func New(tp elastictransport.Interface) *Get
  • func (r Get) Do(providedCtx context.Context) (*Response, error)
  • func (r *Get) ErrorTrace(errortrace bool) *Get
  • func (r *Get) FilterPath(filterpaths ...string) *Get
  • func (r *Get) Header(key, value string) *Get
  • func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Get) Human(human bool) *Get
  • func (r Get) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Get) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Get) Pretty(pretty bool) *Get
• type NewGet
  • func NewGetFunc(tp elastictransport.Interface) NewGet
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) error

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.

Types

type Get

type Get struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *Get

Get a connector.

Get the details about a connector.

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-api.html

func (Get) Do

func (r Get) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a get.Response

func (*Get) ErrorTrace

func (r *Get) ErrorTrace(errortrace bool) *Get

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Get) FilterPath

func (r *Get) FilterPath(filterpaths ...string) *Get

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*Get) Header

func (r *Get) Header(key, value string) *Get

Header set a key, value pair in the Get headers map.

func (*Get) HttpRequest

func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Get) Human

func (r *Get) Human(human bool) *Get

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 (Get) IsSuccess

func (r Get) 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 (Get) Perform

func (r Get) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*Get) Pretty

func (r *Get) Pretty(pretty bool) *Get

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

type NewGet

type NewGet func(connectorid string) *Get

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.

type Response

type Response struct {
	ApiKeyId                         *string                         `json:"api_key_id,omitempty"`
	ApiKeySecretId                   *string                         `json:"api_key_secret_id,omitempty"`
	Configuration                    types.ConnectorConfiguration    `json:"configuration"`
	CustomScheduling                 types.ConnectorCustomScheduling `json:"custom_scheduling"`
	Description                      *string                         `json:"description,omitempty"`
	Error                            *string                         `json:"error,omitempty"`
	Features                         *types.ConnectorFeatures        `json:"features,omitempty"`
	Filtering                        []types.FilteringConfig         `json:"filtering"`
	Id                               *string                         `json:"id,omitempty"`
	IndexName                        *string                         `json:"index_name,omitempty"`
	IsNative                         bool                            `json:"is_native"`
	Language                         *string                         `json:"language,omitempty"`
	LastAccessControlSyncError       *string                         `json:"last_access_control_sync_error,omitempty"`
	LastAccessControlSyncScheduledAt types.DateTime                  `json:"last_access_control_sync_scheduled_at,omitempty"`
	LastAccessControlSyncStatus      *syncstatus.SyncStatus          `json:"last_access_control_sync_status,omitempty"`
	LastDeletedDocumentCount         *int64                          `json:"last_deleted_document_count,omitempty"`
	LastIncrementalSyncScheduledAt   types.DateTime                  `json:"last_incremental_sync_scheduled_at,omitempty"`
	LastIndexedDocumentCount         *int64                          `json:"last_indexed_document_count,omitempty"`
	LastSeen                         types.DateTime                  `json:"last_seen,omitempty"`
	LastSyncError                    *string                         `json:"last_sync_error,omitempty"`
	LastSyncScheduledAt              types.DateTime                  `json:"last_sync_scheduled_at,omitempty"`
	LastSyncStatus                   *syncstatus.SyncStatus          `json:"last_sync_status,omitempty"`
	LastSynced                       types.DateTime                  `json:"last_synced,omitempty"`
	Name                             *string                         `json:"name,omitempty"`
	Pipeline                         *types.IngestPipelineParams     `json:"pipeline,omitempty"`
	Scheduling                       types.SchedulingConfiguration   `json:"scheduling"`
	ServiceType                      *string                         `json:"service_type,omitempty"`
	Status                           connectorstatus.ConnectorStatus `json:"status"`
	SyncCursor                       json.RawMessage                 `json:"sync_cursor,omitempty"`
	SyncNow                          bool                            `json:"sync_now"`
}

Response holds the response body struct for the package get

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/connector/get/ConnectorGetResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

func (s *Response) UnmarshalJSON(data []byte) error