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 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
|
// Package cloudsearch provides access to the Google Cloud Search API.
//
// Usage example:
//
// import "google.golang.org/api/cloudsearch/v1"
// ...
// cloudsearchService, err := cloudsearch.New(oauthHttpClient)
package cloudsearch
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"golang.org/x/net/context"
"google.golang.org/api/googleapi"
"io"
"net/http"
"net/url"
"strconv"
"strings"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Background
const apiId = "cloudsearch:v1"
const apiName = "cloudsearch"
const apiVersion = "v1"
const basePath = "https://cloudsearch.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// FOR TESTING ONLY
CloudsearchScope = "https://www.googleapis.com/auth/cloudsearch"
// View your email address
UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email"
)
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Projects = NewProjectsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Indexes = NewProjectsIndexesService(s)
return rs
}
type ProjectsService struct {
s *Service
Indexes *ProjectsIndexesService
}
func NewProjectsIndexesService(s *Service) *ProjectsIndexesService {
rs := &ProjectsIndexesService{s: s}
rs.Documents = NewProjectsIndexesDocumentsService(s)
return rs
}
type ProjectsIndexesService struct {
s *Service
Documents *ProjectsIndexesDocumentsService
}
func NewProjectsIndexesDocumentsService(s *Service) *ProjectsIndexesDocumentsService {
rs := &ProjectsIndexesDocumentsService{s: s}
return rs
}
type ProjectsIndexesDocumentsService struct {
s *Service
}
type Document struct {
// DocId: The unique identifier of the document. It must contain only
// visible, printable ASCII characters (ASCII codes 33 through 126
// inclusive) and be no longer than 500 characters. It cannot begin with
// an exclamation point ('!'), and it can't begin and end with double
// underscores ("__"). If missing, it is automatically assigned for the
// document.
DocId string `json:"docId,omitempty"`
// Fields: The list of fields in the document. It cannot be the empty
// list. Each field has a name and a list of values. The field name is
// unique to a document and is case sensitive. The name can only contain
// ASCII characters. It must start with a letter and can contain
// letters, digits, or underscore. It cannot be longer than 500
// characters and cannot be the empty string. A field can have multiple
// values with same or different types, however, it cannot have multiple
// Timestamp or number values.
Fields map[string]FieldValueList `json:"fields,omitempty"`
// Rank: A positive integer which determines the default ordering of
// documents returned from a search. The rank can be set explicitly when
// the document is created. It is a bad idea to assign the same rank to
// many documents, and the same rank should never be assigned to more
// than 10,000 documents. By default (when it is not specified or set to
// 0), it is set at the time the document is created to the number of
// seconds since January 1, 2011. The rank can be used in
// field_expressions, order_by or return_fields in a search request,
// where it is referenced as `_rank`.
Rank int64 `json:"rank,omitempty"`
}
type Empty struct {
}
type FieldNames struct {
// AtomFields: The names of fields in which ATOM values are stored.
AtomFields []string `json:"atomFields,omitempty"`
// DateFields: The names of fields in which DATE values are stored.
DateFields []string `json:"dateFields,omitempty"`
// GeoFields: The names of fields in which GEO values are stored.
GeoFields []string `json:"geoFields,omitempty"`
// HtmlFields: The names of fields in which HTML values are stored.
HtmlFields []string `json:"htmlFields,omitempty"`
// NumberFields: The names of fields in which NUMBER values are stored.
NumberFields []string `json:"numberFields,omitempty"`
// TextFields: The names of fields in which TEXT values are stored.
TextFields []string `json:"textFields,omitempty"`
}
type FieldValue struct {
// GeoValue: The value of a GEO-valued field, represented in string with
// any of the listed [ways of writing
// coordinates](http://en.wikipedia.org/wiki/Geographic_coordinate_conver
// sion#Ways_of_writing_coordinates)
GeoValue string `json:"geoValue,omitempty"`
// Lang: The language of a string value. If given, the language must be
// a valid `ISO 639-1` code.
Lang string `json:"lang,omitempty"`
// NumberValue: The value of a number-valued field.
NumberValue float64 `json:"numberValue,omitempty"`
// StringFormat: The format of a string value. By default, the string
// format is `DEFAULT`, where a format will be automatically detected.
//
// Possible values:
// "DEFAULT"
// "ATOM"
// "TEXT"
// "HTML"
StringFormat string `json:"stringFormat,omitempty"`
// StringValue: The value of a string-valued field.
StringValue string `json:"stringValue,omitempty"`
// TimestampValue: The value of a timestamp-valued field.
TimestampValue string `json:"timestampValue,omitempty"`
}
type FieldValueList struct {
// Values: The list of typed values.
Values []*FieldValue `json:"values,omitempty"`
}
type IndexInfo struct {
// IndexId: The index identifier. It cannot be the empty string. It must
// contain only visible, printable ASCII characters (ASCII codes 33
// through 126 inclusive) and be no longer than 100 characters. It
// cannot begin with an exclamation point ('!'), and it can't begin and
// end with double underscores ("__").
IndexId string `json:"indexId,omitempty"`
// IndexedField: Names of indexed fields.
IndexedField *FieldNames `json:"indexedField,omitempty"`
// ProjectId: The project associated with the index. It cannot be the
// empty string.
ProjectId string `json:"projectId,omitempty"`
}
type ListDocumentsResponse struct {
// Documents: The list of documents.
Documents []*Document `json:"documents,omitempty"`
// NextPageToken: If there are more results, retrieve them by invoking
// list documents call with the same arguments and this `nextPageToken`.
// If there are no more results, this field is not set.
NextPageToken string `json:"nextPageToken,omitempty"`
}
type ListIndexesResponse struct {
// Indexes: The information about available indexes.
Indexes []*IndexInfo `json:"indexes,omitempty"`
// NextPageToken: If there are more results, retrieve them by invoking
// list indexes call with the same arguments and this `nextPageToken`.
// If there are no more results, this field is not set.
NextPageToken string `json:"nextPageToken,omitempty"`
}
type SearchResponse struct {
// MatchedCount: The number of documents that match the query. It is
// greater than or equal to the number of documents actually returned.
// This is an approximation and not an exact count unless it is less
// than or equal to `matchedCountAccuracy` in search parameter.
MatchedCount int64 `json:"matchedCount,omitempty,string"`
// Results: The list of documents that match the search query.
Results []*SearchResult `json:"results,omitempty"`
}
type SearchResult struct {
// DocId: The unique identifier of the document.
DocId string `json:"docId,omitempty"`
// Fields: The list of fields in the result. Each field is either from
// the stored document, the built-in fields (`_rank`, the document rank,
// and `_score` if scoring is enabled), or computed from any extra
// `fieldExpressions` defined in the request. For example, if a request
// contains a `fieldExpressions` named "TotalPrice" and expressed as
// "Price + Tax", the result will have a field whose name is
// "TotalPrice" and whose value is set to the computed sum of the
// value of field "Price" and the value of field "Tax". If a request
// contains a `fieldExpressions` named "snippet" and expressed as
// "snippet(\"good times\", content)", the result will have a field
// whose name is "snippet" and whose value contains a snippet of text
// from field "content" matching the query "good times".
Fields map[string]FieldValueList `json:"fields,omitempty"`
// NextPageToken: If there are more results, retrieve them by invoking
// search call with the same arguments and this `nextPageToken`. If
// there are no more results, this field is not set.
NextPageToken string `json:"nextPageToken,omitempty"`
}
// method id "cloudsearch.projects.indexes.list":
type ProjectsIndexesListCall struct {
s *Service
projectId string
indexNamePrefix string
pageSize int64
pageToken string
view string
opt_ map[string]interface{}
}
// List: Lists search indexes belonging to the specified project.
func (r *ProjectsIndexesService) List(projectId string, indexNamePrefix string, pageSize int64, pageToken string, view string) *ProjectsIndexesListCall {
c := &ProjectsIndexesListCall{s: r.s, opt_: make(map[string]interface{})}
c.projectId = projectId
c.indexNamePrefix = indexNamePrefix
c.pageSize = pageSize
c.pageToken = pageToken
c.view = view
return c
}
// IndexNamePrefix sets the optional parameter "indexNamePrefix": The
// prefix of the index name. It is used to list all indexes with names
// that have this prefix.
func (c *ProjectsIndexesListCall) IndexNamePrefix(indexNamePrefix string) *ProjectsIndexesListCall {
c.opt_["indexNamePrefix"] = indexNamePrefix
return c
}
// PageSize sets the optional parameter "pageSize": The maximum number
// of indexes to return per page. If not specified, 100 indexes are
// returned per page.
func (c *ProjectsIndexesListCall) PageSize(pageSize int64) *ProjectsIndexesListCall {
c.opt_["pageSize"] = pageSize
return c
}
// PageToken sets the optional parameter "pageToken": A `nextPageToken`
// returned from previous list indexes call as the starting point for
// this call. If not specified, list indexes from the beginning.
func (c *ProjectsIndexesListCall) PageToken(pageToken string) *ProjectsIndexesListCall {
c.opt_["pageToken"] = pageToken
return c
}
// View sets the optional parameter "view": Specifies which parts of the
// IndexInfo resource is returned in the response. If not specified,
// `ID_ONLY` is used.
//
// Possible values:
// "INDEX_VIEW_UNSPECIFIED"
// "ID_ONLY"
// "FULL"
func (c *ProjectsIndexesListCall) View(view string) *ProjectsIndexesListCall {
c.opt_["view"] = view
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ProjectsIndexesListCall) Fields(s ...googleapi.Field) *ProjectsIndexesListCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *ProjectsIndexesListCall) Do() (*ListIndexesResponse, error) {
var body io.Reader = nil
params := make(url.Values)
params.Set("alt", "json")
if v, ok := c.opt_["indexNamePrefix"]; ok {
params.Set("indexNamePrefix", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["pageSize"]; ok {
params.Set("pageSize", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["pageToken"]; ok {
params.Set("pageToken", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["view"]; ok {
params.Set("view", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/indexes")
urls += "?" + params.Encode()
req, _ := http.NewRequest("GET", urls, body)
googleapi.Expand(req.URL, map[string]string{
"projectId": c.projectId,
})
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *ListIndexesResponse
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Lists search indexes belonging to the specified project.",
// "httpMethod": "GET",
// "id": "cloudsearch.projects.indexes.list",
// "parameterOrder": [
// "projectId",
// "indexNamePrefix",
// "pageSize",
// "pageToken",
// "view"
// ],
// "parameters": {
// "indexNamePrefix": {
// "description": "The prefix of the index name. It is used to list all indexes with names that have this prefix.",
// "location": "query",
// "type": "string"
// },
// "pageSize": {
// "description": "The maximum number of indexes to return per page. If not specified, 100 indexes are returned per page.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
// "description": "A `nextPageToken` returned from previous list indexes call as the starting point for this call. If not specified, list indexes from the beginning.",
// "location": "query",
// "type": "string"
// },
// "projectId": {
// "description": "The project from which to retrieve indexes. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "view": {
// "description": "Specifies which parts of the IndexInfo resource is returned in the response. If not specified, `ID_ONLY` is used.",
// "enum": [
// "INDEX_VIEW_UNSPECIFIED",
// "ID_ONLY",
// "FULL"
// ],
// "location": "query",
// "type": "string"
// }
// },
// "path": "v1/projects/{projectId}/indexes",
// "response": {
// "$ref": "ListIndexesResponse"
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
// "https://www.googleapis.com/auth/cloudsearch",
// "https://www.googleapis.com/auth/userinfo.email"
// ]
// }
}
// method id "cloudsearch.projects.indexes.search":
type ProjectsIndexesSearchCall struct {
s *Service
projectId string
indexId string
query string
fieldExpressions []string
pageSize int64
pageToken string
offset int64
matchedCountAccuracy int64
orderBy string
scorer string
scorerSize int64
returnFields []string
opt_ map[string]interface{}
}
// Search: Lists the documents in the named index that match the query.
func (r *ProjectsIndexesService) Search(projectId string, indexId string, query string, fieldExpressions []string, pageSize int64, pageToken string, offset int64, matchedCountAccuracy int64, orderBy string, scorer string, scorerSize int64, returnFields []string) *ProjectsIndexesSearchCall {
c := &ProjectsIndexesSearchCall{s: r.s, opt_: make(map[string]interface{})}
c.projectId = projectId
c.indexId = indexId
c.query = query
c.fieldExpressions = fieldExpressions
c.pageSize = pageSize
c.pageToken = pageToken
c.offset = offset
c.matchedCountAccuracy = matchedCountAccuracy
c.orderBy = orderBy
c.scorer = scorer
c.scorerSize = scorerSize
c.returnFields = returnFields
return c
}
// FieldExpressions sets the optional parameter "fieldExpressions":
// Customized expressions used in `orderBy` or `returnFields`. The
// expression can contain fields in `Document`, the built-in fields (
// `_rank`, the document rank, and `_score` if scoring is enabled) and
// fields defined in `fieldExpressions`. Each field expression is
// represented in a json object with the following fields: * `name`: the
// name of the field expression in string. * `expression`: the
// expression to be computed. It can be a combination of supported
// functions encoded in string. Expressions involving number fields can
// use the arithmetical operators (`+`, `-`, `*`, `/`) and the built-in
// numeric functions (`max`, `min`, `pow`, `count`, `log`, `abs`).
// Expressions involving geopoint fields can use the `geopoint` and
// `distance` functions. Expressions for text and html fields can use
// the `snippet` function. For example: ``` fieldExpressions={name:
// "TotalPrice", expression: "(Price+Tax)"} ``` ```
// fieldExpressions={name: "snippet", expression: "snippet('good times',
// content)"} ``` The field expression names can be used in `orderBy`
// and `returnFields` after they are defined in `fieldExpressions`.
func (c *ProjectsIndexesSearchCall) FieldExpressions(fieldExpressions string) *ProjectsIndexesSearchCall {
c.opt_["fieldExpressions"] = fieldExpressions
return c
}
// MatchedCountAccuracy sets the optional parameter
// "matchedCountAccuracy": Minimum accuracy requirement for
// `matchedCount` in search response. If specified, `matchedCount` will
// be accurate up to at least that number. For example, when set to 100,
// any `matchedCount <= 100` is accurate. This option may add
// considerable latency/expense. By default (when it is not specified or
// set to 0), the accuracy is the same as `pageSize`.
func (c *ProjectsIndexesSearchCall) MatchedCountAccuracy(matchedCountAccuracy int64) *ProjectsIndexesSearchCall {
c.opt_["matchedCountAccuracy"] = matchedCountAccuracy
return c
}
// Offset sets the optional parameter "offset": Offset is used to move
// to an arbitrary result, independent of the previous results. Offsets
// are inefficient when compared to `pageToken`. `pageToken` and
// `offset` cannot be both set. The default value of `offset` is 0.
func (c *ProjectsIndexesSearchCall) Offset(offset int64) *ProjectsIndexesSearchCall {
c.opt_["offset"] = offset
return c
}
// OrderBy sets the optional parameter "orderBy": Comma-separated list
// of fields for sorting on the search result, including fields from
// `Document`, the built-in fields (`_rank` and `_score`), and fields
// defined in `fieldExpressions`. For example: `orderBy="foo,bar". The
// default sorting order is ascending. To specify descending order for a
// field, a suffix " desc" should be appended to the field name. For
// example: `orderBy="foo desc,bar". The default value for text sort is
// the empty string, and the default value for numeric sort is 0. If not
// specified, the search results are automatically sorted by descending
// `_rank`. Sorting by ascending `_rank` is not allowed.
func (c *ProjectsIndexesSearchCall) OrderBy(orderBy string) *ProjectsIndexesSearchCall {
c.opt_["orderBy"] = orderBy
return c
}
// PageSize sets the optional parameter "pageSize": The maximum number
// of search results to return per page. Searches perform best when the
// `pageSize` is kept as small as possible. If not specified, 10 results
// are returned per page.
func (c *ProjectsIndexesSearchCall) PageSize(pageSize int64) *ProjectsIndexesSearchCall {
c.opt_["pageSize"] = pageSize
return c
}
// PageToken sets the optional parameter "pageToken": A `nextPageToken`
// returned from previous Search call as the starting point for this
// call. Pagination tokens provide better performance and consistency
// than offsets, and they cannot be used in combination with offsets.
func (c *ProjectsIndexesSearchCall) PageToken(pageToken string) *ProjectsIndexesSearchCall {
c.opt_["pageToken"] = pageToken
return c
}
// Query sets the optional parameter "query": The query string in search
// query syntax. If the query is missing or empty, all documents are
// returned.
func (c *ProjectsIndexesSearchCall) Query(query string) *ProjectsIndexesSearchCall {
c.opt_["query"] = query
return c
}
// ReturnFields sets the optional parameter "returnFields": List of
// fields to return in `SearchResult` objects. It can be fields from
// `Document`, the built-in fields `_rank` and `_score`, and fields
// defined in `fieldExpressions`. Use "*" to return all fields from
// `Document`.
func (c *ProjectsIndexesSearchCall) ReturnFields(returnFields string) *ProjectsIndexesSearchCall {
c.opt_["returnFields"] = returnFields
return c
}
// Scorer sets the optional parameter "scorer": The scoring function to
// invoke on a search result for this query. If `scorer` is not set,
// scoring is disabled and `_score` is 0 for all documents in the search
// result. To enable document relevancy score based on term frequency,
// set "scorer=generic".
func (c *ProjectsIndexesSearchCall) Scorer(scorer string) *ProjectsIndexesSearchCall {
c.opt_["scorer"] = scorer
return c
}
// ScorerSize sets the optional parameter "scorerSize": Maximum number
// of top retrieved results to score. It is valid only when `scorer` is
// set. If not specified, 100 retrieved results are scored.
func (c *ProjectsIndexesSearchCall) ScorerSize(scorerSize int64) *ProjectsIndexesSearchCall {
c.opt_["scorerSize"] = scorerSize
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ProjectsIndexesSearchCall) Fields(s ...googleapi.Field) *ProjectsIndexesSearchCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *ProjectsIndexesSearchCall) Do() (*SearchResponse, error) {
var body io.Reader = nil
params := make(url.Values)
params.Set("alt", "json")
if v, ok := c.opt_["fieldExpressions"]; ok {
params.Set("fieldExpressions", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["matchedCountAccuracy"]; ok {
params.Set("matchedCountAccuracy", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["offset"]; ok {
params.Set("offset", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["orderBy"]; ok {
params.Set("orderBy", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["pageSize"]; ok {
params.Set("pageSize", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["pageToken"]; ok {
params.Set("pageToken", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["query"]; ok {
params.Set("query", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["returnFields"]; ok {
params.Set("returnFields", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["scorer"]; ok {
params.Set("scorer", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["scorerSize"]; ok {
params.Set("scorerSize", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/indexes/{indexId}/search")
urls += "?" + params.Encode()
req, _ := http.NewRequest("GET", urls, body)
googleapi.Expand(req.URL, map[string]string{
"projectId": c.projectId,
"indexId": c.indexId,
})
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *SearchResponse
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Lists the documents in the named index that match the query.",
// "httpMethod": "GET",
// "id": "cloudsearch.projects.indexes.search",
// "parameterOrder": [
// "projectId",
// "indexId",
// "query",
// "fieldExpressions",
// "pageSize",
// "pageToken",
// "offset",
// "matchedCountAccuracy",
// "orderBy",
// "scorer",
// "scorerSize",
// "returnFields"
// ],
// "parameters": {
// "fieldExpressions": {
// "description": "Customized expressions used in `orderBy` or `returnFields`. The expression can contain fields in `Document`, the built-in fields ( `_rank`, the document rank, and `_score` if scoring is enabled) and fields defined in `fieldExpressions`. Each field expression is represented in a json object with the following fields: * `name`: the name of the field expression in string. * `expression`: the expression to be computed. It can be a combination of supported functions encoded in string. Expressions involving number fields can use the arithmetical operators (`+`, `-`, `*`, `/`) and the built-in numeric functions (`max`, `min`, `pow`, `count`, `log`, `abs`). Expressions involving geopoint fields can use the `geopoint` and `distance` functions. Expressions for text and html fields can use the `snippet` function. For example: ``` fieldExpressions={name: \"TotalPrice\", expression: \"(Price+Tax)\"} ``` ``` fieldExpressions={name: \"snippet\", expression: \"snippet('good times', content)\"} ``` The field expression names can be used in `orderBy` and `returnFields` after they are defined in `fieldExpressions`.",
// "location": "query",
// "repeated": true,
// "type": "string"
// },
// "indexId": {
// "description": "The index to search. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "matchedCountAccuracy": {
// "description": "Minimum accuracy requirement for `matchedCount` in search response. If specified, `matchedCount` will be accurate up to at least that number. For example, when set to 100, any `matchedCount \u003c= 100` is accurate. This option may add considerable latency/expense. By default (when it is not specified or set to 0), the accuracy is the same as `pageSize`.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "offset": {
// "description": "Offset is used to move to an arbitrary result, independent of the previous results. Offsets are inefficient when compared to `pageToken`. `pageToken` and `offset` cannot be both set. The default value of `offset` is 0.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "orderBy": {
// "description": "Comma-separated list of fields for sorting on the search result, including fields from `Document`, the built-in fields (`_rank` and `_score`), and fields defined in `fieldExpressions`. For example: `orderBy=\"foo,bar\"`. The default sorting order is ascending. To specify descending order for a field, a suffix `\" desc\"` should be appended to the field name. For example: `orderBy=\"foo desc,bar\"`. The default value for text sort is the empty string, and the default value for numeric sort is 0. If not specified, the search results are automatically sorted by descending `_rank`. Sorting by ascending `_rank` is not allowed.",
// "location": "query",
// "type": "string"
// },
// "pageSize": {
// "description": "The maximum number of search results to return per page. Searches perform best when the `pageSize` is kept as small as possible. If not specified, 10 results are returned per page.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
// "description": "A `nextPageToken` returned from previous Search call as the starting point for this call. Pagination tokens provide better performance and consistency than offsets, and they cannot be used in combination with offsets.",
// "location": "query",
// "type": "string"
// },
// "projectId": {
// "description": "The project associated with the index for searching document. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "query": {
// "description": "The query string in search query syntax. If the query is missing or empty, all documents are returned.",
// "location": "query",
// "type": "string"
// },
// "returnFields": {
// "description": "List of fields to return in `SearchResult` objects. It can be fields from `Document`, the built-in fields `_rank` and `_score`, and fields defined in `fieldExpressions`. Use `\"*\"` to return all fields from `Document`.",
// "location": "query",
// "repeated": true,
// "type": "string"
// },
// "scorer": {
// "description": "The scoring function to invoke on a search result for this query. If `scorer` is not set, scoring is disabled and `_score` is 0 for all documents in the search result. To enable document relevancy score based on term frequency, set `\"scorer=generic\"`.",
// "location": "query",
// "type": "string"
// },
// "scorerSize": {
// "description": "Maximum number of top retrieved results to score. It is valid only when `scorer` is set. If not specified, 100 retrieved results are scored.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// }
// },
// "path": "v1/projects/{projectId}/indexes/{indexId}/search",
// "response": {
// "$ref": "SearchResponse"
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
// "https://www.googleapis.com/auth/cloudsearch",
// "https://www.googleapis.com/auth/userinfo.email"
// ]
// }
}
// method id "cloudsearch.projects.indexes.documents.create":
type ProjectsIndexesDocumentsCreateCall struct {
s *Service
projectId string
indexId string
document *Document
opt_ map[string]interface{}
}
// Create: Inserts a document for indexing or updates an indexed
// document. The returned document contains only the ID of the new
// document. When `docId` is absent from the document, it is provided by
// the server.
func (r *ProjectsIndexesDocumentsService) Create(projectId string, indexId string, document *Document) *ProjectsIndexesDocumentsCreateCall {
c := &ProjectsIndexesDocumentsCreateCall{s: r.s, opt_: make(map[string]interface{})}
c.projectId = projectId
c.indexId = indexId
c.document = document
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ProjectsIndexesDocumentsCreateCall) Fields(s ...googleapi.Field) *ProjectsIndexesDocumentsCreateCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *ProjectsIndexesDocumentsCreateCall) Do() (*Document, error) {
var body io.Reader = nil
body, err := googleapi.WithoutDataWrapper.JSONReader(c.document)
if err != nil {
return nil, err
}
ctype := "application/json"
params := make(url.Values)
params.Set("alt", "json")
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/indexes/{indexId}/documents")
urls += "?" + params.Encode()
req, _ := http.NewRequest("POST", urls, body)
googleapi.Expand(req.URL, map[string]string{
"projectId": c.projectId,
"indexId": c.indexId,
})
req.Header.Set("Content-Type", ctype)
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *Document
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Inserts a document for indexing or updates an indexed document. The returned document contains only the ID of the new document. When `docId` is absent from the document, it is provided by the server.",
// "httpMethod": "POST",
// "id": "cloudsearch.projects.indexes.documents.create",
// "parameterOrder": [
// "projectId",
// "indexId"
// ],
// "parameters": {
// "indexId": {
// "description": "The index to add document to. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "projectId": {
// "description": "The project associated with the index for adding document. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// }
// },
// "path": "v1/projects/{projectId}/indexes/{indexId}/documents",
// "request": {
// "$ref": "Document"
// },
// "response": {
// "$ref": "Document"
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
// "https://www.googleapis.com/auth/cloudsearch",
// "https://www.googleapis.com/auth/userinfo.email"
// ]
// }
}
// method id "cloudsearch.projects.indexes.documents.delete":
type ProjectsIndexesDocumentsDeleteCall struct {
s *Service
projectId string
indexId string
docId string
opt_ map[string]interface{}
}
// Delete: Deletes a document from an index.
func (r *ProjectsIndexesDocumentsService) Delete(projectId string, indexId string, docId string) *ProjectsIndexesDocumentsDeleteCall {
c := &ProjectsIndexesDocumentsDeleteCall{s: r.s, opt_: make(map[string]interface{})}
c.projectId = projectId
c.indexId = indexId
c.docId = docId
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ProjectsIndexesDocumentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsIndexesDocumentsDeleteCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *ProjectsIndexesDocumentsDeleteCall) Do() (*Empty, error) {
var body io.Reader = nil
params := make(url.Values)
params.Set("alt", "json")
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/indexes/{indexId}/documents/{docId}")
urls += "?" + params.Encode()
req, _ := http.NewRequest("DELETE", urls, body)
googleapi.Expand(req.URL, map[string]string{
"projectId": c.projectId,
"indexId": c.indexId,
"docId": c.docId,
})
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *Empty
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Deletes a document from an index.",
// "httpMethod": "DELETE",
// "id": "cloudsearch.projects.indexes.documents.delete",
// "parameterOrder": [
// "projectId",
// "indexId",
// "docId"
// ],
// "parameters": {
// "docId": {
// "description": "The document to be deleted. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "indexId": {
// "description": "The index from which to delete the document. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "projectId": {
// "description": "The project associated with the index for deleting document. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// }
// },
// "path": "v1/projects/{projectId}/indexes/{indexId}/documents/{docId}",
// "response": {
// "$ref": "Empty"
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
// "https://www.googleapis.com/auth/cloudsearch",
// "https://www.googleapis.com/auth/userinfo.email"
// ]
// }
}
// method id "cloudsearch.projects.indexes.documents.get":
type ProjectsIndexesDocumentsGetCall struct {
s *Service
projectId string
indexId string
docId string
opt_ map[string]interface{}
}
// Get: Retrieves a document from an index.
func (r *ProjectsIndexesDocumentsService) Get(projectId string, indexId string, docId string) *ProjectsIndexesDocumentsGetCall {
c := &ProjectsIndexesDocumentsGetCall{s: r.s, opt_: make(map[string]interface{})}
c.projectId = projectId
c.indexId = indexId
c.docId = docId
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ProjectsIndexesDocumentsGetCall) Fields(s ...googleapi.Field) *ProjectsIndexesDocumentsGetCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *ProjectsIndexesDocumentsGetCall) Do() (*Document, error) {
var body io.Reader = nil
params := make(url.Values)
params.Set("alt", "json")
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/indexes/{indexId}/documents/{docId}")
urls += "?" + params.Encode()
req, _ := http.NewRequest("GET", urls, body)
googleapi.Expand(req.URL, map[string]string{
"projectId": c.projectId,
"indexId": c.indexId,
"docId": c.docId,
})
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *Document
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Retrieves a document from an index.",
// "httpMethod": "GET",
// "id": "cloudsearch.projects.indexes.documents.get",
// "parameterOrder": [
// "projectId",
// "indexId",
// "docId"
// ],
// "parameters": {
// "docId": {
// "description": "The identifier of the document to retrieve. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "indexId": {
// "description": "The index from which to retrieve the document. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "projectId": {
// "description": "The project associated with the index for retrieving the document. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// }
// },
// "path": "v1/projects/{projectId}/indexes/{indexId}/documents/{docId}",
// "response": {
// "$ref": "Document"
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
// "https://www.googleapis.com/auth/cloudsearch",
// "https://www.googleapis.com/auth/userinfo.email"
// ]
// }
}
// method id "cloudsearch.projects.indexes.documents.list":
type ProjectsIndexesDocumentsListCall struct {
s *Service
projectId string
indexId string
pageSize int64
pageToken string
view string
opt_ map[string]interface{}
}
// List: Lists documents in the specified search index. Intended for
// batch processing.
func (r *ProjectsIndexesDocumentsService) List(projectId string, indexId string, pageSize int64, pageToken string, view string) *ProjectsIndexesDocumentsListCall {
c := &ProjectsIndexesDocumentsListCall{s: r.s, opt_: make(map[string]interface{})}
c.projectId = projectId
c.indexId = indexId
c.pageSize = pageSize
c.pageToken = pageToken
c.view = view
return c
}
// PageSize sets the optional parameter "pageSize": The maximum number
// of documents to return per page. If not specified, 100 documents are
// returned per page.
func (c *ProjectsIndexesDocumentsListCall) PageSize(pageSize int64) *ProjectsIndexesDocumentsListCall {
c.opt_["pageSize"] = pageSize
return c
}
// PageToken sets the optional parameter "pageToken": A `nextPageToken`
// returned from previous list documents call as the starting point for
// this call. If not specified, list documents from the beginning.
func (c *ProjectsIndexesDocumentsListCall) PageToken(pageToken string) *ProjectsIndexesDocumentsListCall {
c.opt_["pageToken"] = pageToken
return c
}
// View sets the optional parameter "view": Specifies which part of the
// document resource is returned in the response. If not specified,
// `ID_ONLY` is used.
//
// Possible values:
// "DOCUMENT_VIEW_UNSPECIFIED"
// "ID_ONLY"
// "FULL"
func (c *ProjectsIndexesDocumentsListCall) View(view string) *ProjectsIndexesDocumentsListCall {
c.opt_["view"] = view
return c
}
// Fields allows partial responses to be retrieved.
// See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *ProjectsIndexesDocumentsListCall) Fields(s ...googleapi.Field) *ProjectsIndexesDocumentsListCall {
c.opt_["fields"] = googleapi.CombineFields(s)
return c
}
func (c *ProjectsIndexesDocumentsListCall) Do() (*ListDocumentsResponse, error) {
var body io.Reader = nil
params := make(url.Values)
params.Set("alt", "json")
if v, ok := c.opt_["pageSize"]; ok {
params.Set("pageSize", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["pageToken"]; ok {
params.Set("pageToken", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["view"]; ok {
params.Set("view", fmt.Sprintf("%v", v))
}
if v, ok := c.opt_["fields"]; ok {
params.Set("fields", fmt.Sprintf("%v", v))
}
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/projects/{projectId}/indexes/{indexId}/documents")
urls += "?" + params.Encode()
req, _ := http.NewRequest("GET", urls, body)
googleapi.Expand(req.URL, map[string]string{
"projectId": c.projectId,
"indexId": c.indexId,
})
req.Header.Set("User-Agent", c.s.userAgent())
res, err := c.s.client.Do(req)
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, err
}
var ret *ListDocumentsResponse
if err := json.NewDecoder(res.Body).Decode(&ret); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Lists documents in the specified search index. Intended for batch processing.",
// "httpMethod": "GET",
// "id": "cloudsearch.projects.indexes.documents.list",
// "parameterOrder": [
// "projectId",
// "indexId",
// "pageSize",
// "pageToken",
// "view"
// ],
// "parameters": {
// "indexId": {
// "description": "The index from which to list the documents. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "pageSize": {
// "description": "The maximum number of documents to return per page. If not specified, 100 documents are returned per page.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
// "description": "A `nextPageToken` returned from previous list documents call as the starting point for this call. If not specified, list documents from the beginning.",
// "location": "query",
// "type": "string"
// },
// "projectId": {
// "description": "The project associated with the index for listing documents. It cannot be the empty string.",
// "location": "path",
// "required": true,
// "type": "string"
// },
// "view": {
// "description": "Specifies which part of the document resource is returned in the response. If not specified, `ID_ONLY` is used.",
// "enum": [
// "DOCUMENT_VIEW_UNSPECIFIED",
// "ID_ONLY",
// "FULL"
// ],
// "location": "query",
// "type": "string"
// }
// },
// "path": "v1/projects/{projectId}/indexes/{indexId}/documents",
// "response": {
// "$ref": "ListDocumentsResponse"
// },
// "scopes": [
// "https://www.googleapis.com/auth/cloud-platform",
// "https://www.googleapis.com/auth/cloudsearch",
// "https://www.googleapis.com/auth/userinfo.email"
// ]
// }
}
|