cloudsearchdomain

package module
v0.26.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const ServiceAPIVersion = "2013-01-01"
View Source 
const ServiceID = "CloudSearch Domain"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware 

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware 

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type Client 

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

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. <p>The endpoints for submitting <code>UploadDocuments</code>, <code>Search</code>, and <code>Suggest</code> requests are domain-specific and require the <code>--endpoint-url</code> option. To get the endpoints for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. The endpoints are also available on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.</p> <p>For more information, see the <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide">Amazon CloudSearch Developer Guide</a>.</p>

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) Search 

func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func(*Options)) (*SearchOutput, error)

Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:

  • simple: search all text and

text-array fields for the specified string. Search for phrases, individual terms, and prefixes.

  • structured: search specific fields, construct

compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.

  • lucene: specify search criteria using

the Apache Lucene query parser syntax.

  • dismax: specify search criteria

using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.

For more information, see Searching Your Data (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html) in the Amazon CloudSearch Developer Guide. The endpoint for submitting Search requests is domain-specific and requires the --endpoint-url option. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The endpoints are also available on the domain dashboard in the Amazon CloudSearch console.

func (*Client) Suggest 

func (c *Client) Suggest(ctx context.Context, params *SuggestInput, optFns ...func(*Options)) (*SuggestOutput, error)

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html) in the Amazon CloudSearch Developer Guide. <p>The endpoint for submitting <code>Suggest</code> requests is domain-specific and requires the <code>--endpoint-url</code> option. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. The endpoints are also available on the domain dashboard in the Amazon CloudSearch console.</p>

func (*Client) UploadDocuments 

func (c *Client) UploadDocuments(ctx context.Context, params *UploadDocumentsInput, optFns ...func(*Options)) (*UploadDocumentsOutput, error)

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. The endpoint for submitting UploadDocuments requests is domain-specific and requires the --endpoint-url option. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The endpoints are also available on the domain dashboard in the Amazon CloudSearch console. For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html) in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html) in the Amazon CloudSearch Developer Guide.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver 

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials 

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions 

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver 

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4 

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion 

func (o Options) GetRegion() string

func (Options) GetRetryer 

func (o Options) GetRetryer() retry.Retryer

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions 

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions 

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type SearchInput 

type SearchInput struct {

	// Specifies one or more fields for which to get statistics information. Each
	// specified field must be facet-enabled in the domain configuration. The fields
	// are specified in JSON using the form: {"FIELD-A":{},"FIELD-B":{}} There are
	// currently no options supported for statistics.
	Stats *string

	// Specifies the search criteria for the request. How you specify the search
	// criteria depends on the query parser used for the request and the parser options
	// specified in the queryOptions parameter. By default, the simple query parser is
	// used to process requests. To use the structured, lucene, or dismax query parser,
	// you must also specify the queryParser parameter. For more information about
	// specifying search criteria, see Searching Your Data
	// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html) in
	// the Amazon CloudSearch Developer Guide.
	//
	// This member is required.
	Query *string

	// Specifies which query parser to use to process the request. If queryParser is
	// not specified, Amazon CloudSearch uses the simple query parser. Amazon
	// CloudSearch supports four query parsers:
	//
	//     * simple: perform simple searches
	// of text and text-array fields. By default, the simple query parser searches all
	// text and text-array fields. You can specify which fields to search by with the
	// queryOptions parameter. If you prefix a search term with a plus sign (+)
	// documents must contain the term to be considered a match. (This is the default,
	// unless you configure the default operator with the queryOptions parameter.) You
	// can use the - (NOT), | (OR), and * (wildcard) operators to exclude particular
	// terms, find results that match any of the specified terms, or search for a
	// prefix. To search for a phrase rather than individual terms, enclose the phrase
	// in double quotes. For more information, see Searching for Text
	// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html)
	// in the Amazon CloudSearch Developer Guide.
	//
	//     * structured: perform advanced
	// searches by combining multiple expressions to define the search criteria. You
	// can also search within particular fields, search for values and ranges of
	// values, and use advanced options such as term boosting, matchall, and near. For
	// more information, see Constructing Compound Queries
	// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html)
	// in the Amazon CloudSearch Developer Guide.
	//
	//     * lucene: search using the
	// Apache Lucene query parser syntax. For more information, see Apache Lucene Query
	// Parser Syntax
	// (http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description).
	//
	//
	// * dismax: search using the simplified subset of the Apache Lucene query parser
	// syntax defined by the DisMax query parser. For more information, see DisMax
	// Query Parser Syntax
	// (http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax).
	//      </ul>
	QueryParser types.QueryParser

	// Specifies the offset of the first search hit you want to return. Note that the
	// result set is zero-based; the first result is at index 0. You can specify either
	// the start or cursor parameter in a request, they are mutually exclusive. For
	// more information, see Paginating Results
	// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html)
	// in the Amazon CloudSearch Developer Guide.
	Start *int64

	// Retrieves a cursor value you can use to page through large result sets. Use the
	// size parameter to control the number of hits to include in each response. You
	// can specify either the cursor or start parameter in a request; they are mutually
	// exclusive. To get the first cursor, set the cursor value to initial. In
	// subsequent requests, specify the cursor value returned in the hits section of
	// the response. For more information, see Paginating Results
	// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html)
	// in the Amazon CloudSearch Developer Guide.
	Cursor *string

	// Specifies the fields or custom expressions to use to sort the search results.
	// Multiple fields or expressions are specified as a comma-separated list. You must
	// specify the sort direction (asc or desc) for each field; for example, year
	// desc,title asc. To use a field to sort results, the field must be sort-enabled
	// in the domain configuration. Array type fields cannot be used for sorting. If no
	// sort parameter is specified, results are sorted by their default relevance
	// scores in descending order: _score desc. You can also sort by document ID (_id
	// asc) and version (_version desc). For more information, see Sorting Results
	// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html)
	// in the Amazon CloudSearch Developer Guide.
	Sort *string

	// Defines one or more numeric expressions that can be used to sort results or
	// specify search criteria. You can also specify expressions as return fields. You
	// specify the expressions in JSON using the form {"EXPRESSIONNAME":"EXPRESSION"}.
	// You can define and use multiple expressions in a search request. For example:
	// {"expression1":"_score*rating", "expression2":"(1/rank)*year"}  For information
	// about the variables, operators, and functions you can use in expressions, see
	// Writing Expressions
	// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions)
	// in the Amazon CloudSearch Developer Guide.
	Expr *string

	// Configures options for the query parser specified in the queryParser parameter.
	// You specify the options in JSON using the following form
	// {"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.
	//     <p>The options
	// you can configure vary according to which parser you use:</p> <ul>
	// <li><code>defaultOperator</code>: The default operator used to combine
	// individual terms in the search string. For example: <code>defaultOperator:
	// 'or'</code>. For the <code>dismax</code> parser, you specify a percentage that
	// represents the percentage of terms in the search string (rounded down) that must
	// match, rather than a default operator. A value of <code>0%</code> is the
	// equivalent to OR, and a value of <code>100%</code> is equivalent to AND. The
	// percentage must be specified as a value in the range 0-100 followed by the
	// percent (%) symbol. For example, <code>defaultOperator: 50%</code>. Valid
	// values: <code>and</code>, <code>or</code>, a percentage in the range 0%-100%
	// (<code>dismax</code>). Default: <code>and</code> (<code>simple</code>,
	// <code>structured</code>, <code>lucene</code>) or <code>100</code>
	// (<code>dismax</code>). Valid for: <code>simple</code>, <code>structured</code>,
	// <code>lucene</code>, and <code>dismax</code>.</li> <li><code>fields</code>: An
	// array of the fields to search when no fields are specified in a search. If no
	// fields are specified in a search and this option is not specified, all text and
	// text-array fields are searched. You can specify a weight for each field to
	// control the relative importance of each field when Amazon CloudSearch calculates
	// relevance scores. To specify a field weight, append a caret (<code>^</code>)
	// symbol and the weight to the field name. For example, to boost the importance of
	// the <code>title</code> field over the <code>description</code> field you could
	// specify: <code>"fields":["title^5","description"]</code>. Valid values: The name
	// of any configured field and an optional numeric value greater than zero.
	// Default: All <code>text</code> and <code>text-array</code> fields. Valid for:
	// <code>simple</code>, <code>structured</code>, <code>lucene</code>, and
	// <code>dismax</code>.</li> <li><code>operators</code>: An array of the operators
	// or special characters you want to disable for the simple query parser. If you
	// disable the <code>and</code>, <code>or</code>, or <code>not</code> operators,
	// the corresponding operators (<code>+</code>, <code>|</code>, <code>-</code>)
	// have no special meaning and are dropped from the search string. Similarly,
	// disabling <code>prefix</code> disables the wildcard operator (<code>*</code>)
	// and disabling <code>phrase</code> disables the ability to search for phrases by
	// enclosing phrases in double quotes. Disabling precedence disables the ability to
	// control order of precedence using parentheses. Disabling <code>near</code>
	// disables the ability to use the ~ operator to perform a sloppy phrase search.
	// Disabling the <code>fuzzy</code> operator disables the ability to use the ~
	// operator to perform a fuzzy search. <code>escape</code> disables the ability to
	// use a backslash (<code>\</code>) to escape special characters within the search
	// string. Disabling whitespace is an advanced option that prevents the parser from
	// tokenizing on whitespace, which can be useful for Vietnamese. (It prevents
	// Vietnamese words from being split incorrectly.) For example, you could disable
	// all operators other than the phrase operator to support just simple term and
	// phrase queries: <code>"operators":["and","not","or", "prefix"]</code>. Valid
	// values: <code>and</code>, <code>escape</code>, <code>fuzzy</code>,
	// <code>near</code>, <code>not</code>, <code>or</code>, <code>phrase</code>,
	// <code>precedence</code>, <code>prefix</code>, <code>whitespace</code>. Default:
	// All operators and special characters are enabled. Valid for:
	// <code>simple</code>.</li> <li><code>phraseFields</code>: An array of the
	// <code>text</code> or <code>text-array</code> fields you want to use for phrase
	// searches. When the terms in the search string appear in close proximity within a
	// field, the field scores higher. You can specify a weight for each field to boost
	// that score. The <code>phraseSlop</code> option controls how much the matches can
	// deviate from the search string and still be boosted. To specify a field weight,
	// append a caret (<code>^</code>) symbol and the weight to the field name. For
	// example, to boost phrase matches in the <code>title</code> field over the
	// <code>abstract</code> field, you could specify: <code>"phraseFields":["title^3",
	// "plot"]</code> Valid values: The name of any <code>text</code> or
	// <code>text-array</code> field and an optional numeric value greater than zero.
	// Default: No fields. If you don't specify any fields with
	// <code>phraseFields</code>, proximity scoring is disabled even if
	// <code>phraseSlop</code> is specified. Valid for: <code>dismax</code>.</li>
	// <li><code>phraseSlop</code>: An integer value that specifies how much matches
	// can deviate from the search phrase and still be boosted according to the weights
	// specified in the <code>phraseFields</code> option; for example,
	// <code>phraseSlop: 2</code>. You must also specify <code>phraseFields</code> to
	// enable proximity scoring. Valid values: positive integers. Default: 0. Valid
	// for: <code>dismax</code>.</li> <li><code>explicitPhraseSlop</code>: An integer
	// value that specifies how much a match can deviate from the search phrase when
	// the phrase is enclosed in double quotes in the search string. (Phrases that
	// exceed this proximity distance are not considered a match.) For example, to
	// specify a slop of three for dismax phrase queries, you would specify
	// <code>"explicitPhraseSlop":3</code>. Valid values: positive integers. Default:
	// 0. Valid for: <code>dismax</code>.</li> <li><code>tieBreaker</code>: When a term
	// in the search string is found in a document's field, a score is calculated for
	// that field based on how common the word is in that field compared to other
	// documents. If the term occurs in multiple fields within a document, by default
	// only the highest scoring field contributes to the document's overall score. You
	// can specify a <code>tieBreaker</code> value to enable the matches in
	// lower-scoring fields to contribute to the document's score. That way, if two
	// documents have the same max field score for a particular term, the score for the
	// document that has matches in more fields will be higher. The formula for
	// calculating the score with a tieBreaker is <code>(max field score) +
	// (tieBreaker) * (sum of the scores for the rest of the matching fields)</code>.
	// Set <code>tieBreaker</code> to 0 to disregard all but the highest scoring field
	// (pure max): <code>"tieBreaker":0</code>. Set to 1 to sum the scores from all
	// fields (pure sum): <code>"tieBreaker":1</code>. Valid values: 0.0 to 1.0.
	// Default: 0.0. Valid for: <code>dismax</code>. </li> </ul>
	QueryOptions *string

	// Specifies one or more fields for which to get facet information, and options
	// that control how the facet information is returned. Each specified field must be
	// facet-enabled in the domain configuration. The fields and options are specified
	// in JSON using the form
	// {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}.
	// You can specify the following faceting options:
	//
	//     * buckets specifies an
	// array of the facet values or ranges to count. Ranges are specified using the
	// same syntax that you use to search for a range of values. For more information,
	// see  Searching for a Range of Values
	// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html)
	// in the Amazon CloudSearch Developer Guide. Buckets are returned in the order
	// they are specified in the request. The sort and size options are not valid if
	// you specify buckets.
	//
	//     * size specifies the maximum number of facets to
	// include in the results. By default, Amazon CloudSearch returns counts for the
	// top 10. The size parameter is only valid when you specify the sort option; it
	// cannot be used in conjunction with buckets.
	//
	//     * sort specifies how you want
	// to sort the facets in the results: bucket or count. Specify bucket to sort
	// alphabetically or numerically by facet value (in ascending order). Specify count
	// to sort by the facet counts computed for each facet value (in descending order).
	// To retrieve facet counts for particular values or ranges of values, use the
	// buckets option instead of sort.
	//
	// If no facet options are specified, facet counts
	// are computed for all field values, the facets are sorted by facet count, and the
	// top 10 facets are returned in the results.  <p>To count particular buckets of
	// values, use the <code>buckets</code> option. For example, the following request
	// uses the <code>buckets</code> option to calculate and return facet counts by
	// decade.</p> <p><code>
	// {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}}
	// </code></p> <p>To sort facets by facet count, use the <code>count</code> option.
	// For example, the following request sets the <code>sort</code> option to
	// <code>count</code> to sort the facet values by facet count, with the facet
	// values that have the most matching documents listed first. Setting the
	// <code>size</code> option to 3 returns only the top three facet values.</p>
	// <p><code> {"year":{"sort":"count","size":3}} </code></p> <p>To sort the facets
	// by value, use the <code>bucket</code> option. For example, the following request
	// sets the <code>sort</code> option to <code>bucket</code> to sort the facet
	// values numerically by year, with earliest year listed first.</p> <p><code>
	// {"year":{"sort":"bucket"}} </code></p> <p>For more information, see <a
	// href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html">Getting
	// and Using Facet Information</a> in the <i>Amazon CloudSearch Developer
	// Guide</i>.</p>
	Facet *string

	// Specifies the maximum number of search hits to include in the response.
	Size *int64

	// Retrieves highlights for matches in the specified text or text-array fields.
	// Each specified field must be highlight enabled in the domain configuration. The
	// fields and options are specified in JSON using the form
	// {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}.
	// You can specify the following highlight options:
	//
	//     * format: specifies the
	// format of the data in the text field: text or html. When data is returned as
	// HTML, all non-alphanumeric characters are encoded. The default is html.
	//
	//     *
	// max_phrases: specifies the maximum number of occurrences of the search term(s)
	// you want to highlight. By default, the first occurrence is highlighted.
	//
	//     *
	// pre_tag: specifies the string to prepend to an occurrence of a search term. The
	// default for HTML highlights is <em>. The default for text highlights is *.
	//
	//
	// * post_tag: specifies the string to append to an occurrence of a search term.
	// The default for HTML highlights is </em>. The default for text highlights is
	// *.
	//
	// If no highlight options are specified for a field, the returned field text
	// is treated as HTML and the first match is highlighted with emphasis tags:
	// <em>search-term</em>. For example, the following request retrieves highlights
	// for the actors and title fields. { "actors": {}, "title": {"format":
	// "text","max_phrases": 2,"pre_tag": "","post_tag": ""} }
	Highlight *string

	// Specifies a structured query that filters the results of a search without
	// affecting how the results are scored and sorted. You use filterQuery in
	// conjunction with the query parameter to filter the documents that match the
	// constraints specified in the query parameter. Specifying a filter controls only
	// which matching documents are included in the results, it has no effect on how
	// they are scored and sorted. The filterQuery parameter supports the full
	// structured query syntax. For more information about using filters, see Filtering
	// Matching Documents
	// (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html)
	// in the Amazon CloudSearch Developer Guide.
	FilterQuery *string

	// Specifies the field and expression values to include in the response. Multiple
	// fields or expressions are specified as a comma-separated list. By default, a
	// search response includes all return enabled fields (_all_fields). To return only
	// the document IDs for the matching documents, specify _no_fields. To retrieve the
	// relevance score calculated for each document, specify _score.
	Return *string

	// Enables partial results to be returned if one or more index partitions are
	// unavailable. When your search index is partitioned across multiple search
	// instances, by default Amazon CloudSearch only returns results if every partition
	// can be queried. This means that the failure of a single search instance can
	// result in 5xx (internal server) errors. When you enable partial results, Amazon
	// CloudSearch returns whatever results are available and includes the percentage
	// of documents searched in the search results (percent-searched). This enables you
	// to more gracefully degrade your users' search experience. For example, rather
	// than displaying no results, you could display the partial results and a message
	// indicating that the results might be incomplete due to a temporary system
	// outage.
	Partial *bool
}

