File: types.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.30.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 662,428 kB
  • sloc: java: 16,875; makefile: 432; sh: 175
file content (188 lines) | stat: -rw-r--r-- 5,186 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
)

// A container for facet information.
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

	noSmithyDocumentSerde
}

// A container for the calculated facet values and counts.
type BucketInfo struct {

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

	noSmithyDocumentSerde
}

// A warning returned by the document service when an issue is discovered while
// processing an upload request.
type DocumentServiceWarning struct {

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

	noSmithyDocumentSerde
}

// The statistics for a field calculated in the request.
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]: yyyy-mm-ddTHH:mm:ss.SSSZ.
	//
	// [IETF RFC3339]: http://tools.ietf.org/html/rfc3339
	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]: yyyy-mm-ddTHH:mm:ss.SSSZ.
	//
	// [IETF RFC3339]: http://tools.ietf.org/html/rfc3339
	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]: yyyy-mm-ddTHH:mm:ss.SSSZ.
	//
	// [IETF RFC3339]: http://tools.ietf.org/html/rfc3339
	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

	noSmithyDocumentSerde
}

// Information about a document that matches the search request.
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

	noSmithyDocumentSerde
}

// The collection of documents that match the search request.
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

	noSmithyDocumentSerde
}

// Contains the resource id ( rid ) and the time it took to process the request (
// timems ).
type SearchStatus struct {

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

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

	noSmithyDocumentSerde
}

// An autocomplete suggestion that matches the query string specified in a
// SuggestRequest .
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

	noSmithyDocumentSerde
}

// Container for the suggestion information returned in a SuggestResponse .
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

	noSmithyDocumentSerde
}

// Contains the resource id ( rid ) and the time it took to process the request (
// timems ).
type SuggestStatus struct {

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

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

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde