google-apis-cloudsearch_v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-cloudsearch_v1.rb +15 -0
- data/lib/google/apis/cloudsearch_v1.rb +61 -0
- data/lib/google/apis/cloudsearch_v1/classes.rb +5015 -0
- data/lib/google/apis/cloudsearch_v1/gem_version.rb +28 -0
- data/lib/google/apis/cloudsearch_v1/representations.rb +2423 -0
- data/lib/google/apis/cloudsearch_v1/service.rb +1778 -0
- metadata +76 -0
@@ -0,0 +1,1778 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module CloudsearchV1
|
23
|
+
# Cloud Search API
|
24
|
+
#
|
25
|
+
# Cloud Search provides cloud-based search capabilities over G Suite data. The
|
26
|
+
# Cloud Search API allows indexing of non-G Suite data into Cloud Search.
|
27
|
+
#
|
28
|
+
# @example
|
29
|
+
# require 'google/apis/cloudsearch_v1'
|
30
|
+
#
|
31
|
+
# Cloudsearch = Google::Apis::CloudsearchV1 # Alias the module
|
32
|
+
# service = Cloudsearch::CloudSearchService.new
|
33
|
+
#
|
34
|
+
# @see https://developers.google.com/cloud-search/docs/guides/
|
35
|
+
class CloudSearchService < Google::Apis::Core::BaseService
|
36
|
+
# @return [String]
|
37
|
+
# API key. Your API key identifies your project and provides you with API access,
|
38
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
39
|
+
attr_accessor :key
|
40
|
+
|
41
|
+
# @return [String]
|
42
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
43
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
44
|
+
attr_accessor :quota_user
|
45
|
+
|
46
|
+
def initialize
|
47
|
+
super('https://cloudsearch.googleapis.com/', '',
|
48
|
+
client_name: 'google-apis-cloudsearch_v1',
|
49
|
+
client_version: Google::Apis::CloudsearchV1::GEM_VERSION)
|
50
|
+
@batch_path = 'batch'
|
51
|
+
end
|
52
|
+
|
53
|
+
# Checks whether an item is accessible by specified principal. **Note:** This
|
54
|
+
# API requires an admin account to execute.
|
55
|
+
# @param [String] name
|
56
|
+
# Item name, format: datasources/`source_id`/items/`item_id`
|
57
|
+
# @param [Google::Apis::CloudsearchV1::Principal] principal_object
|
58
|
+
# @param [Boolean] debug_options_enable_debugging
|
59
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
60
|
+
# ignore this field.
|
61
|
+
# @param [String] fields
|
62
|
+
# Selector specifying which fields to include in a partial response.
|
63
|
+
# @param [String] quota_user
|
64
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
65
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
66
|
+
# @param [Google::Apis::RequestOptions] options
|
67
|
+
# Request-specific options
|
68
|
+
#
|
69
|
+
# @yield [result, err] Result & error if block supplied
|
70
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::CheckAccessResponse] parsed result object
|
71
|
+
# @yieldparam err [StandardError] error object if request failed
|
72
|
+
#
|
73
|
+
# @return [Google::Apis::CloudsearchV1::CheckAccessResponse]
|
74
|
+
#
|
75
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
76
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
77
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
78
|
+
def check_debug_datasource_item_access(name, principal_object = nil, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block)
|
79
|
+
command = make_simple_command(:post, 'v1/debug/{+name}:checkAccess', options)
|
80
|
+
command.request_representation = Google::Apis::CloudsearchV1::Principal::Representation
|
81
|
+
command.request_object = principal_object
|
82
|
+
command.response_representation = Google::Apis::CloudsearchV1::CheckAccessResponse::Representation
|
83
|
+
command.response_class = Google::Apis::CloudsearchV1::CheckAccessResponse
|
84
|
+
command.params['name'] = name unless name.nil?
|
85
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
86
|
+
command.query['fields'] = fields unless fields.nil?
|
87
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
88
|
+
execute_or_queue_command(command, &block)
|
89
|
+
end
|
90
|
+
|
91
|
+
# Fetches the item whose viewUrl exactly matches that of the URL provided in the
|
92
|
+
# request. **Note:** This API requires an admin account to execute.
|
93
|
+
# @param [String] name
|
94
|
+
# Source name, format: datasources/`source_id`
|
95
|
+
# @param [Google::Apis::CloudsearchV1::SearchItemsByViewUrlRequest] search_items_by_view_url_request_object
|
96
|
+
# @param [String] fields
|
97
|
+
# Selector specifying which fields to include in a partial response.
|
98
|
+
# @param [String] quota_user
|
99
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
100
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
101
|
+
# @param [Google::Apis::RequestOptions] options
|
102
|
+
# Request-specific options
|
103
|
+
#
|
104
|
+
# @yield [result, err] Result & error if block supplied
|
105
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::SearchItemsByViewUrlResponse] parsed result object
|
106
|
+
# @yieldparam err [StandardError] error object if request failed
|
107
|
+
#
|
108
|
+
# @return [Google::Apis::CloudsearchV1::SearchItemsByViewUrlResponse]
|
109
|
+
#
|
110
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
111
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
112
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
113
|
+
def search_debug_datasource_item_by_view_url(name, search_items_by_view_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
114
|
+
command = make_simple_command(:post, 'v1/debug/{+name}/items:searchByViewUrl', options)
|
115
|
+
command.request_representation = Google::Apis::CloudsearchV1::SearchItemsByViewUrlRequest::Representation
|
116
|
+
command.request_object = search_items_by_view_url_request_object
|
117
|
+
command.response_representation = Google::Apis::CloudsearchV1::SearchItemsByViewUrlResponse::Representation
|
118
|
+
command.response_class = Google::Apis::CloudsearchV1::SearchItemsByViewUrlResponse
|
119
|
+
command.params['name'] = name unless name.nil?
|
120
|
+
command.query['fields'] = fields unless fields.nil?
|
121
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
122
|
+
execute_or_queue_command(command, &block)
|
123
|
+
end
|
124
|
+
|
125
|
+
# List all unmapped identities for a specific item. **Note:** This API requires
|
126
|
+
# an admin account to execute.
|
127
|
+
# @param [String] parent
|
128
|
+
# The name of the item, in the following format: datasources/`source_id`/items/`
|
129
|
+
# ID`
|
130
|
+
# @param [Boolean] debug_options_enable_debugging
|
131
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
132
|
+
# ignore this field.
|
133
|
+
# @param [Fixnum] page_size
|
134
|
+
# Maximum number of items to fetch in a request. Defaults to 100.
|
135
|
+
# @param [String] page_token
|
136
|
+
# The next_page_token value returned from a previous List request, if any.
|
137
|
+
# @param [String] fields
|
138
|
+
# Selector specifying which fields to include in a partial response.
|
139
|
+
# @param [String] quota_user
|
140
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
141
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
142
|
+
# @param [Google::Apis::RequestOptions] options
|
143
|
+
# Request-specific options
|
144
|
+
#
|
145
|
+
# @yield [result, err] Result & error if block supplied
|
146
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse] parsed result object
|
147
|
+
# @yieldparam err [StandardError] error object if request failed
|
148
|
+
#
|
149
|
+
# @return [Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse]
|
150
|
+
#
|
151
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
152
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
153
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
154
|
+
def list_debug_datasource_item_unmappedids(parent, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
155
|
+
command = make_simple_command(:get, 'v1/debug/{+parent}/unmappedids', options)
|
156
|
+
command.response_representation = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse::Representation
|
157
|
+
command.response_class = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse
|
158
|
+
command.params['parent'] = parent unless parent.nil?
|
159
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
160
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
161
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
162
|
+
command.query['fields'] = fields unless fields.nil?
|
163
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
164
|
+
execute_or_queue_command(command, &block)
|
165
|
+
end
|
166
|
+
|
167
|
+
# Lists names of items associated with an unmapped identity. **Note:** This API
|
168
|
+
# requires an admin account to execute.
|
169
|
+
# @param [String] parent
|
170
|
+
# The name of the identity source, in the following format: identitysources/`
|
171
|
+
# source_id``
|
172
|
+
# @param [Boolean] debug_options_enable_debugging
|
173
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
174
|
+
# ignore this field.
|
175
|
+
# @param [String] group_resource_name
|
176
|
+
# @param [Fixnum] page_size
|
177
|
+
# Maximum number of items to fetch in a request. Defaults to 100.
|
178
|
+
# @param [String] page_token
|
179
|
+
# The next_page_token value returned from a previous List request, if any.
|
180
|
+
# @param [String] user_resource_name
|
181
|
+
# @param [String] fields
|
182
|
+
# Selector specifying which fields to include in a partial response.
|
183
|
+
# @param [String] quota_user
|
184
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
185
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
186
|
+
# @param [Google::Apis::RequestOptions] options
|
187
|
+
# Request-specific options
|
188
|
+
#
|
189
|
+
# @yield [result, err] Result & error if block supplied
|
190
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse] parsed result object
|
191
|
+
# @yieldparam err [StandardError] error object if request failed
|
192
|
+
#
|
193
|
+
# @return [Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse]
|
194
|
+
#
|
195
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
196
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
197
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
198
|
+
def list_debug_identitysource_item_forunmappedidentity(parent, debug_options_enable_debugging: nil, group_resource_name: nil, page_size: nil, page_token: nil, user_resource_name: nil, fields: nil, quota_user: nil, options: nil, &block)
|
199
|
+
command = make_simple_command(:get, 'v1/debug/{+parent}/items:forunmappedidentity', options)
|
200
|
+
command.response_representation = Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse::Representation
|
201
|
+
command.response_class = Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse
|
202
|
+
command.params['parent'] = parent unless parent.nil?
|
203
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
204
|
+
command.query['groupResourceName'] = group_resource_name unless group_resource_name.nil?
|
205
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
206
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
207
|
+
command.query['userResourceName'] = user_resource_name unless user_resource_name.nil?
|
208
|
+
command.query['fields'] = fields unless fields.nil?
|
209
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
210
|
+
execute_or_queue_command(command, &block)
|
211
|
+
end
|
212
|
+
|
213
|
+
# Lists unmapped user identities for an identity source. **Note:** This API
|
214
|
+
# requires an admin account to execute.
|
215
|
+
# @param [String] parent
|
216
|
+
# The name of the identity source, in the following format: identitysources/`
|
217
|
+
# source_id`
|
218
|
+
# @param [Boolean] debug_options_enable_debugging
|
219
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
220
|
+
# ignore this field.
|
221
|
+
# @param [Fixnum] page_size
|
222
|
+
# Maximum number of items to fetch in a request. Defaults to 100.
|
223
|
+
# @param [String] page_token
|
224
|
+
# The next_page_token value returned from a previous List request, if any.
|
225
|
+
# @param [String] resolution_status_code
|
226
|
+
# Limit users selection to this status.
|
227
|
+
# @param [String] fields
|
228
|
+
# Selector specifying which fields to include in a partial response.
|
229
|
+
# @param [String] quota_user
|
230
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
231
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
232
|
+
# @param [Google::Apis::RequestOptions] options
|
233
|
+
# Request-specific options
|
234
|
+
#
|
235
|
+
# @yield [result, err] Result & error if block supplied
|
236
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse] parsed result object
|
237
|
+
# @yieldparam err [StandardError] error object if request failed
|
238
|
+
#
|
239
|
+
# @return [Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse]
|
240
|
+
#
|
241
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
242
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
243
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
244
|
+
def list_debug_identitysource_unmappedids(parent, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, resolution_status_code: nil, fields: nil, quota_user: nil, options: nil, &block)
|
245
|
+
command = make_simple_command(:get, 'v1/debug/{+parent}/unmappedids', options)
|
246
|
+
command.response_representation = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse::Representation
|
247
|
+
command.response_class = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse
|
248
|
+
command.params['parent'] = parent unless parent.nil?
|
249
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
250
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
251
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
252
|
+
command.query['resolutionStatusCode'] = resolution_status_code unless resolution_status_code.nil?
|
253
|
+
command.query['fields'] = fields unless fields.nil?
|
254
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
255
|
+
execute_or_queue_command(command, &block)
|
256
|
+
end
|
257
|
+
|
258
|
+
# Deletes the schema of a data source. **Note:** This API requires an admin or
|
259
|
+
# service account to execute.
|
260
|
+
# @param [String] name
|
261
|
+
# Name of the data source to delete Schema. Format: datasources/`source_id`
|
262
|
+
# @param [Boolean] debug_options_enable_debugging
|
263
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
264
|
+
# ignore this field.
|
265
|
+
# @param [String] fields
|
266
|
+
# Selector specifying which fields to include in a partial response.
|
267
|
+
# @param [String] quota_user
|
268
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
269
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
270
|
+
# @param [Google::Apis::RequestOptions] options
|
271
|
+
# Request-specific options
|
272
|
+
#
|
273
|
+
# @yield [result, err] Result & error if block supplied
|
274
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
275
|
+
# @yieldparam err [StandardError] error object if request failed
|
276
|
+
#
|
277
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
278
|
+
#
|
279
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
280
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
281
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
282
|
+
def delete_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block)
|
283
|
+
command = make_simple_command(:delete, 'v1/indexing/{+name}/schema', options)
|
284
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
285
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
286
|
+
command.params['name'] = name unless name.nil?
|
287
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
288
|
+
command.query['fields'] = fields unless fields.nil?
|
289
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
290
|
+
execute_or_queue_command(command, &block)
|
291
|
+
end
|
292
|
+
|
293
|
+
# Gets the schema of a data source. **Note:** This API requires an admin or
|
294
|
+
# service account to execute.
|
295
|
+
# @param [String] name
|
296
|
+
# Name of the data source to get Schema. Format: datasources/`source_id`
|
297
|
+
# @param [Boolean] debug_options_enable_debugging
|
298
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
299
|
+
# ignore this field.
|
300
|
+
# @param [String] fields
|
301
|
+
# Selector specifying which fields to include in a partial response.
|
302
|
+
# @param [String] quota_user
|
303
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
304
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
305
|
+
# @param [Google::Apis::RequestOptions] options
|
306
|
+
# Request-specific options
|
307
|
+
#
|
308
|
+
# @yield [result, err] Result & error if block supplied
|
309
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Schema] parsed result object
|
310
|
+
# @yieldparam err [StandardError] error object if request failed
|
311
|
+
#
|
312
|
+
# @return [Google::Apis::CloudsearchV1::Schema]
|
313
|
+
#
|
314
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
315
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
316
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
317
|
+
def get_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block)
|
318
|
+
command = make_simple_command(:get, 'v1/indexing/{+name}/schema', options)
|
319
|
+
command.response_representation = Google::Apis::CloudsearchV1::Schema::Representation
|
320
|
+
command.response_class = Google::Apis::CloudsearchV1::Schema
|
321
|
+
command.params['name'] = name unless name.nil?
|
322
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
323
|
+
command.query['fields'] = fields unless fields.nil?
|
324
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
325
|
+
execute_or_queue_command(command, &block)
|
326
|
+
end
|
327
|
+
|
328
|
+
# Updates the schema of a data source. This method does not perform incremental
|
329
|
+
# updates to the schema. Instead, this method updates the schema by overwriting
|
330
|
+
# the entire schema. **Note:** This API requires an admin or service account to
|
331
|
+
# execute.
|
332
|
+
# @param [String] name
|
333
|
+
# Name of the data source to update Schema. Format: datasources/`source_id`
|
334
|
+
# @param [Google::Apis::CloudsearchV1::UpdateSchemaRequest] update_schema_request_object
|
335
|
+
# @param [String] fields
|
336
|
+
# Selector specifying which fields to include in a partial response.
|
337
|
+
# @param [String] quota_user
|
338
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
339
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
340
|
+
# @param [Google::Apis::RequestOptions] options
|
341
|
+
# Request-specific options
|
342
|
+
#
|
343
|
+
# @yield [result, err] Result & error if block supplied
|
344
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
345
|
+
# @yieldparam err [StandardError] error object if request failed
|
346
|
+
#
|
347
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
348
|
+
#
|
349
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
350
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
351
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
352
|
+
def update_datasource_schema(name, update_schema_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
353
|
+
command = make_simple_command(:put, 'v1/indexing/{+name}/schema', options)
|
354
|
+
command.request_representation = Google::Apis::CloudsearchV1::UpdateSchemaRequest::Representation
|
355
|
+
command.request_object = update_schema_request_object
|
356
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
357
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
358
|
+
command.params['name'] = name unless name.nil?
|
359
|
+
command.query['fields'] = fields unless fields.nil?
|
360
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
361
|
+
execute_or_queue_command(command, &block)
|
362
|
+
end
|
363
|
+
|
364
|
+
# Deletes Item resource for the specified resource name. This API requires an
|
365
|
+
# admin or service account to execute. The service account used is the one
|
366
|
+
# whitelisted in the corresponding data source.
|
367
|
+
# @param [String] name
|
368
|
+
# Required. Name of the item to delete. Format: datasources/`source_id`/items/`
|
369
|
+
# item_id`
|
370
|
+
# @param [String] connector_name
|
371
|
+
# Name of connector making this call. Format: datasources/`source_id`/connectors/
|
372
|
+
# `ID`
|
373
|
+
# @param [Boolean] debug_options_enable_debugging
|
374
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
375
|
+
# ignore this field.
|
376
|
+
# @param [String] mode
|
377
|
+
# Required. The RequestMode for this request.
|
378
|
+
# @param [String] version
|
379
|
+
# Required. The incremented version of the item to delete from the index. The
|
380
|
+
# indexing system stores the version from the datasource as a byte string and
|
381
|
+
# compares the Item version in the index to the version of the queued Item using
|
382
|
+
# lexical ordering. Cloud Search Indexing won't delete any queued item with a
|
383
|
+
# version value that is less than or equal to the version of the currently
|
384
|
+
# indexed item. The maximum length for this field is 1024 bytes.
|
385
|
+
# @param [String] fields
|
386
|
+
# Selector specifying which fields to include in a partial response.
|
387
|
+
# @param [String] quota_user
|
388
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
389
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
390
|
+
# @param [Google::Apis::RequestOptions] options
|
391
|
+
# Request-specific options
|
392
|
+
#
|
393
|
+
# @yield [result, err] Result & error if block supplied
|
394
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
395
|
+
# @yieldparam err [StandardError] error object if request failed
|
396
|
+
#
|
397
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
398
|
+
#
|
399
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
400
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
401
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
402
|
+
def delete_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, mode: nil, version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
403
|
+
command = make_simple_command(:delete, 'v1/indexing/{+name}', options)
|
404
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
405
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
406
|
+
command.params['name'] = name unless name.nil?
|
407
|
+
command.query['connectorName'] = connector_name unless connector_name.nil?
|
408
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
409
|
+
command.query['mode'] = mode unless mode.nil?
|
410
|
+
command.query['version'] = version unless version.nil?
|
411
|
+
command.query['fields'] = fields unless fields.nil?
|
412
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
413
|
+
execute_or_queue_command(command, &block)
|
414
|
+
end
|
415
|
+
|
416
|
+
# Deletes all items in a queue. This method is useful for deleting stale items.
|
417
|
+
# This API requires an admin or service account to execute. The service account
|
418
|
+
# used is the one whitelisted in the corresponding data source.
|
419
|
+
# @param [String] name
|
420
|
+
# Name of the Data Source to delete items in a queue. Format: datasources/`
|
421
|
+
# source_id`
|
422
|
+
# @param [Google::Apis::CloudsearchV1::DeleteQueueItemsRequest] delete_queue_items_request_object
|
423
|
+
# @param [String] fields
|
424
|
+
# Selector specifying which fields to include in a partial response.
|
425
|
+
# @param [String] quota_user
|
426
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
427
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
428
|
+
# @param [Google::Apis::RequestOptions] options
|
429
|
+
# Request-specific options
|
430
|
+
#
|
431
|
+
# @yield [result, err] Result & error if block supplied
|
432
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
433
|
+
# @yieldparam err [StandardError] error object if request failed
|
434
|
+
#
|
435
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
436
|
+
#
|
437
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
438
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
439
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
440
|
+
def delete_queue_items(name, delete_queue_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
441
|
+
command = make_simple_command(:post, 'v1/indexing/{+name}/items:deleteQueueItems', options)
|
442
|
+
command.request_representation = Google::Apis::CloudsearchV1::DeleteQueueItemsRequest::Representation
|
443
|
+
command.request_object = delete_queue_items_request_object
|
444
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
445
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
446
|
+
command.params['name'] = name unless name.nil?
|
447
|
+
command.query['fields'] = fields unless fields.nil?
|
448
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
449
|
+
execute_or_queue_command(command, &block)
|
450
|
+
end
|
451
|
+
|
452
|
+
# Gets Item resource by item name. This API requires an admin or service account
|
453
|
+
# to execute. The service account used is the one whitelisted in the
|
454
|
+
# corresponding data source.
|
455
|
+
# @param [String] name
|
456
|
+
# Name of the item to get info. Format: datasources/`source_id`/items/`item_id`
|
457
|
+
# @param [String] connector_name
|
458
|
+
# Name of connector making this call. Format: datasources/`source_id`/connectors/
|
459
|
+
# `ID`
|
460
|
+
# @param [Boolean] debug_options_enable_debugging
|
461
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
462
|
+
# ignore this field.
|
463
|
+
# @param [String] fields
|
464
|
+
# Selector specifying which fields to include in a partial response.
|
465
|
+
# @param [String] quota_user
|
466
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
467
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
468
|
+
# @param [Google::Apis::RequestOptions] options
|
469
|
+
# Request-specific options
|
470
|
+
#
|
471
|
+
# @yield [result, err] Result & error if block supplied
|
472
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Item] parsed result object
|
473
|
+
# @yieldparam err [StandardError] error object if request failed
|
474
|
+
#
|
475
|
+
# @return [Google::Apis::CloudsearchV1::Item]
|
476
|
+
#
|
477
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
478
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
479
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
480
|
+
def get_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block)
|
481
|
+
command = make_simple_command(:get, 'v1/indexing/{+name}', options)
|
482
|
+
command.response_representation = Google::Apis::CloudsearchV1::Item::Representation
|
483
|
+
command.response_class = Google::Apis::CloudsearchV1::Item
|
484
|
+
command.params['name'] = name unless name.nil?
|
485
|
+
command.query['connectorName'] = connector_name unless connector_name.nil?
|
486
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
487
|
+
command.query['fields'] = fields unless fields.nil?
|
488
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
489
|
+
execute_or_queue_command(command, &block)
|
490
|
+
end
|
491
|
+
|
492
|
+
# Updates Item ACL, metadata, and content. It will insert the Item if it does
|
493
|
+
# not exist. This method does not support partial updates. Fields with no
|
494
|
+
# provided values are cleared out in the Cloud Search index. This API requires
|
495
|
+
# an admin or service account to execute. The service account used is the one
|
496
|
+
# whitelisted in the corresponding data source.
|
497
|
+
# @param [String] name
|
498
|
+
# Name of the Item. Format: datasources/`source_id`/items/`item_id` This is a
|
499
|
+
# required field. The maximum length is 1536 characters.
|
500
|
+
# @param [Google::Apis::CloudsearchV1::IndexItemRequest] index_item_request_object
|
501
|
+
# @param [String] fields
|
502
|
+
# Selector specifying which fields to include in a partial response.
|
503
|
+
# @param [String] quota_user
|
504
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
505
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
506
|
+
# @param [Google::Apis::RequestOptions] options
|
507
|
+
# Request-specific options
|
508
|
+
#
|
509
|
+
# @yield [result, err] Result & error if block supplied
|
510
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
511
|
+
# @yieldparam err [StandardError] error object if request failed
|
512
|
+
#
|
513
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
514
|
+
#
|
515
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
516
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
517
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
518
|
+
def index_item(name, index_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
519
|
+
command = make_simple_command(:post, 'v1/indexing/{+name}:index', options)
|
520
|
+
command.request_representation = Google::Apis::CloudsearchV1::IndexItemRequest::Representation
|
521
|
+
command.request_object = index_item_request_object
|
522
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
523
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
524
|
+
command.params['name'] = name unless name.nil?
|
525
|
+
command.query['fields'] = fields unless fields.nil?
|
526
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
527
|
+
execute_or_queue_command(command, &block)
|
528
|
+
end
|
529
|
+
|
530
|
+
# Lists all or a subset of Item resources. This API requires an admin or service
|
531
|
+
# account to execute. The service account used is the one whitelisted in the
|
532
|
+
# corresponding data source.
|
533
|
+
# @param [String] name
|
534
|
+
# Name of the Data Source to list Items. Format: datasources/`source_id`
|
535
|
+
# @param [Boolean] brief
|
536
|
+
# When set to true, the indexing system only populates the following fields:
|
537
|
+
# name, version, queue. metadata.hash, metadata.title, metadata.
|
538
|
+
# sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.
|
539
|
+
# updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash,
|
540
|
+
# content.hash, itemType, itemStatus.code, itemStatus.processingError.code,
|
541
|
+
# itemStatus.repositoryError.type, If this value is false, then all the fields
|
542
|
+
# are populated in Item.
|
543
|
+
# @param [String] connector_name
|
544
|
+
# Name of connector making this call. Format: datasources/`source_id`/connectors/
|
545
|
+
# `ID`
|
546
|
+
# @param [Boolean] debug_options_enable_debugging
|
547
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
548
|
+
# ignore this field.
|
549
|
+
# @param [Fixnum] page_size
|
550
|
+
# Maximum number of items to fetch in a request. The max value is 1000 when
|
551
|
+
# brief is true. The max value is 10 if brief is false. The default value is 10
|
552
|
+
# @param [String] page_token
|
553
|
+
# The next_page_token value returned from a previous List request, if any.
|
554
|
+
# @param [String] fields
|
555
|
+
# Selector specifying which fields to include in a partial response.
|
556
|
+
# @param [String] quota_user
|
557
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
558
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
559
|
+
# @param [Google::Apis::RequestOptions] options
|
560
|
+
# Request-specific options
|
561
|
+
#
|
562
|
+
# @yield [result, err] Result & error if block supplied
|
563
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::ListItemsResponse] parsed result object
|
564
|
+
# @yieldparam err [StandardError] error object if request failed
|
565
|
+
#
|
566
|
+
# @return [Google::Apis::CloudsearchV1::ListItemsResponse]
|
567
|
+
#
|
568
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
569
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
570
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
571
|
+
def list_indexing_datasource_items(name, brief: nil, connector_name: nil, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
572
|
+
command = make_simple_command(:get, 'v1/indexing/{+name}/items', options)
|
573
|
+
command.response_representation = Google::Apis::CloudsearchV1::ListItemsResponse::Representation
|
574
|
+
command.response_class = Google::Apis::CloudsearchV1::ListItemsResponse
|
575
|
+
command.params['name'] = name unless name.nil?
|
576
|
+
command.query['brief'] = brief unless brief.nil?
|
577
|
+
command.query['connectorName'] = connector_name unless connector_name.nil?
|
578
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
579
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
580
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
581
|
+
command.query['fields'] = fields unless fields.nil?
|
582
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
583
|
+
execute_or_queue_command(command, &block)
|
584
|
+
end
|
585
|
+
|
586
|
+
# Polls for unreserved items from the indexing queue and marks a set as reserved,
|
587
|
+
# starting with items that have the oldest timestamp from the highest priority
|
588
|
+
# ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED
|
589
|
+
# Reserving items ensures that polling from other threads cannot create
|
590
|
+
# overlapping sets. After handling the reserved items, the client should put
|
591
|
+
# items back into the unreserved state, either by calling index, or by calling
|
592
|
+
# push with the type REQUEUE. Items automatically become available (unreserved)
|
593
|
+
# after 4 hours even if no update or push method is called. This API requires an
|
594
|
+
# admin or service account to execute. The service account used is the one
|
595
|
+
# whitelisted in the corresponding data source.
|
596
|
+
# @param [String] name
|
597
|
+
# Name of the Data Source to poll items. Format: datasources/`source_id`
|
598
|
+
# @param [Google::Apis::CloudsearchV1::PollItemsRequest] poll_items_request_object
|
599
|
+
# @param [String] fields
|
600
|
+
# Selector specifying which fields to include in a partial response.
|
601
|
+
# @param [String] quota_user
|
602
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
603
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
604
|
+
# @param [Google::Apis::RequestOptions] options
|
605
|
+
# Request-specific options
|
606
|
+
#
|
607
|
+
# @yield [result, err] Result & error if block supplied
|
608
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::PollItemsResponse] parsed result object
|
609
|
+
# @yieldparam err [StandardError] error object if request failed
|
610
|
+
#
|
611
|
+
# @return [Google::Apis::CloudsearchV1::PollItemsResponse]
|
612
|
+
#
|
613
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
614
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
615
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
616
|
+
def poll_items(name, poll_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
617
|
+
command = make_simple_command(:post, 'v1/indexing/{+name}/items:poll', options)
|
618
|
+
command.request_representation = Google::Apis::CloudsearchV1::PollItemsRequest::Representation
|
619
|
+
command.request_object = poll_items_request_object
|
620
|
+
command.response_representation = Google::Apis::CloudsearchV1::PollItemsResponse::Representation
|
621
|
+
command.response_class = Google::Apis::CloudsearchV1::PollItemsResponse
|
622
|
+
command.params['name'] = name unless name.nil?
|
623
|
+
command.query['fields'] = fields unless fields.nil?
|
624
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
625
|
+
execute_or_queue_command(command, &block)
|
626
|
+
end
|
627
|
+
|
628
|
+
# Pushes an item onto a queue for later polling and updating. This API requires
|
629
|
+
# an admin or service account to execute. The service account used is the one
|
630
|
+
# whitelisted in the corresponding data source.
|
631
|
+
# @param [String] name
|
632
|
+
# Name of the item to push into the indexing queue. Format: datasources/`
|
633
|
+
# source_id`/items/`ID` This is a required field. The maximum length is 1536
|
634
|
+
# characters.
|
635
|
+
# @param [Google::Apis::CloudsearchV1::PushItemRequest] push_item_request_object
|
636
|
+
# @param [String] fields
|
637
|
+
# Selector specifying which fields to include in a partial response.
|
638
|
+
# @param [String] quota_user
|
639
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
640
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
641
|
+
# @param [Google::Apis::RequestOptions] options
|
642
|
+
# Request-specific options
|
643
|
+
#
|
644
|
+
# @yield [result, err] Result & error if block supplied
|
645
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Item] parsed result object
|
646
|
+
# @yieldparam err [StandardError] error object if request failed
|
647
|
+
#
|
648
|
+
# @return [Google::Apis::CloudsearchV1::Item]
|
649
|
+
#
|
650
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
651
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
652
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
653
|
+
def push_item(name, push_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
654
|
+
command = make_simple_command(:post, 'v1/indexing/{+name}:push', options)
|
655
|
+
command.request_representation = Google::Apis::CloudsearchV1::PushItemRequest::Representation
|
656
|
+
command.request_object = push_item_request_object
|
657
|
+
command.response_representation = Google::Apis::CloudsearchV1::Item::Representation
|
658
|
+
command.response_class = Google::Apis::CloudsearchV1::Item
|
659
|
+
command.params['name'] = name unless name.nil?
|
660
|
+
command.query['fields'] = fields unless fields.nil?
|
661
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
662
|
+
execute_or_queue_command(command, &block)
|
663
|
+
end
|
664
|
+
|
665
|
+
# Unreserves all items from a queue, making them all eligible to be polled. This
|
666
|
+
# method is useful for resetting the indexing queue after a connector has been
|
667
|
+
# restarted. This API requires an admin or service account to execute. The
|
668
|
+
# service account used is the one whitelisted in the corresponding data source.
|
669
|
+
# @param [String] name
|
670
|
+
# Name of the Data Source to unreserve all items. Format: datasources/`source_id`
|
671
|
+
# @param [Google::Apis::CloudsearchV1::UnreserveItemsRequest] unreserve_items_request_object
|
672
|
+
# @param [String] fields
|
673
|
+
# Selector specifying which fields to include in a partial response.
|
674
|
+
# @param [String] quota_user
|
675
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
676
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
677
|
+
# @param [Google::Apis::RequestOptions] options
|
678
|
+
# Request-specific options
|
679
|
+
#
|
680
|
+
# @yield [result, err] Result & error if block supplied
|
681
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
682
|
+
# @yieldparam err [StandardError] error object if request failed
|
683
|
+
#
|
684
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
685
|
+
#
|
686
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
687
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
688
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
689
|
+
def unreserve_items(name, unreserve_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
690
|
+
command = make_simple_command(:post, 'v1/indexing/{+name}/items:unreserve', options)
|
691
|
+
command.request_representation = Google::Apis::CloudsearchV1::UnreserveItemsRequest::Representation
|
692
|
+
command.request_object = unreserve_items_request_object
|
693
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
694
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
695
|
+
command.params['name'] = name unless name.nil?
|
696
|
+
command.query['fields'] = fields unless fields.nil?
|
697
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
698
|
+
execute_or_queue_command(command, &block)
|
699
|
+
end
|
700
|
+
|
701
|
+
# Creates an upload session for uploading item content. For items smaller than
|
702
|
+
# 100 KB, it's easier to embed the content inline within an index request. This
|
703
|
+
# API requires an admin or service account to execute. The service account used
|
704
|
+
# is the one whitelisted in the corresponding data source.
|
705
|
+
# @param [String] name
|
706
|
+
# Name of the Item to start a resumable upload. Format: datasources/`source_id`/
|
707
|
+
# items/`item_id`. The maximum length is 1536 bytes.
|
708
|
+
# @param [Google::Apis::CloudsearchV1::StartUploadItemRequest] start_upload_item_request_object
|
709
|
+
# @param [String] fields
|
710
|
+
# Selector specifying which fields to include in a partial response.
|
711
|
+
# @param [String] quota_user
|
712
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
713
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
714
|
+
# @param [Google::Apis::RequestOptions] options
|
715
|
+
# Request-specific options
|
716
|
+
#
|
717
|
+
# @yield [result, err] Result & error if block supplied
|
718
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::UploadItemRef] parsed result object
|
719
|
+
# @yieldparam err [StandardError] error object if request failed
|
720
|
+
#
|
721
|
+
# @return [Google::Apis::CloudsearchV1::UploadItemRef]
|
722
|
+
#
|
723
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
724
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
725
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
726
|
+
def upload_indexing_datasource_item(name, start_upload_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
727
|
+
command = make_simple_command(:post, 'v1/indexing/{+name}:upload', options)
|
728
|
+
command.request_representation = Google::Apis::CloudsearchV1::StartUploadItemRequest::Representation
|
729
|
+
command.request_object = start_upload_item_request_object
|
730
|
+
command.response_representation = Google::Apis::CloudsearchV1::UploadItemRef::Representation
|
731
|
+
command.response_class = Google::Apis::CloudsearchV1::UploadItemRef
|
732
|
+
command.params['name'] = name unless name.nil?
|
733
|
+
command.query['fields'] = fields unless fields.nil?
|
734
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
735
|
+
execute_or_queue_command(command, &block)
|
736
|
+
end
|
737
|
+
|
738
|
+
# Uploads media for indexing. The upload endpoint supports direct and resumable
|
739
|
+
# upload protocols and is intended for large items that can not be [inlined
|
740
|
+
# during index requests](https://developers.google.com/cloud-search/docs/
|
741
|
+
# reference/rest/v1/indexing.datasources.items#itemcontent). To index large
|
742
|
+
# content: 1. Call indexing.datasources.items.upload with the item name to begin
|
743
|
+
# an upload session and retrieve the UploadItemRef. 1. Call media.upload to
|
744
|
+
# upload the content, as a streaming request, using the same resource name from
|
745
|
+
# the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to
|
746
|
+
# index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/
|
747
|
+
# v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1.
|
748
|
+
# For additional information, see [Create a content connector using the REST API]
|
749
|
+
# (https://developers.google.com/cloud-search/docs/guides/content-connector#rest)
|
750
|
+
# . **Note:** This API requires a service account to execute.
|
751
|
+
# @param [String] resource_name
|
752
|
+
# Name of the media that is being downloaded. See ReadRequest.resource_name.
|
753
|
+
# @param [Google::Apis::CloudsearchV1::Media] media_object
|
754
|
+
# @param [String] fields
|
755
|
+
# Selector specifying which fields to include in a partial response.
|
756
|
+
# @param [String] quota_user
|
757
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
758
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
759
|
+
# @param [IO, String] upload_source
|
760
|
+
# IO stream or filename containing content to upload
|
761
|
+
# @param [String] content_type
|
762
|
+
# Content type of the uploaded content.
|
763
|
+
# @param [Google::Apis::RequestOptions] options
|
764
|
+
# Request-specific options
|
765
|
+
#
|
766
|
+
# @yield [result, err] Result & error if block supplied
|
767
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Media] parsed result object
|
768
|
+
# @yieldparam err [StandardError] error object if request failed
|
769
|
+
#
|
770
|
+
# @return [Google::Apis::CloudsearchV1::Media]
|
771
|
+
#
|
772
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
773
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
774
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
775
|
+
def upload_medium(resource_name, media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
776
|
+
if upload_source.nil?
|
777
|
+
command = make_simple_command(:post, 'v1/media/{+resourceName}', options)
|
778
|
+
else
|
779
|
+
command = make_upload_command(:post, 'v1/media/{+resourceName}', options)
|
780
|
+
command.upload_source = upload_source
|
781
|
+
command.upload_content_type = content_type
|
782
|
+
end
|
783
|
+
command.request_representation = Google::Apis::CloudsearchV1::Media::Representation
|
784
|
+
command.request_object = media_object
|
785
|
+
command.response_representation = Google::Apis::CloudsearchV1::Media::Representation
|
786
|
+
command.response_class = Google::Apis::CloudsearchV1::Media
|
787
|
+
command.params['resourceName'] = resource_name unless resource_name.nil?
|
788
|
+
command.query['fields'] = fields unless fields.nil?
|
789
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
790
|
+
execute_or_queue_command(command, &block)
|
791
|
+
end
|
792
|
+
|
793
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
794
|
+
# to poll the operation result at intervals as recommended by the API service.
|
795
|
+
# @param [String] name
|
796
|
+
# The name of the operation resource.
|
797
|
+
# @param [String] fields
|
798
|
+
# Selector specifying which fields to include in a partial response.
|
799
|
+
# @param [String] quota_user
|
800
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
801
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
802
|
+
# @param [Google::Apis::RequestOptions] options
|
803
|
+
# Request-specific options
|
804
|
+
#
|
805
|
+
# @yield [result, err] Result & error if block supplied
|
806
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
807
|
+
# @yieldparam err [StandardError] error object if request failed
|
808
|
+
#
|
809
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
810
|
+
#
|
811
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
812
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
813
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
814
|
+
def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
815
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
816
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
817
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
818
|
+
command.params['name'] = name unless name.nil?
|
819
|
+
command.query['fields'] = fields unless fields.nil?
|
820
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
821
|
+
execute_or_queue_command(command, &block)
|
822
|
+
end
|
823
|
+
|
824
|
+
# Lists operations that match the specified filter in the request. If the server
|
825
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
826
|
+
# binding allows API services to override the binding to use different resource
|
827
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
828
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
829
|
+
# service configuration. For backwards compatibility, the default name includes
|
830
|
+
# the operations collection id, however overriding users must ensure the name
|
831
|
+
# binding is the parent resource, without the operations collection id.
|
832
|
+
# @param [String] name
|
833
|
+
# The name of the operation's parent resource.
|
834
|
+
# @param [String] filter
|
835
|
+
# The standard list filter.
|
836
|
+
# @param [Fixnum] page_size
|
837
|
+
# The standard list page size.
|
838
|
+
# @param [String] page_token
|
839
|
+
# The standard list page token.
|
840
|
+
# @param [String] fields
|
841
|
+
# Selector specifying which fields to include in a partial response.
|
842
|
+
# @param [String] quota_user
|
843
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
844
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
845
|
+
# @param [Google::Apis::RequestOptions] options
|
846
|
+
# Request-specific options
|
847
|
+
#
|
848
|
+
# @yield [result, err] Result & error if block supplied
|
849
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::ListOperationsResponse] parsed result object
|
850
|
+
# @yieldparam err [StandardError] error object if request failed
|
851
|
+
#
|
852
|
+
# @return [Google::Apis::CloudsearchV1::ListOperationsResponse]
|
853
|
+
#
|
854
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
855
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
856
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
857
|
+
def list_operation_lros(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
858
|
+
command = make_simple_command(:get, 'v1/{+name}/lro', options)
|
859
|
+
command.response_representation = Google::Apis::CloudsearchV1::ListOperationsResponse::Representation
|
860
|
+
command.response_class = Google::Apis::CloudsearchV1::ListOperationsResponse
|
861
|
+
command.params['name'] = name unless name.nil?
|
862
|
+
command.query['filter'] = filter unless filter.nil?
|
863
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
864
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
865
|
+
command.query['fields'] = fields unless fields.nil?
|
866
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
867
|
+
execute_or_queue_command(command, &block)
|
868
|
+
end
|
869
|
+
|
870
|
+
# The Cloud Search Query API provides the search method, which returns the most
|
871
|
+
# relevant results from a user query. The results can come from G Suite Apps,
|
872
|
+
# such as Gmail or Google Drive, or they can come from data that you have
|
873
|
+
# indexed from a third party. **Note:** This API requires a standard end user
|
874
|
+
# account to execute. A service account can't perform Query API requests
|
875
|
+
# directly; to use a service account to perform queries, set up [G Suite domain-
|
876
|
+
# wide delegation of authority](https://developers.google.com/cloud-search/docs/
|
877
|
+
# guides/delegation/).
|
878
|
+
# @param [Google::Apis::CloudsearchV1::SearchRequest] search_request_object
|
879
|
+
# @param [String] fields
|
880
|
+
# Selector specifying which fields to include in a partial response.
|
881
|
+
# @param [String] quota_user
|
882
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
883
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
884
|
+
# @param [Google::Apis::RequestOptions] options
|
885
|
+
# Request-specific options
|
886
|
+
#
|
887
|
+
# @yield [result, err] Result & error if block supplied
|
888
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::SearchResponse] parsed result object
|
889
|
+
# @yieldparam err [StandardError] error object if request failed
|
890
|
+
#
|
891
|
+
# @return [Google::Apis::CloudsearchV1::SearchResponse]
|
892
|
+
#
|
893
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
894
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
895
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
896
|
+
def search_query(search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
897
|
+
command = make_simple_command(:post, 'v1/query/search', options)
|
898
|
+
command.request_representation = Google::Apis::CloudsearchV1::SearchRequest::Representation
|
899
|
+
command.request_object = search_request_object
|
900
|
+
command.response_representation = Google::Apis::CloudsearchV1::SearchResponse::Representation
|
901
|
+
command.response_class = Google::Apis::CloudsearchV1::SearchResponse
|
902
|
+
command.query['fields'] = fields unless fields.nil?
|
903
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
904
|
+
execute_or_queue_command(command, &block)
|
905
|
+
end
|
906
|
+
|
907
|
+
# Provides suggestions for autocompleting the query. **Note:** This API requires
|
908
|
+
# a standard end user account to execute. A service account can't perform Query
|
909
|
+
# API requests directly; to use a service account to perform queries, set up [G
|
910
|
+
# Suite domain-wide delegation of authority](https://developers.google.com/cloud-
|
911
|
+
# search/docs/guides/delegation/).
|
912
|
+
# @param [Google::Apis::CloudsearchV1::SuggestRequest] suggest_request_object
|
913
|
+
# @param [String] fields
|
914
|
+
# Selector specifying which fields to include in a partial response.
|
915
|
+
# @param [String] quota_user
|
916
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
917
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
918
|
+
# @param [Google::Apis::RequestOptions] options
|
919
|
+
# Request-specific options
|
920
|
+
#
|
921
|
+
# @yield [result, err] Result & error if block supplied
|
922
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::SuggestResponse] parsed result object
|
923
|
+
# @yieldparam err [StandardError] error object if request failed
|
924
|
+
#
|
925
|
+
# @return [Google::Apis::CloudsearchV1::SuggestResponse]
|
926
|
+
#
|
927
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
928
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
929
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
930
|
+
def suggest_query(suggest_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
931
|
+
command = make_simple_command(:post, 'v1/query/suggest', options)
|
932
|
+
command.request_representation = Google::Apis::CloudsearchV1::SuggestRequest::Representation
|
933
|
+
command.request_object = suggest_request_object
|
934
|
+
command.response_representation = Google::Apis::CloudsearchV1::SuggestResponse::Representation
|
935
|
+
command.response_class = Google::Apis::CloudsearchV1::SuggestResponse
|
936
|
+
command.query['fields'] = fields unless fields.nil?
|
937
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
938
|
+
execute_or_queue_command(command, &block)
|
939
|
+
end
|
940
|
+
|
941
|
+
# Returns list of sources that user can use for Search and Suggest APIs. **Note:*
|
942
|
+
# * This API requires a standard end user account to execute. A service account
|
943
|
+
# can't perform Query API requests directly; to use a service account to perform
|
944
|
+
# queries, set up [G Suite domain-wide delegation of authority](https://
|
945
|
+
# developers.google.com/cloud-search/docs/guides/delegation/).
|
946
|
+
# @param [String] page_token
|
947
|
+
# Number of sources to return in the response.
|
948
|
+
# @param [Boolean] request_options_debug_options_enable_debugging
|
949
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
950
|
+
# ignore this field.
|
951
|
+
# @param [String] request_options_language_code
|
952
|
+
# The BCP-47 language code, such as "en-US" or "sr-Latn". For more information,
|
953
|
+
# see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For
|
954
|
+
# translations. Set this field using the language set in browser or for the page.
|
955
|
+
# In the event that the user's language preference is known, set this field to
|
956
|
+
# the known user language. When specified, the documents in search results are
|
957
|
+
# biased towards the specified language. The suggest API does not use this
|
958
|
+
# parameter. Instead, suggest autocompletes only based on characters in the
|
959
|
+
# query.
|
960
|
+
# @param [String] request_options_search_application_id
|
961
|
+
# The ID generated when you create a search application using the [admin console]
|
962
|
+
# (https://support.google.com/a/answer/9043922).
|
963
|
+
# @param [String] request_options_time_zone
|
964
|
+
# Current user's time zone id, such as "America/Los_Angeles" or "Australia/
|
965
|
+
# Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)
|
966
|
+
# ](http://cldr.unicode.org/) project, and currently available in the file [
|
967
|
+
# timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml).
|
968
|
+
# This field is used to correctly interpret date and time queries. If this field
|
969
|
+
# is not specified, the default time zone (UTC) is used.
|
970
|
+
# @param [String] fields
|
971
|
+
# Selector specifying which fields to include in a partial response.
|
972
|
+
# @param [String] quota_user
|
973
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
974
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
975
|
+
# @param [Google::Apis::RequestOptions] options
|
976
|
+
# Request-specific options
|
977
|
+
#
|
978
|
+
# @yield [result, err] Result & error if block supplied
|
979
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::ListQuerySourcesResponse] parsed result object
|
980
|
+
# @yieldparam err [StandardError] error object if request failed
|
981
|
+
#
|
982
|
+
# @return [Google::Apis::CloudsearchV1::ListQuerySourcesResponse]
|
983
|
+
#
|
984
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
985
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
986
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
987
|
+
def list_query_sources(page_token: nil, request_options_debug_options_enable_debugging: nil, request_options_language_code: nil, request_options_search_application_id: nil, request_options_time_zone: nil, fields: nil, quota_user: nil, options: nil, &block)
|
988
|
+
command = make_simple_command(:get, 'v1/query/sources', options)
|
989
|
+
command.response_representation = Google::Apis::CloudsearchV1::ListQuerySourcesResponse::Representation
|
990
|
+
command.response_class = Google::Apis::CloudsearchV1::ListQuerySourcesResponse
|
991
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
992
|
+
command.query['requestOptions.debugOptions.enableDebugging'] = request_options_debug_options_enable_debugging unless request_options_debug_options_enable_debugging.nil?
|
993
|
+
command.query['requestOptions.languageCode'] = request_options_language_code unless request_options_language_code.nil?
|
994
|
+
command.query['requestOptions.searchApplicationId'] = request_options_search_application_id unless request_options_search_application_id.nil?
|
995
|
+
command.query['requestOptions.timeZone'] = request_options_time_zone unless request_options_time_zone.nil?
|
996
|
+
command.query['fields'] = fields unless fields.nil?
|
997
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
998
|
+
execute_or_queue_command(command, &block)
|
999
|
+
end
|
1000
|
+
|
1001
|
+
# Creates a datasource. **Note:** This API requires an admin account to execute.
|
1002
|
+
# @param [Google::Apis::CloudsearchV1::DataSource] data_source_object
|
1003
|
+
# @param [String] fields
|
1004
|
+
# Selector specifying which fields to include in a partial response.
|
1005
|
+
# @param [String] quota_user
|
1006
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1007
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1008
|
+
# @param [Google::Apis::RequestOptions] options
|
1009
|
+
# Request-specific options
|
1010
|
+
#
|
1011
|
+
# @yield [result, err] Result & error if block supplied
|
1012
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
1013
|
+
# @yieldparam err [StandardError] error object if request failed
|
1014
|
+
#
|
1015
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
1016
|
+
#
|
1017
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1018
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1019
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1020
|
+
def create_setting_datasource(data_source_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1021
|
+
command = make_simple_command(:post, 'v1/settings/datasources', options)
|
1022
|
+
command.request_representation = Google::Apis::CloudsearchV1::DataSource::Representation
|
1023
|
+
command.request_object = data_source_object
|
1024
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
1025
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
1026
|
+
command.query['fields'] = fields unless fields.nil?
|
1027
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1028
|
+
execute_or_queue_command(command, &block)
|
1029
|
+
end
|
1030
|
+
|
1031
|
+
# Deletes a datasource. **Note:** This API requires an admin account to execute.
|
1032
|
+
# @param [String] name
|
1033
|
+
# Name of the datasource. Format: datasources/`source_id`.
|
1034
|
+
# @param [Boolean] debug_options_enable_debugging
|
1035
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
1036
|
+
# ignore this field.
|
1037
|
+
# @param [String] fields
|
1038
|
+
# Selector specifying which fields to include in a partial response.
|
1039
|
+
# @param [String] quota_user
|
1040
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1041
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1042
|
+
# @param [Google::Apis::RequestOptions] options
|
1043
|
+
# Request-specific options
|
1044
|
+
#
|
1045
|
+
# @yield [result, err] Result & error if block supplied
|
1046
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
1047
|
+
# @yieldparam err [StandardError] error object if request failed
|
1048
|
+
#
|
1049
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
1050
|
+
#
|
1051
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1052
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1053
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1054
|
+
def delete_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1055
|
+
command = make_simple_command(:delete, 'v1/settings/{+name}', options)
|
1056
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
1057
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
1058
|
+
command.params['name'] = name unless name.nil?
|
1059
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
1060
|
+
command.query['fields'] = fields unless fields.nil?
|
1061
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1062
|
+
execute_or_queue_command(command, &block)
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
# Gets a datasource. **Note:** This API requires an admin account to execute.
|
1066
|
+
# @param [String] name
|
1067
|
+
# Name of the datasource resource. Format: datasources/`source_id`.
|
1068
|
+
# @param [Boolean] debug_options_enable_debugging
|
1069
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
1070
|
+
# ignore this field.
|
1071
|
+
# @param [String] fields
|
1072
|
+
# Selector specifying which fields to include in a partial response.
|
1073
|
+
# @param [String] quota_user
|
1074
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1075
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1076
|
+
# @param [Google::Apis::RequestOptions] options
|
1077
|
+
# Request-specific options
|
1078
|
+
#
|
1079
|
+
# @yield [result, err] Result & error if block supplied
|
1080
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::DataSource] parsed result object
|
1081
|
+
# @yieldparam err [StandardError] error object if request failed
|
1082
|
+
#
|
1083
|
+
# @return [Google::Apis::CloudsearchV1::DataSource]
|
1084
|
+
#
|
1085
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1086
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1087
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1088
|
+
def get_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1089
|
+
command = make_simple_command(:get, 'v1/settings/{+name}', options)
|
1090
|
+
command.response_representation = Google::Apis::CloudsearchV1::DataSource::Representation
|
1091
|
+
command.response_class = Google::Apis::CloudsearchV1::DataSource
|
1092
|
+
command.params['name'] = name unless name.nil?
|
1093
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
1094
|
+
command.query['fields'] = fields unless fields.nil?
|
1095
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1096
|
+
execute_or_queue_command(command, &block)
|
1097
|
+
end
|
1098
|
+
|
1099
|
+
# Lists datasources. **Note:** This API requires an admin account to execute.
|
1100
|
+
# @param [Boolean] debug_options_enable_debugging
|
1101
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
1102
|
+
# ignore this field.
|
1103
|
+
# @param [Fixnum] page_size
|
1104
|
+
# Maximum number of datasources to fetch in a request. The max value is 100. The
|
1105
|
+
# default value is 10
|
1106
|
+
# @param [String] page_token
|
1107
|
+
# Starting index of the results.
|
1108
|
+
# @param [String] fields
|
1109
|
+
# Selector specifying which fields to include in a partial response.
|
1110
|
+
# @param [String] quota_user
|
1111
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1112
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1113
|
+
# @param [Google::Apis::RequestOptions] options
|
1114
|
+
# Request-specific options
|
1115
|
+
#
|
1116
|
+
# @yield [result, err] Result & error if block supplied
|
1117
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::ListDataSourceResponse] parsed result object
|
1118
|
+
# @yieldparam err [StandardError] error object if request failed
|
1119
|
+
#
|
1120
|
+
# @return [Google::Apis::CloudsearchV1::ListDataSourceResponse]
|
1121
|
+
#
|
1122
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1123
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1124
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1125
|
+
def list_setting_datasources(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1126
|
+
command = make_simple_command(:get, 'v1/settings/datasources', options)
|
1127
|
+
command.response_representation = Google::Apis::CloudsearchV1::ListDataSourceResponse::Representation
|
1128
|
+
command.response_class = Google::Apis::CloudsearchV1::ListDataSourceResponse
|
1129
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
1130
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1131
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1132
|
+
command.query['fields'] = fields unless fields.nil?
|
1133
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1134
|
+
execute_or_queue_command(command, &block)
|
1135
|
+
end
|
1136
|
+
|
1137
|
+
# Updates a datasource. **Note:** This API requires an admin account to execute.
|
1138
|
+
# @param [String] name
|
1139
|
+
# Name of the datasource resource. Format: datasources/`source_id`. The name is
|
1140
|
+
# ignored when creating a datasource.
|
1141
|
+
# @param [Google::Apis::CloudsearchV1::UpdateDataSourceRequest] update_data_source_request_object
|
1142
|
+
# @param [String] fields
|
1143
|
+
# Selector specifying which fields to include in a partial response.
|
1144
|
+
# @param [String] quota_user
|
1145
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1146
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1147
|
+
# @param [Google::Apis::RequestOptions] options
|
1148
|
+
# Request-specific options
|
1149
|
+
#
|
1150
|
+
# @yield [result, err] Result & error if block supplied
|
1151
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
1152
|
+
# @yieldparam err [StandardError] error object if request failed
|
1153
|
+
#
|
1154
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
1155
|
+
#
|
1156
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1157
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1158
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1159
|
+
def update_datasource_data_source(name, update_data_source_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1160
|
+
command = make_simple_command(:put, 'v1/settings/{+name}', options)
|
1161
|
+
command.request_representation = Google::Apis::CloudsearchV1::UpdateDataSourceRequest::Representation
|
1162
|
+
command.request_object = update_data_source_request_object
|
1163
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
1164
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
1165
|
+
command.params['name'] = name unless name.nil?
|
1166
|
+
command.query['fields'] = fields unless fields.nil?
|
1167
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1168
|
+
execute_or_queue_command(command, &block)
|
1169
|
+
end
|
1170
|
+
|
1171
|
+
# Creates a search application. **Note:** This API requires an admin account to
|
1172
|
+
# execute.
|
1173
|
+
# @param [Google::Apis::CloudsearchV1::SearchApplication] search_application_object
|
1174
|
+
# @param [String] fields
|
1175
|
+
# Selector specifying which fields to include in a partial response.
|
1176
|
+
# @param [String] quota_user
|
1177
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1178
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1179
|
+
# @param [Google::Apis::RequestOptions] options
|
1180
|
+
# Request-specific options
|
1181
|
+
#
|
1182
|
+
# @yield [result, err] Result & error if block supplied
|
1183
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
1184
|
+
# @yieldparam err [StandardError] error object if request failed
|
1185
|
+
#
|
1186
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
1187
|
+
#
|
1188
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1189
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1190
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1191
|
+
def create_setting_searchapplication(search_application_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1192
|
+
command = make_simple_command(:post, 'v1/settings/searchapplications', options)
|
1193
|
+
command.request_representation = Google::Apis::CloudsearchV1::SearchApplication::Representation
|
1194
|
+
command.request_object = search_application_object
|
1195
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
1196
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
1197
|
+
command.query['fields'] = fields unless fields.nil?
|
1198
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1199
|
+
execute_or_queue_command(command, &block)
|
1200
|
+
end
|
1201
|
+
|
1202
|
+
# Deletes a search application. **Note:** This API requires an admin account to
|
1203
|
+
# execute.
|
1204
|
+
# @param [String] name
|
1205
|
+
# The name of the search application to be deleted. Format: applications/`
|
1206
|
+
# application_id`.
|
1207
|
+
# @param [Boolean] debug_options_enable_debugging
|
1208
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
1209
|
+
# ignore this field.
|
1210
|
+
# @param [String] fields
|
1211
|
+
# Selector specifying which fields to include in a partial response.
|
1212
|
+
# @param [String] quota_user
|
1213
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1214
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1215
|
+
# @param [Google::Apis::RequestOptions] options
|
1216
|
+
# Request-specific options
|
1217
|
+
#
|
1218
|
+
# @yield [result, err] Result & error if block supplied
|
1219
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
1220
|
+
# @yieldparam err [StandardError] error object if request failed
|
1221
|
+
#
|
1222
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
1223
|
+
#
|
1224
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1225
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1226
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1227
|
+
def delete_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1228
|
+
command = make_simple_command(:delete, 'v1/settings/{+name}', options)
|
1229
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
1230
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
1231
|
+
command.params['name'] = name unless name.nil?
|
1232
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
1233
|
+
command.query['fields'] = fields unless fields.nil?
|
1234
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1235
|
+
execute_or_queue_command(command, &block)
|
1236
|
+
end
|
1237
|
+
|
1238
|
+
# Gets the specified search application. **Note:** This API requires an admin
|
1239
|
+
# account to execute.
|
1240
|
+
# @param [String] name
|
1241
|
+
# Name of the search application. Format: searchapplications/`application_id`.
|
1242
|
+
# @param [Boolean] debug_options_enable_debugging
|
1243
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
1244
|
+
# ignore this field.
|
1245
|
+
# @param [String] fields
|
1246
|
+
# Selector specifying which fields to include in a partial response.
|
1247
|
+
# @param [String] quota_user
|
1248
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1249
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1250
|
+
# @param [Google::Apis::RequestOptions] options
|
1251
|
+
# Request-specific options
|
1252
|
+
#
|
1253
|
+
# @yield [result, err] Result & error if block supplied
|
1254
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::SearchApplication] parsed result object
|
1255
|
+
# @yieldparam err [StandardError] error object if request failed
|
1256
|
+
#
|
1257
|
+
# @return [Google::Apis::CloudsearchV1::SearchApplication]
|
1258
|
+
#
|
1259
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1260
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1261
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1262
|
+
def get_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1263
|
+
command = make_simple_command(:get, 'v1/settings/{+name}', options)
|
1264
|
+
command.response_representation = Google::Apis::CloudsearchV1::SearchApplication::Representation
|
1265
|
+
command.response_class = Google::Apis::CloudsearchV1::SearchApplication
|
1266
|
+
command.params['name'] = name unless name.nil?
|
1267
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
1268
|
+
command.query['fields'] = fields unless fields.nil?
|
1269
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1270
|
+
execute_or_queue_command(command, &block)
|
1271
|
+
end
|
1272
|
+
|
1273
|
+
# Lists all search applications. **Note:** This API requires an admin account to
|
1274
|
+
# execute.
|
1275
|
+
# @param [Boolean] debug_options_enable_debugging
|
1276
|
+
# If you are asked by Google to help with debugging, set this field. Otherwise,
|
1277
|
+
# ignore this field.
|
1278
|
+
# @param [Fixnum] page_size
|
1279
|
+
# The maximum number of items to return.
|
1280
|
+
# @param [String] page_token
|
1281
|
+
# The next_page_token value returned from a previous List request, if any. The
|
1282
|
+
# default value is 10
|
1283
|
+
# @param [String] fields
|
1284
|
+
# Selector specifying which fields to include in a partial response.
|
1285
|
+
# @param [String] quota_user
|
1286
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1287
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1288
|
+
# @param [Google::Apis::RequestOptions] options
|
1289
|
+
# Request-specific options
|
1290
|
+
#
|
1291
|
+
# @yield [result, err] Result & error if block supplied
|
1292
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::ListSearchApplicationsResponse] parsed result object
|
1293
|
+
# @yieldparam err [StandardError] error object if request failed
|
1294
|
+
#
|
1295
|
+
# @return [Google::Apis::CloudsearchV1::ListSearchApplicationsResponse]
|
1296
|
+
#
|
1297
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1298
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1299
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1300
|
+
def list_setting_searchapplications(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1301
|
+
command = make_simple_command(:get, 'v1/settings/searchapplications', options)
|
1302
|
+
command.response_representation = Google::Apis::CloudsearchV1::ListSearchApplicationsResponse::Representation
|
1303
|
+
command.response_class = Google::Apis::CloudsearchV1::ListSearchApplicationsResponse
|
1304
|
+
command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil?
|
1305
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1306
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1307
|
+
command.query['fields'] = fields unless fields.nil?
|
1308
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1309
|
+
execute_or_queue_command(command, &block)
|
1310
|
+
end
|
1311
|
+
|
1312
|
+
# Resets a search application to default settings. This will return an empty
|
1313
|
+
# response. **Note:** This API requires an admin account to execute.
|
1314
|
+
# @param [String] name
|
1315
|
+
# The name of the search application to be reset. Format: applications/`
|
1316
|
+
# application_id`.
|
1317
|
+
# @param [Google::Apis::CloudsearchV1::ResetSearchApplicationRequest] reset_search_application_request_object
|
1318
|
+
# @param [String] fields
|
1319
|
+
# Selector specifying which fields to include in a partial response.
|
1320
|
+
# @param [String] quota_user
|
1321
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1322
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1323
|
+
# @param [Google::Apis::RequestOptions] options
|
1324
|
+
# Request-specific options
|
1325
|
+
#
|
1326
|
+
# @yield [result, err] Result & error if block supplied
|
1327
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
1328
|
+
# @yieldparam err [StandardError] error object if request failed
|
1329
|
+
#
|
1330
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
1331
|
+
#
|
1332
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1333
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1334
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1335
|
+
def reset_searchapplication_search_application(name, reset_search_application_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1336
|
+
command = make_simple_command(:post, 'v1/settings/{+name}:reset', options)
|
1337
|
+
command.request_representation = Google::Apis::CloudsearchV1::ResetSearchApplicationRequest::Representation
|
1338
|
+
command.request_object = reset_search_application_request_object
|
1339
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
1340
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
1341
|
+
command.params['name'] = name unless name.nil?
|
1342
|
+
command.query['fields'] = fields unless fields.nil?
|
1343
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1344
|
+
execute_or_queue_command(command, &block)
|
1345
|
+
end
|
1346
|
+
|
1347
|
+
# Updates a search application. **Note:** This API requires an admin account to
|
1348
|
+
# execute.
|
1349
|
+
# @param [String] name
|
1350
|
+
# Name of the Search Application. Format: searchapplications/`application_id`.
|
1351
|
+
# @param [Google::Apis::CloudsearchV1::SearchApplication] search_application_object
|
1352
|
+
# @param [String] fields
|
1353
|
+
# Selector specifying which fields to include in a partial response.
|
1354
|
+
# @param [String] quota_user
|
1355
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1356
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1357
|
+
# @param [Google::Apis::RequestOptions] options
|
1358
|
+
# Request-specific options
|
1359
|
+
#
|
1360
|
+
# @yield [result, err] Result & error if block supplied
|
1361
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::Operation] parsed result object
|
1362
|
+
# @yieldparam err [StandardError] error object if request failed
|
1363
|
+
#
|
1364
|
+
# @return [Google::Apis::CloudsearchV1::Operation]
|
1365
|
+
#
|
1366
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1367
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1368
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1369
|
+
def update_setting_searchapplication(name, search_application_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1370
|
+
command = make_simple_command(:put, 'v1/settings/{+name}', options)
|
1371
|
+
command.request_representation = Google::Apis::CloudsearchV1::SearchApplication::Representation
|
1372
|
+
command.request_object = search_application_object
|
1373
|
+
command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation
|
1374
|
+
command.response_class = Google::Apis::CloudsearchV1::Operation
|
1375
|
+
command.params['name'] = name unless name.nil?
|
1376
|
+
command.query['fields'] = fields unless fields.nil?
|
1377
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1378
|
+
execute_or_queue_command(command, &block)
|
1379
|
+
end
|
1380
|
+
|
1381
|
+
# Gets indexed item statistics aggreggated across all data sources. This API
|
1382
|
+
# only returns statistics for previous dates; it doesn't return statistics for
|
1383
|
+
# the current day. **Note:** This API requires a standard end user account to
|
1384
|
+
# execute.
|
1385
|
+
# @param [Fixnum] from_date_day
|
1386
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1387
|
+
# @param [Fixnum] from_date_month
|
1388
|
+
# Month of date. Must be from 1 to 12.
|
1389
|
+
# @param [Fixnum] from_date_year
|
1390
|
+
# Year of date. Must be from 1 to 9999.
|
1391
|
+
# @param [Fixnum] to_date_day
|
1392
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1393
|
+
# @param [Fixnum] to_date_month
|
1394
|
+
# Month of date. Must be from 1 to 12.
|
1395
|
+
# @param [Fixnum] to_date_year
|
1396
|
+
# Year of date. Must be from 1 to 9999.
|
1397
|
+
# @param [String] fields
|
1398
|
+
# Selector specifying which fields to include in a partial response.
|
1399
|
+
# @param [String] quota_user
|
1400
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1401
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1402
|
+
# @param [Google::Apis::RequestOptions] options
|
1403
|
+
# Request-specific options
|
1404
|
+
#
|
1405
|
+
# @yield [result, err] Result & error if block supplied
|
1406
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse] parsed result object
|
1407
|
+
# @yieldparam err [StandardError] error object if request failed
|
1408
|
+
#
|
1409
|
+
# @return [Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse]
|
1410
|
+
#
|
1411
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1412
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1413
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1414
|
+
def get_stat_index(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1415
|
+
command = make_simple_command(:get, 'v1/stats/index', options)
|
1416
|
+
command.response_representation = Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse::Representation
|
1417
|
+
command.response_class = Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse
|
1418
|
+
command.query['fromDate.day'] = from_date_day unless from_date_day.nil?
|
1419
|
+
command.query['fromDate.month'] = from_date_month unless from_date_month.nil?
|
1420
|
+
command.query['fromDate.year'] = from_date_year unless from_date_year.nil?
|
1421
|
+
command.query['toDate.day'] = to_date_day unless to_date_day.nil?
|
1422
|
+
command.query['toDate.month'] = to_date_month unless to_date_month.nil?
|
1423
|
+
command.query['toDate.year'] = to_date_year unless to_date_year.nil?
|
1424
|
+
command.query['fields'] = fields unless fields.nil?
|
1425
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1426
|
+
execute_or_queue_command(command, &block)
|
1427
|
+
end
|
1428
|
+
|
1429
|
+
# Get the query statistics for customer. **Note:** This API requires a standard
|
1430
|
+
# end user account to execute.
|
1431
|
+
# @param [Fixnum] from_date_day
|
1432
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1433
|
+
# @param [Fixnum] from_date_month
|
1434
|
+
# Month of date. Must be from 1 to 12.
|
1435
|
+
# @param [Fixnum] from_date_year
|
1436
|
+
# Year of date. Must be from 1 to 9999.
|
1437
|
+
# @param [Fixnum] to_date_day
|
1438
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1439
|
+
# @param [Fixnum] to_date_month
|
1440
|
+
# Month of date. Must be from 1 to 12.
|
1441
|
+
# @param [Fixnum] to_date_year
|
1442
|
+
# Year of date. Must be from 1 to 9999.
|
1443
|
+
# @param [String] fields
|
1444
|
+
# Selector specifying which fields to include in a partial response.
|
1445
|
+
# @param [String] quota_user
|
1446
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1447
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1448
|
+
# @param [Google::Apis::RequestOptions] options
|
1449
|
+
# Request-specific options
|
1450
|
+
#
|
1451
|
+
# @yield [result, err] Result & error if block supplied
|
1452
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::GetCustomerQueryStatsResponse] parsed result object
|
1453
|
+
# @yieldparam err [StandardError] error object if request failed
|
1454
|
+
#
|
1455
|
+
# @return [Google::Apis::CloudsearchV1::GetCustomerQueryStatsResponse]
|
1456
|
+
#
|
1457
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1458
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1459
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1460
|
+
def get_stat_query(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1461
|
+
command = make_simple_command(:get, 'v1/stats/query', options)
|
1462
|
+
command.response_representation = Google::Apis::CloudsearchV1::GetCustomerQueryStatsResponse::Representation
|
1463
|
+
command.response_class = Google::Apis::CloudsearchV1::GetCustomerQueryStatsResponse
|
1464
|
+
command.query['fromDate.day'] = from_date_day unless from_date_day.nil?
|
1465
|
+
command.query['fromDate.month'] = from_date_month unless from_date_month.nil?
|
1466
|
+
command.query['fromDate.year'] = from_date_year unless from_date_year.nil?
|
1467
|
+
command.query['toDate.day'] = to_date_day unless to_date_day.nil?
|
1468
|
+
command.query['toDate.month'] = to_date_month unless to_date_month.nil?
|
1469
|
+
command.query['toDate.year'] = to_date_year unless to_date_year.nil?
|
1470
|
+
command.query['fields'] = fields unless fields.nil?
|
1471
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1472
|
+
execute_or_queue_command(command, &block)
|
1473
|
+
end
|
1474
|
+
|
1475
|
+
# Get the # of search sessions, % of successful sessions with a click query
|
1476
|
+
# statistics for customer. **Note:** This API requires a standard end user
|
1477
|
+
# account to execute.
|
1478
|
+
# @param [Fixnum] from_date_day
|
1479
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1480
|
+
# @param [Fixnum] from_date_month
|
1481
|
+
# Month of date. Must be from 1 to 12.
|
1482
|
+
# @param [Fixnum] from_date_year
|
1483
|
+
# Year of date. Must be from 1 to 9999.
|
1484
|
+
# @param [Fixnum] to_date_day
|
1485
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1486
|
+
# @param [Fixnum] to_date_month
|
1487
|
+
# Month of date. Must be from 1 to 12.
|
1488
|
+
# @param [Fixnum] to_date_year
|
1489
|
+
# Year of date. Must be from 1 to 9999.
|
1490
|
+
# @param [String] fields
|
1491
|
+
# Selector specifying which fields to include in a partial response.
|
1492
|
+
# @param [String] quota_user
|
1493
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1494
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1495
|
+
# @param [Google::Apis::RequestOptions] options
|
1496
|
+
# Request-specific options
|
1497
|
+
#
|
1498
|
+
# @yield [result, err] Result & error if block supplied
|
1499
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::GetCustomerSessionStatsResponse] parsed result object
|
1500
|
+
# @yieldparam err [StandardError] error object if request failed
|
1501
|
+
#
|
1502
|
+
# @return [Google::Apis::CloudsearchV1::GetCustomerSessionStatsResponse]
|
1503
|
+
#
|
1504
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1505
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1506
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1507
|
+
def get_stat_session(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1508
|
+
command = make_simple_command(:get, 'v1/stats/session', options)
|
1509
|
+
command.response_representation = Google::Apis::CloudsearchV1::GetCustomerSessionStatsResponse::Representation
|
1510
|
+
command.response_class = Google::Apis::CloudsearchV1::GetCustomerSessionStatsResponse
|
1511
|
+
command.query['fromDate.day'] = from_date_day unless from_date_day.nil?
|
1512
|
+
command.query['fromDate.month'] = from_date_month unless from_date_month.nil?
|
1513
|
+
command.query['fromDate.year'] = from_date_year unless from_date_year.nil?
|
1514
|
+
command.query['toDate.day'] = to_date_day unless to_date_day.nil?
|
1515
|
+
command.query['toDate.month'] = to_date_month unless to_date_month.nil?
|
1516
|
+
command.query['toDate.year'] = to_date_year unless to_date_year.nil?
|
1517
|
+
command.query['fields'] = fields unless fields.nil?
|
1518
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1519
|
+
execute_or_queue_command(command, &block)
|
1520
|
+
end
|
1521
|
+
|
1522
|
+
# Get the users statistics for customer. **Note:** This API requires a standard
|
1523
|
+
# end user account to execute.
|
1524
|
+
# @param [Fixnum] from_date_day
|
1525
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1526
|
+
# @param [Fixnum] from_date_month
|
1527
|
+
# Month of date. Must be from 1 to 12.
|
1528
|
+
# @param [Fixnum] from_date_year
|
1529
|
+
# Year of date. Must be from 1 to 9999.
|
1530
|
+
# @param [Fixnum] to_date_day
|
1531
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1532
|
+
# @param [Fixnum] to_date_month
|
1533
|
+
# Month of date. Must be from 1 to 12.
|
1534
|
+
# @param [Fixnum] to_date_year
|
1535
|
+
# Year of date. Must be from 1 to 9999.
|
1536
|
+
# @param [String] fields
|
1537
|
+
# Selector specifying which fields to include in a partial response.
|
1538
|
+
# @param [String] quota_user
|
1539
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1540
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1541
|
+
# @param [Google::Apis::RequestOptions] options
|
1542
|
+
# Request-specific options
|
1543
|
+
#
|
1544
|
+
# @yield [result, err] Result & error if block supplied
|
1545
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::GetCustomerUserStatsResponse] parsed result object
|
1546
|
+
# @yieldparam err [StandardError] error object if request failed
|
1547
|
+
#
|
1548
|
+
# @return [Google::Apis::CloudsearchV1::GetCustomerUserStatsResponse]
|
1549
|
+
#
|
1550
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1551
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1552
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1553
|
+
def get_stat_user(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1554
|
+
command = make_simple_command(:get, 'v1/stats/user', options)
|
1555
|
+
command.response_representation = Google::Apis::CloudsearchV1::GetCustomerUserStatsResponse::Representation
|
1556
|
+
command.response_class = Google::Apis::CloudsearchV1::GetCustomerUserStatsResponse
|
1557
|
+
command.query['fromDate.day'] = from_date_day unless from_date_day.nil?
|
1558
|
+
command.query['fromDate.month'] = from_date_month unless from_date_month.nil?
|
1559
|
+
command.query['fromDate.year'] = from_date_year unless from_date_year.nil?
|
1560
|
+
command.query['toDate.day'] = to_date_day unless to_date_day.nil?
|
1561
|
+
command.query['toDate.month'] = to_date_month unless to_date_month.nil?
|
1562
|
+
command.query['toDate.year'] = to_date_year unless to_date_year.nil?
|
1563
|
+
command.query['fields'] = fields unless fields.nil?
|
1564
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1565
|
+
execute_or_queue_command(command, &block)
|
1566
|
+
end
|
1567
|
+
|
1568
|
+
# Gets indexed item statistics for a single data source. **Note:** This API
|
1569
|
+
# requires a standard end user account to execute.
|
1570
|
+
# @param [String] name
|
1571
|
+
# The resource id of the data source to retrieve statistics for, in the
|
1572
|
+
# following format: "datasources/`source_id`"
|
1573
|
+
# @param [Fixnum] from_date_day
|
1574
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1575
|
+
# @param [Fixnum] from_date_month
|
1576
|
+
# Month of date. Must be from 1 to 12.
|
1577
|
+
# @param [Fixnum] from_date_year
|
1578
|
+
# Year of date. Must be from 1 to 9999.
|
1579
|
+
# @param [Fixnum] to_date_day
|
1580
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1581
|
+
# @param [Fixnum] to_date_month
|
1582
|
+
# Month of date. Must be from 1 to 12.
|
1583
|
+
# @param [Fixnum] to_date_year
|
1584
|
+
# Year of date. Must be from 1 to 9999.
|
1585
|
+
# @param [String] fields
|
1586
|
+
# Selector specifying which fields to include in a partial response.
|
1587
|
+
# @param [String] quota_user
|
1588
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1589
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1590
|
+
# @param [Google::Apis::RequestOptions] options
|
1591
|
+
# Request-specific options
|
1592
|
+
#
|
1593
|
+
# @yield [result, err] Result & error if block supplied
|
1594
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse] parsed result object
|
1595
|
+
# @yieldparam err [StandardError] error object if request failed
|
1596
|
+
#
|
1597
|
+
# @return [Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse]
|
1598
|
+
#
|
1599
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1600
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1601
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1602
|
+
def get_stat_index_datasource(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1603
|
+
command = make_simple_command(:get, 'v1/stats/index/{+name}', options)
|
1604
|
+
command.response_representation = Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse::Representation
|
1605
|
+
command.response_class = Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse
|
1606
|
+
command.params['name'] = name unless name.nil?
|
1607
|
+
command.query['fromDate.day'] = from_date_day unless from_date_day.nil?
|
1608
|
+
command.query['fromDate.month'] = from_date_month unless from_date_month.nil?
|
1609
|
+
command.query['fromDate.year'] = from_date_year unless from_date_year.nil?
|
1610
|
+
command.query['toDate.day'] = to_date_day unless to_date_day.nil?
|
1611
|
+
command.query['toDate.month'] = to_date_month unless to_date_month.nil?
|
1612
|
+
command.query['toDate.year'] = to_date_year unless to_date_year.nil?
|
1613
|
+
command.query['fields'] = fields unless fields.nil?
|
1614
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1615
|
+
execute_or_queue_command(command, &block)
|
1616
|
+
end
|
1617
|
+
|
1618
|
+
# Get the query statistics for search application. **Note:** This API requires a
|
1619
|
+
# standard end user account to execute.
|
1620
|
+
# @param [String] name
|
1621
|
+
# The resource id of the search application query stats, in the following format:
|
1622
|
+
# searchapplications/`application_id`
|
1623
|
+
# @param [Fixnum] from_date_day
|
1624
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1625
|
+
# @param [Fixnum] from_date_month
|
1626
|
+
# Month of date. Must be from 1 to 12.
|
1627
|
+
# @param [Fixnum] from_date_year
|
1628
|
+
# Year of date. Must be from 1 to 9999.
|
1629
|
+
# @param [Fixnum] to_date_day
|
1630
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1631
|
+
# @param [Fixnum] to_date_month
|
1632
|
+
# Month of date. Must be from 1 to 12.
|
1633
|
+
# @param [Fixnum] to_date_year
|
1634
|
+
# Year of date. Must be from 1 to 9999.
|
1635
|
+
# @param [String] fields
|
1636
|
+
# Selector specifying which fields to include in a partial response.
|
1637
|
+
# @param [String] quota_user
|
1638
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1639
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1640
|
+
# @param [Google::Apis::RequestOptions] options
|
1641
|
+
# Request-specific options
|
1642
|
+
#
|
1643
|
+
# @yield [result, err] Result & error if block supplied
|
1644
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::GetSearchApplicationQueryStatsResponse] parsed result object
|
1645
|
+
# @yieldparam err [StandardError] error object if request failed
|
1646
|
+
#
|
1647
|
+
# @return [Google::Apis::CloudsearchV1::GetSearchApplicationQueryStatsResponse]
|
1648
|
+
#
|
1649
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1650
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1651
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1652
|
+
def get_stat_query_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1653
|
+
command = make_simple_command(:get, 'v1/stats/query/{+name}', options)
|
1654
|
+
command.response_representation = Google::Apis::CloudsearchV1::GetSearchApplicationQueryStatsResponse::Representation
|
1655
|
+
command.response_class = Google::Apis::CloudsearchV1::GetSearchApplicationQueryStatsResponse
|
1656
|
+
command.params['name'] = name unless name.nil?
|
1657
|
+
command.query['fromDate.day'] = from_date_day unless from_date_day.nil?
|
1658
|
+
command.query['fromDate.month'] = from_date_month unless from_date_month.nil?
|
1659
|
+
command.query['fromDate.year'] = from_date_year unless from_date_year.nil?
|
1660
|
+
command.query['toDate.day'] = to_date_day unless to_date_day.nil?
|
1661
|
+
command.query['toDate.month'] = to_date_month unless to_date_month.nil?
|
1662
|
+
command.query['toDate.year'] = to_date_year unless to_date_year.nil?
|
1663
|
+
command.query['fields'] = fields unless fields.nil?
|
1664
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1665
|
+
execute_or_queue_command(command, &block)
|
1666
|
+
end
|
1667
|
+
|
1668
|
+
# Get the # of search sessions, % of successful sessions with a click query
|
1669
|
+
# statistics for search application. **Note:** This API requires a standard end
|
1670
|
+
# user account to execute.
|
1671
|
+
# @param [String] name
|
1672
|
+
# The resource id of the search application session stats, in the following
|
1673
|
+
# format: searchapplications/`application_id`
|
1674
|
+
# @param [Fixnum] from_date_day
|
1675
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1676
|
+
# @param [Fixnum] from_date_month
|
1677
|
+
# Month of date. Must be from 1 to 12.
|
1678
|
+
# @param [Fixnum] from_date_year
|
1679
|
+
# Year of date. Must be from 1 to 9999.
|
1680
|
+
# @param [Fixnum] to_date_day
|
1681
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1682
|
+
# @param [Fixnum] to_date_month
|
1683
|
+
# Month of date. Must be from 1 to 12.
|
1684
|
+
# @param [Fixnum] to_date_year
|
1685
|
+
# Year of date. Must be from 1 to 9999.
|
1686
|
+
# @param [String] fields
|
1687
|
+
# Selector specifying which fields to include in a partial response.
|
1688
|
+
# @param [String] quota_user
|
1689
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1690
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1691
|
+
# @param [Google::Apis::RequestOptions] options
|
1692
|
+
# Request-specific options
|
1693
|
+
#
|
1694
|
+
# @yield [result, err] Result & error if block supplied
|
1695
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::GetSearchApplicationSessionStatsResponse] parsed result object
|
1696
|
+
# @yieldparam err [StandardError] error object if request failed
|
1697
|
+
#
|
1698
|
+
# @return [Google::Apis::CloudsearchV1::GetSearchApplicationSessionStatsResponse]
|
1699
|
+
#
|
1700
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1701
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1702
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1703
|
+
def get_stat_session_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1704
|
+
command = make_simple_command(:get, 'v1/stats/session/{+name}', options)
|
1705
|
+
command.response_representation = Google::Apis::CloudsearchV1::GetSearchApplicationSessionStatsResponse::Representation
|
1706
|
+
command.response_class = Google::Apis::CloudsearchV1::GetSearchApplicationSessionStatsResponse
|
1707
|
+
command.params['name'] = name unless name.nil?
|
1708
|
+
command.query['fromDate.day'] = from_date_day unless from_date_day.nil?
|
1709
|
+
command.query['fromDate.month'] = from_date_month unless from_date_month.nil?
|
1710
|
+
command.query['fromDate.year'] = from_date_year unless from_date_year.nil?
|
1711
|
+
command.query['toDate.day'] = to_date_day unless to_date_day.nil?
|
1712
|
+
command.query['toDate.month'] = to_date_month unless to_date_month.nil?
|
1713
|
+
command.query['toDate.year'] = to_date_year unless to_date_year.nil?
|
1714
|
+
command.query['fields'] = fields unless fields.nil?
|
1715
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1716
|
+
execute_or_queue_command(command, &block)
|
1717
|
+
end
|
1718
|
+
|
1719
|
+
# Get the users statistics for search application. **Note:** This API requires a
|
1720
|
+
# standard end user account to execute.
|
1721
|
+
# @param [String] name
|
1722
|
+
# The resource id of the search application session stats, in the following
|
1723
|
+
# format: searchapplications/`application_id`
|
1724
|
+
# @param [Fixnum] from_date_day
|
1725
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1726
|
+
# @param [Fixnum] from_date_month
|
1727
|
+
# Month of date. Must be from 1 to 12.
|
1728
|
+
# @param [Fixnum] from_date_year
|
1729
|
+
# Year of date. Must be from 1 to 9999.
|
1730
|
+
# @param [Fixnum] to_date_day
|
1731
|
+
# Day of month. Must be from 1 to 31 and valid for the year and month.
|
1732
|
+
# @param [Fixnum] to_date_month
|
1733
|
+
# Month of date. Must be from 1 to 12.
|
1734
|
+
# @param [Fixnum] to_date_year
|
1735
|
+
# Year of date. Must be from 1 to 9999.
|
1736
|
+
# @param [String] fields
|
1737
|
+
# Selector specifying which fields to include in a partial response.
|
1738
|
+
# @param [String] quota_user
|
1739
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1740
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1741
|
+
# @param [Google::Apis::RequestOptions] options
|
1742
|
+
# Request-specific options
|
1743
|
+
#
|
1744
|
+
# @yield [result, err] Result & error if block supplied
|
1745
|
+
# @yieldparam result [Google::Apis::CloudsearchV1::GetSearchApplicationUserStatsResponse] parsed result object
|
1746
|
+
# @yieldparam err [StandardError] error object if request failed
|
1747
|
+
#
|
1748
|
+
# @return [Google::Apis::CloudsearchV1::GetSearchApplicationUserStatsResponse]
|
1749
|
+
#
|
1750
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1751
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1752
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1753
|
+
def get_stat_user_searchapplication(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1754
|
+
command = make_simple_command(:get, 'v1/stats/user/{+name}', options)
|
1755
|
+
command.response_representation = Google::Apis::CloudsearchV1::GetSearchApplicationUserStatsResponse::Representation
|
1756
|
+
command.response_class = Google::Apis::CloudsearchV1::GetSearchApplicationUserStatsResponse
|
1757
|
+
command.params['name'] = name unless name.nil?
|
1758
|
+
command.query['fromDate.day'] = from_date_day unless from_date_day.nil?
|
1759
|
+
command.query['fromDate.month'] = from_date_month unless from_date_month.nil?
|
1760
|
+
command.query['fromDate.year'] = from_date_year unless from_date_year.nil?
|
1761
|
+
command.query['toDate.day'] = to_date_day unless to_date_day.nil?
|
1762
|
+
command.query['toDate.month'] = to_date_month unless to_date_month.nil?
|
1763
|
+
command.query['toDate.year'] = to_date_year unless to_date_year.nil?
|
1764
|
+
command.query['fields'] = fields unless fields.nil?
|
1765
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1766
|
+
execute_or_queue_command(command, &block)
|
1767
|
+
end
|
1768
|
+
|
1769
|
+
protected
|
1770
|
+
|
1771
|
+
def apply_command_defaults(command)
|
1772
|
+
command.query['key'] = key unless key.nil?
|
1773
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1774
|
+
end
|
1775
|
+
end
|
1776
|
+
end
|
1777
|
+
end
|
1778
|
+
end
|