Blame - docs/dyn/cloudsearch_v1.query.sources.html - platform/external/python/google-api-python-client

blob: 94cd56ff60aee3ea9c0720fe8fce3788485e50da [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.query.html">query</a> . <a href="cloudsearch_v1.query.sources.html">sources</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	78	<code><a href="#list">list(requestOptions_timeZone=None, requestOptions_languageCode=None, pageToken=None, requestOptions_searchApplicationId=None, requestOptions_debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Returns list of sources that user can use for Search and Suggest APIs.</p>
				80	<p class="toc_element">
				81	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				82	<p class="firstline">Retrieves the next page of results.</p>
				83	<h3>Method Details</h3>
				84	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	85	<code class="details" id="list">list(requestOptions_timeZone=None, requestOptions_languageCode=None, pageToken=None, requestOptions_searchApplicationId=None, requestOptions_debugOptions_enableDebugging=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	86	<pre>Returns list of sources that user can use for Search and Suggest APIs.
				87
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	88	Note: This API requires a standard end user account to execute.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	89	A service account can't perform Query API requests directly; to use a
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	90	service account to perform queries, set up [G Suite domain-wide delegation
				91	of
				92	authority](https://developers.google.com/cloud-search/docs/guides/delegation/).
				93
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	95	requestOptions_timeZone: string, Current user's time zone id, such as "America/Los_Angeles" or
				96	"Australia/Sydney". These IDs are defined by
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	[Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/)
				98	project, and currently available in the file
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	[timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml).
				100	This field is used to correctly interpret date and time queries.
				101	If this field is not specified, the default time zone (UTC) is used.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	102	requestOptions_languageCode: string, The BCP-47 language code, such as "en-US" or "sr-Latn".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	For more information, see
				104	http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
				105	For translations.
				106
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	107	Set this field using the language set in browser or for the page. In the
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	108	event that the user's language preference is known, set this field to the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	109	known user language.
				110
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	When specified, the documents in search results are biased towards the
				112	specified language.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	113
				114	The suggest API does not use this parameter. Instead, suggest autocompletes
				115	only based on characters in the query.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	116	pageToken: string, Number of sources to return in the response.
				117	requestOptions_searchApplicationId: string, The ID generated when you create a search application using the
				118	[admin console](https://support.google.com/a/answer/9043922).
				119	requestOptions_debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
				120	Otherwise, ignore this field.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	121	x__xgafv: string, V1 error format.
				122	Allowed values
				123	1 - v1 error format
				124	2 - v2 error format
				125
				126	Returns:
				127	An object of the form:
				128
				129	{ # List sources response.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	130	"sources": [
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	131	{ # List of sources that the user can search using the query API.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	132	"displayName": "A String", # Display name of the data source.
				133	"source": { # Defines sources for the suggest/search APIs. # Name of the source
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	134	"name": "A String", # Source name for content indexed by the
				135	# Indexing API.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	136	"predefinedSource": "A String", # Predefined content source for Google Apps.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	137	},
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	138	"operators": [ # List of all operators applicable for this source.
				139	{ # The definition of a operator that can be used in a Search/Suggest request.
				140	"operatorName": "A String", # The name of the operator.
				141	"objectType": "A String", # Name of the object corresponding to the operator. This field is only filled
				142	# for schema-specific operators, and is unset for common operators.
				143	"isReturnable": True or False, # Will the property associated with this facet be returned as part of search
				144	# results.
				145	"isRepeatable": True or False, # Indicates if multiple values can be set for this property.
				146	"enumValues": [ # Potential list of values for the opeatror field. This field is only filled
				147	# when we can safely enumerate all the possible values of this operator.
				148	"A String",
				149	],
				150	"isSortable": True or False, # Can this operator be used to sort results.
				151	"greaterThanOperatorName": "A String", # Indicates the operator name that can be used to isolate the property using
				152	# the greater-than operator.
				153	"displayName": "A String", # Display name of the operator
				154	"isFacetable": True or False, # Can this operator be used to get facets.
				155	"lessThanOperatorName": "A String", # Indicates the operator name that can be used to isolate the property using
				156	# the less-than operator.
				157	"type": "A String", # Type of the operator.
				158	"isSuggestable": True or False, # Can get suggestions for this field.
				159	},
				160	],
				161	"shortName": "A String", # A short name or alias for the source. This value can be used with the
				162	# 'source' operator.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	163	},
				164	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	165	"nextPageToken": "A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	166	}</pre>
				167	</div>
				168
				169	<div class="method">
				170	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				171	<pre>Retrieves the next page of results.
				172
				173	Args:
				174	previous_request: The request for the previous page. (required)
				175	previous_response: The response from the request for the previous page. (required)
				176
				177	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	178	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	179	page. Returns None if there are no more items in the collection.
				180	</pre>
				181	</div>
				182
				183	</body></html>