Container for the parameters to the Search request.

type SearchOutput 

type SearchOutput struct {

	// The requested facet information.
	Facets map[string]*types.BucketInfo

	// The requested field statistics information.
	Stats map[string]*types.FieldStats

	// The status information returned for the search request.
	Status *types.SearchStatus

	// The documents that match the search criteria.
	Hits *types.Hits

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.

type SuggestInput 

type SuggestInput struct {

	// Specifies the string for which you want to get suggestions.
	//
	// This member is required.
	Query *string

	// Specifies the maximum number of suggestions to return.
	Size *int64

	// Specifies the name of the suggester to use to find suggested matches.
	//
	// This member is required.
	Suggester *string
}

Container for the parameters to the Suggest request.

type SuggestOutput 

type SuggestOutput struct {

	// Container for the matching search suggestion information.
	Suggest *types.SuggestModel

	// The status of a SuggestRequest. Contains the resource ID (rid) and how long it
	// took to process the request (timems).
	Status *types.SuggestStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the response to a Suggest request.

type UploadDocumentsInput 

type UploadDocumentsInput struct {

	// A batch of documents formatted in JSON or HTML.
	//
	// This member is required.
	Documents io.Reader

	// The format of the batch you are uploading. Amazon CloudSearch supports two
	// document batch formats:
	//
	//     * application/json
	//
	//     * application/xml
	//
	// This member is required.
	ContentType types.ContentType
}

Container for the parameters to the UploadDocuments request.

type UploadDocumentsOutput 

type UploadDocumentsOutput struct {

	// Any warnings returned by the document service about the documents being
	// uploaded.
	Warnings []*types.DocumentServiceWarning

	// The status of an UploadDocumentsRequest.
	Status *string

	// The number of documents that were added to the search domain.
	Adds *int64

	// The number of documents that were deleted from the search domain.
	Deletes *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Contains the response to an UploadDocuments request.

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.