types

package
v0.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 17, 2020 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Bucket

type Bucket struct {

	// The number of hits that contain the facet value in the specified facet field.
	Count *int64

	// The facet value being counted.
	Value *string
}

A container for facet information.

type BucketInfo

type BucketInfo struct {

	// A list of the calculated facet values and counts.
	Buckets []*Bucket
}

A container for the calculated facet values and counts.

type ContentType

type ContentType string
const (
	ContentTypeApplicationJson ContentType = "application/json"
	ContentTypeApplicationXml  ContentType = "application/xml"
)

Enum values for ContentType

type DocumentServiceException

type DocumentServiceException struct {
	Message *string

	Status *string
}

Information about any problems encountered while processing an upload request.

func (*DocumentServiceException) Error

func (e *DocumentServiceException) Error() string

func (*DocumentServiceException) ErrorCode

func (e *DocumentServiceException) ErrorCode() string

func (*DocumentServiceException) ErrorFault

func (e *DocumentServiceException) ErrorFault() smithy.ErrorFault

func (*DocumentServiceException) ErrorMessage

func (e *DocumentServiceException) ErrorMessage() string

type DocumentServiceWarning

type DocumentServiceWarning struct {

	// The description for a warning returned by the document service.
	Message *string
}

A warning returned by the document service when an issue is discovered while processing an upload request.

type FieldStats

type FieldStats struct {

	// The number of documents that contain a value in the specified field in the
	// result set.
	Count *int64

	// The maximum value found in the specified field in the result set. If the field
	// is numeric (int, int-array, double, or double-array), max is the string
	// representation of a double-precision 64-bit floating point value. If the field
	// is date or date-array, max is the string representation of a date with the
	// format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339):
	// yyyy-mm-ddTHH:mm:ss.SSSZ.
	Max *string

	// The average of the values found in the specified field in the result set. If the
	// field is numeric (int, int-array, double, or double-array), mean is the string
	// representation of a double-precision 64-bit floating point value. If the field
	// is date or date-array, mean is the string representation of a date with the
	// format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339):
	// yyyy-mm-ddTHH:mm:ss.SSSZ.
	Mean *string

	// The minimum value found in the specified field in the result set. If the field
	// is numeric (int, int-array, double, or double-array), min is the string
	// representation of a double-precision 64-bit floating point value. If the field
	// is date or date-array, min is the string representation of a date with the
	// format specified in IETF RFC3339 (http://tools.ietf.org/html/rfc3339):
	// yyyy-mm-ddTHH:mm:ss.SSSZ.
	Min *string

	// The number of documents that do not contain a value in the specified field in
	// the result set.
	Missing *int64

	// The standard deviation of the values in the specified field in the result set.
	Stddev *float64

	// The sum of the field values across the documents in the result set. null for
	// date fields.
	Sum *float64

	// The sum of all field values in the result set squared.
	SumOfSquares *float64
}

The statistics for a field calculated in the request.

type Hit

type Hit struct {

	// The expressions returned from a document that matches the search request.
	Exprs map[string]*string

	// The fields returned from a document that matches the search request.
	Fields map[string][]*string

	// The highlights returned from a document that matches the search request.
	Highlights map[string]*string

	// The document ID of a document that matches the search request.
	Id *string
}

Information about a document that matches the search request.

type Hits

type Hits struct {

	// A cursor that can be used to retrieve the next set of matching documents when
	// you want to page through a large result set.
	Cursor *string

	// The total number of documents that match the search request.
	Found *int64

	// A document that matches the search request.
	Hit []*Hit

	// The index of the first matching document.
	Start *int64
}

The collection of documents that match the search request.

type QueryParser

type QueryParser string
const (
	QueryParserSimple     QueryParser = "simple"
	QueryParserStructured QueryParser = "structured"
	QueryParserLucene     QueryParser = "lucene"
	QueryParserDismax     QueryParser = "dismax"
)

Enum values for QueryParser

type SearchException

type SearchException struct {
	Message *string
}

Information about any problems encountered while processing a search request.

func (*SearchException) Error

func (e *SearchException) Error() string

func (*SearchException) ErrorCode

func (e *SearchException) ErrorCode() string

func (*SearchException) ErrorFault

func (e *SearchException) ErrorFault() smithy.ErrorFault

func (*SearchException) ErrorMessage

func (e *SearchException) ErrorMessage() string

type SearchStatus

type SearchStatus struct {

	// The encrypted resource ID for the request.
	Rid *string

	// How long it took to process the request, in milliseconds.
	Timems *int64
}

Contains the resource id (rid) and the time it took to process the request (timems).

type SuggestModel

type SuggestModel struct {

	// The number of documents that were found to match the query string.
	Found *int64

	// The query string specified in the suggest request.
	Query *string

	// The documents that match the query string.
	Suggestions []*SuggestionMatch
}

Container for the suggestion information returned in a SuggestResponse.

type SuggestStatus

type SuggestStatus struct {

	// The encrypted resource ID for the request.
	Rid *string

	// How long it took to process the request, in milliseconds.
	Timems *int64
}

Contains the resource id (rid) and the time it took to process the request (timems).

type SuggestionMatch

type SuggestionMatch struct {

	// The document ID of the suggested document.
	Id *string

	// The relevance score of a suggested match.
	Score *int64

	// The string that matches the query string specified in the SuggestRequest.
	Suggestion *string
}

An autocomplete suggestion that matches the query string specified in a SuggestRequest.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL