Blame - docs/dyn/cloudsearch_v1.settings.datasources.html - platform/external/python/google-api-python-client

blob: 7e6f37da67b4fc048cc39f53c0a9a67c399ed3db [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.settings.html">settings</a> . <a href="cloudsearch_v1.settings.datasources.html">datasources</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	82	<p class="firstline">Creates a datasource. Note: This API requires an admin account to execute.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	85	<p class="firstline">Deletes a datasource. Note: This API requires an admin account to execute.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	86	<p class="toc_element">
				87	<code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	88	<p class="firstline">Gets a datasource. Note: This API requires an admin account to execute.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	89	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	90	<code><a href="#list">list(debugOptions_enableDebugging=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
				91	<p class="firstline">Lists datasources. Note: This API requires an admin account to execute.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	97	<p class="firstline">Updates a datasource. Note: This API requires an admin account to execute.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	98	<h3>Method Details</h3>
				99	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	104	<div class="method">
				105	<code class="details" id="create">create(body=None, x__xgafv=None)</code>
				106	<pre>Creates a datasource. Note: This API requires an admin account to execute.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	107
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	108	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	109	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	110	The object takes the form of:
				111
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	112	{ # Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
				113	"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this schema.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	114	"A String",
				115	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	116	"itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	117	{
				118	"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	119	"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	120	"gsuiteUserEmail": "A String", # This principal references a G Suite user account
				121	},
				122	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	123	"shortName": "A String", # A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is <value> then queries like source:<value> will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
				124	"disableServing": True or False, # Disable serving any search or assist results.
				125	"name": "A String", # Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
				126	"indexingServiceAccounts": [ # List of service accounts that have indexing access.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	127	"A String",
				128	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	129	"displayName": "A String", # Required. Display name of the datasource The maximum length is 300 characters.
				130	"disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	131	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	132
				133	x__xgafv: string, V1 error format.
				134	Allowed values
				135	1 - v1 error format
				136	2 - v2 error format
				137
				138	Returns:
				139	An object of the form:
				140
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	141	{ # This resource represents a long-running operation that is the result of a network API call.
				142	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				143	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				144	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	145	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	146	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	147	},
				148	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	149	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	150	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	151	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	152	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				153	"a_key": "", # Properties of the object. Contains field @type with type URL.
				154	},
				155	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				156	"a_key": "", # Properties of the object. Contains field @type with type URL.
				157	},
				158	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	159	}</pre>
				160	</div>
				161
				162	<div class="method">
				163	<code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	164	<pre>Deletes a datasource. Note: This API requires an admin account to execute.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	165
				166	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	167	name: string, Name of the datasource. Format: datasources/{source_id}. (required)
				168	debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	169	x__xgafv: string, V1 error format.
				170	Allowed values
				171	1 - v1 error format
				172	2 - v2 error format
				173
				174	Returns:
				175	An object of the form:
				176
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	177	{ # This resource represents a long-running operation that is the result of a network API call.
				178	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				179	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				180	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	181	{
				182	"a_key": "", # Properties of the object. Contains field @type with type URL.
				183	},
				184	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	185	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	186	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	187	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	188	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				189	"a_key": "", # Properties of the object. Contains field @type with type URL.
				190	},
				191	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				192	"a_key": "", # Properties of the object. Contains field @type with type URL.
				193	},
				194	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	195	}</pre>
				196	</div>
				197
				198	<div class="method">
				199	<code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	200	<pre>Gets a datasource. Note: This API requires an admin account to execute.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	201
				202	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	203	name: string, Name of the datasource resource. Format: datasources/{source_id}. (required)
				204	debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	205	x__xgafv: string, V1 error format.
				206	Allowed values
				207	1 - v1 error format
				208	2 - v2 error format
				209
				210	Returns:
				211	An object of the form:
				212
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	213	{ # Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
				214	"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this schema.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	215	"A String",
				216	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	217	"itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	218	{
				219	"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	220	"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	221	"gsuiteUserEmail": "A String", # This principal references a G Suite user account
				222	},
				223	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	224	"shortName": "A String", # A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is <value> then queries like source:<value> will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
				225	"disableServing": True or False, # Disable serving any search or assist results.
				226	"name": "A String", # Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
				227	"indexingServiceAccounts": [ # List of service accounts that have indexing access.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	228	"A String",
				229	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	230	"displayName": "A String", # Required. Display name of the datasource The maximum length is 300 characters.
				231	"disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	232	}</pre>
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	233	</div>
				234
				235	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	236	<code class="details" id="list">list(debugOptions_enableDebugging=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
				237	<pre>Lists datasources. Note: This API requires an admin account to execute.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	238
				239	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	240	debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	241	pageToken: string, Starting index of the results.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	242	pageSize: integer, Maximum number of datasources to fetch in a request. The max value is 100. The default value is 10
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	243	x__xgafv: string, V1 error format.
				244	Allowed values
				245	1 - v1 error format
				246	2 - v2 error format
				247
				248	Returns:
				249	An object of the form:
				250
				251	{
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	252	"sources": [
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	253	{ # Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
				254	"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this schema.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	255	"A String",
				256	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	257	"itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	258	{
				259	"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	260	"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	261	"gsuiteUserEmail": "A String", # This principal references a G Suite user account
				262	},
				263	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	264	"shortName": "A String", # A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is <value> then queries like source:<value> will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
				265	"disableServing": True or False, # Disable serving any search or assist results.
				266	"name": "A String", # Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
				267	"indexingServiceAccounts": [ # List of service accounts that have indexing access.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	268	"A String",
				269	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	270	"displayName": "A String", # Required. Display name of the datasource The maximum length is 300 characters.
				271	"disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	272	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	273	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	274	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	275	}</pre>
				276	</div>
				277
				278	<div class="method">
				279	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				280	<pre>Retrieves the next page of results.
				281
				282	Args:
				283	previous_request: The request for the previous page. (required)
				284	previous_response: The response from the request for the previous page. (required)
				285
				286	Returns:
				287	A request object that you can call 'execute()' on to request the next
				288	page. Returns None if there are no more items in the collection.
				289	</pre>
				290	</div>
				291
				292	<div class="method">
				293	<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	294	<pre>Updates a datasource. Note: This API requires an admin account to execute.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	295
				296	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	297	name: string, Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource. (required)
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	298	body: object, The request body.
				299	The object takes the form of:
				300
				301	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	302	"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
				303	"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
				304	},
				305	"source": { # Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
				306	"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this schema.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	307	"A String",
				308	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	309	"itemsVisibility": [ # This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	310	{
				311	"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	312	"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	313	"gsuiteUserEmail": "A String", # This principal references a G Suite user account
				314	},
				315	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	316	"shortName": "A String", # A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is <value> then queries like source:<value> will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
				317	"disableServing": True or False, # Disable serving any search or assist results.
				318	"name": "A String", # Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
				319	"indexingServiceAccounts": [ # List of service accounts that have indexing access.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	320	"A String",
				321	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	322	"displayName": "A String", # Required. Display name of the datasource The maximum length is 300 characters.
				323	"disableModifications": True or False, # If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	324	},
				325	}
				326
				327	x__xgafv: string, V1 error format.
				328	Allowed values
				329	1 - v1 error format
				330	2 - v2 error format
				331
				332	Returns:
				333	An object of the form:
				334
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	335	{ # This resource represents a long-running operation that is the result of a network API call.
				336	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				337	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
				338	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	339	{
				340	"a_key": "", # Properties of the object. Contains field @type with type URL.
				341	},
				342	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	343	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	344	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame]	345	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame^]	346	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				347	"a_key": "", # Properties of the object. Contains field @type with type URL.
				348	},
				349	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				350	"a_key": "", # Properties of the object. Contains field @type with type URL.
				351	},
				352	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	353	}</pre>
				354	</div>
				355
				356	</body></html>