chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html
index 81ce95b..be79aa4 100644
--- a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html
+++ b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html
@@ -78,13 +78,13 @@
<code><a href="#delete">delete(name, connectorName=None, version=None, mode=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes Item resource for the</p>
<p class="toc_element">
- <code><a href="#deleteQueueItems">deleteQueueItems(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#deleteQueueItems">deleteQueueItems(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes all items in a queue. This method is useful for deleting stale</p>
<p class="toc_element">
<code><a href="#get">get(name, connectorName=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets Item resource by item name.</p>
<p class="toc_element">
- <code><a href="#index">index(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#index">index(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates Item ACL, metadata, and</p>
<p class="toc_element">
<code><a href="#list">list(name, pageSize=None, brief=None, connectorName=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</a></code></p>
@@ -93,33 +93,35 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#poll">poll(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#poll">poll(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Polls for unreserved items from the indexing queue and marks a</p>
<p class="toc_element">
- <code><a href="#push">push(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#push">push(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Pushes an item onto a queue for later polling and updating.</p>
<p class="toc_element">
- <code><a href="#unreserve">unreserve(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#unreserve">unreserve(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Unreserves all items from a queue, making them all eligible to be</p>
<p class="toc_element">
- <code><a href="#upload">upload(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#upload">upload(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an upload session for uploading item content. For items smaller</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(name, connectorName=None, version=None, mode=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Deletes Item resource for the
-specified resource name.
+specified resource name. This API requires an admin or service account
+to execute. The service account used is the one whitelisted in the
+corresponding data source.
Args:
name: string, Required. Name of the item to delete.
Format: datasources/{source_id}/items/{item_id} (required)
connectorName: string, Name of connector making this call.
-<br />Format: datasources/{source_id}/connectors/{ID}
+<br />Format: datasources/{source_id}/connectors/{ID}
version: string, Required. The incremented version of the item to delete from the index.
The indexing system stores the version from the datasource as a
byte string and compares the Item version in the index
to the version of the queued Item using lexical ordering.
-<br /><br />
+<br /><br />
Cloud Search Indexing won't delete any queued item with
a version value that is less than or equal to
the version of the currently indexed item.
@@ -143,6 +145,22 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -161,44 +179,31 @@
},
],
},
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="deleteQueueItems">deleteQueueItems(name, body, x__xgafv=None)</code>
+ <code class="details" id="deleteQueueItems">deleteQueueItems(name, body=None, x__xgafv=None)</code>
<pre>Deletes all items in a queue. This method is useful for deleting stale
items.
+This API requires an admin or service account to execute. The service
+account used is the one whitelisted in the corresponding data source.
+
Args:
name: string, Name of the Data Source to delete items in a queue.
Format: datasources/{source_id} (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{
"queue": "A String", # Name of a queue to delete items from.
- "connectorName": "A String", # Name of connector making this call.
- # <br />Format: datasources/{source_id}/connectors/{ID}
"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
# Otherwise, ignore this field.
},
+ "connectorName": "A String", # Name of connector making this call.
+ # <br />Format: datasources/{source_id}/connectors/{ID}
}
x__xgafv: string, V1 error format.
@@ -217,6 +222,22 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -235,22 +256,6 @@
},
],
},
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
}</pre>
</div>
@@ -258,11 +263,14 @@
<code class="details" id="get">get(name, connectorName=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
<pre>Gets Item resource by item name.
+This API requires an admin or service account to execute. The service
+account used is the one whitelisted in the corresponding data source.
+
Args:
name: string, Name of the item to get info.
Format: datasources/{source_id}/items/{item_id} (required)
connectorName: string, Name of connector making this call.
-<br />Format: datasources/{source_id}/connectors/{ID}
+<br />Format: datasources/{source_id}/connectors/{ID}
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
x__xgafv: string, V1 error format.
@@ -302,12 +310,13 @@
},
"queue": "A String", # Queue this item belongs to.
# The maximum length is 100 characters.
+ "itemType": "A String", # Type for this item.
"name": "A String", # Name of the Item. Format:
# datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
+ # <br />This is a required field.
# The maximum length is 1536 characters.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
- # https://developers.google.com/cloud-search/docs/guides/index-your-data#acls
+ # [Map ACLs](/cloud-search/docs/guides/acls).
"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
# parent. This should always be set in tandem with the
# inheritAclFrom
@@ -397,21 +406,20 @@
# The maximum length is 2048 characters.
},
"contentFormat": "A String",
+ "inlineContent": "A String", # Content that is supplied inlined within the update method.
+ # The maximum length is 102400 bytes (100 KiB).
"hash": "A String", # Hashing info calculated and provided by the API client for content.
# Can be used with the items.push method to calculate modified state.
# The maximum length is 2048 characters.
- "inlineContent": "A String", # Content that is supplied inlined within the update method.
- # The maximum length is 102400 bytes (100 KiB).
},
"version": "A String", # Required. The indexing system stores the version from the datasource as a
# byte string and compares the Item version in the index
# to the version of the queued Item using lexical ordering.
- # <br /><br />
+ # <br /><br />
# Cloud Search Indexing won't index or delete any queued item with
# a version value that is less than or equal to the version of the
# currently indexed item.
# The maximum length for this field is 1024 bytes.
- "itemType": "A String", # Type for this item.
"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
# object definition in the schema for the data source.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
@@ -429,17 +437,15 @@
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
],
},
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
"enumValues": { # List of enum values.
"values": [ # The maximum allowable length for string values is 32 characters.
"A String",
@@ -466,9 +472,11 @@
"A String",
],
},
- "name": "A String", # The name of the property. This name should correspond to the name of the
- # property that was registered for object definition in the schema.
- # The maximum allowable length for this property is 256 characters.
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
@@ -538,8 +546,10 @@
# The maximum length is 8192 characters.
"A String",
],
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
# this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
# The maximum length is 2048 characters.
"createTime": "A String", # The time when the item was created in the source repository.
"objectType": "A String", # The type of the item. This should correspond to the name of an object
@@ -553,22 +563,32 @@
</div>
<div class="method">
- <code class="details" id="index">index(name, body, x__xgafv=None)</code>
+ <code class="details" id="index">index(name, body=None, x__xgafv=None)</code>
<pre>Updates Item ACL, metadata, and
content. It will insert the Item if it
does not exist.
This method does not support partial updates. Fields with no provided
values are cleared out in the Cloud Search index.
+This API requires an admin or service account to execute. The service
+account used is the one whitelisted in the corresponding data source.
+
Args:
name: string, Name of the Item. Format:
datasources/{source_id}/items/{item_id}
-<br />This is a required field.
+<br />This is a required field.
The maximum length is 1536 characters. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{
+ "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
+ "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
+ # Otherwise, ignore this field.
+ },
+ "mode": "A String", # Required. The RequestMode for this request.
+ "connectorName": "A String", # Name of connector making this call.
+ # <br />Format: datasources/{source_id}/connectors/{ID}
"item": { # Represents a single object that is an item in the search index, such as a # Name of the item. Format:
# datasources/{source_id}/items/{item_id}
# file, folder, or a database record.
@@ -599,12 +619,13 @@
},
"queue": "A String", # Queue this item belongs to.
# The maximum length is 100 characters.
+ "itemType": "A String", # Type for this item.
"name": "A String", # Name of the Item. Format:
# datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
+ # <br />This is a required field.
# The maximum length is 1536 characters.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
- # https://developers.google.com/cloud-search/docs/guides/index-your-data#acls
+ # [Map ACLs](/cloud-search/docs/guides/acls).
"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
# parent. This should always be set in tandem with the
# inheritAclFrom
@@ -694,21 +715,20 @@
# The maximum length is 2048 characters.
},
"contentFormat": "A String",
+ "inlineContent": "A String", # Content that is supplied inlined within the update method.
+ # The maximum length is 102400 bytes (100 KiB).
"hash": "A String", # Hashing info calculated and provided by the API client for content.
# Can be used with the items.push method to calculate modified state.
# The maximum length is 2048 characters.
- "inlineContent": "A String", # Content that is supplied inlined within the update method.
- # The maximum length is 102400 bytes (100 KiB).
},
"version": "A String", # Required. The indexing system stores the version from the datasource as a
# byte string and compares the Item version in the index
# to the version of the queued Item using lexical ordering.
- # <br /><br />
+ # <br /><br />
# Cloud Search Indexing won't index or delete any queued item with
# a version value that is less than or equal to the version of the
# currently indexed item.
# The maximum length for this field is 1024 bytes.
- "itemType": "A String", # Type for this item.
"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
# object definition in the schema for the data source.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
@@ -726,17 +746,15 @@
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
],
},
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
"enumValues": { # List of enum values.
"values": [ # The maximum allowable length for string values is 32 characters.
"A String",
@@ -763,9 +781,11 @@
"A String",
],
},
- "name": "A String", # The name of the property. This name should correspond to the name of the
- # property that was registered for object definition in the schema.
- # The maximum allowable length for this property is 256 characters.
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
@@ -835,8 +855,10 @@
# The maximum length is 8192 characters.
"A String",
],
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
# this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
# The maximum length is 2048 characters.
"createTime": "A String", # The time when the item was created in the source repository.
"objectType": "A String", # The type of the item. This should correspond to the name of an object
@@ -847,17 +869,10 @@
# The maximum length is 256 characters.
},
},
- "mode": "A String", # Required. The RequestMode for this request.
- "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
- "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
- # Otherwise, ignore this field.
- },
"indexItemOptions": {
"allowUnknownGsuitePrincipals": True or False, # Specifies if the index request should allow gsuite principals that do not
# exist or are deleted in the index request.
},
- "connectorName": "A String", # Name of connector making this call.
- # <br />Format: datasources/{source_id}/connectors/{ID}
}
x__xgafv: string, V1 error format.
@@ -876,6 +891,22 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -894,22 +925,6 @@
},
],
},
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
}</pre>
</div>
@@ -917,22 +932,37 @@
<code class="details" id="list">list(name, pageSize=None, brief=None, connectorName=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all or a subset of Item resources.
+This API requires an admin or service account to execute. The service
+account used is the one whitelisted in the corresponding data source.
+
Args:
name: string, Name of the Data Source to list Items. Format:
datasources/{source_id} (required)
pageSize: integer, Maximum number of items to fetch in a request.
The max value is 1000 when brief is true. The max value is 10 if brief
is false.
-<br />The default value is 10
+<br />The default value is 10
brief: boolean, When set to true, the indexing system only populates the following fields:
name,
version,
+queue.
metadata.hash,
+metadata.title,
+metadata.sourceRepositoryURL,
+metadata.objectType,
+metadata.createTime,
+metadata.updateTime,
+metadata.contentLanguage,
+metadata.mimeType,
structured_data.hash,
-content.hash.
-<br />If this value is false, then all the fields are populated in Item.
+content.hash,
+itemType,
+itemStatus.code,
+itemStatus.processingError.code,
+itemStatus.repositoryError.type,
+<br />If this value is false, then all the fields are populated in Item.
connectorName: string, Name of connector making this call.
-<br />Format: datasources/{source_id}/connectors/{ID}
+<br />Format: datasources/{source_id}/connectors/{ID}
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
pageToken: string, The next_page_token value returned from a previous List request, if any.
@@ -977,12 +1007,13 @@
},
"queue": "A String", # Queue this item belongs to.
# The maximum length is 100 characters.
+ "itemType": "A String", # Type for this item.
"name": "A String", # Name of the Item. Format:
# datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
+ # <br />This is a required field.
# The maximum length is 1536 characters.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
- # https://developers.google.com/cloud-search/docs/guides/index-your-data#acls
+ # [Map ACLs](/cloud-search/docs/guides/acls).
"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
# parent. This should always be set in tandem with the
# inheritAclFrom
@@ -1072,21 +1103,20 @@
# The maximum length is 2048 characters.
},
"contentFormat": "A String",
+ "inlineContent": "A String", # Content that is supplied inlined within the update method.
+ # The maximum length is 102400 bytes (100 KiB).
"hash": "A String", # Hashing info calculated and provided by the API client for content.
# Can be used with the items.push method to calculate modified state.
# The maximum length is 2048 characters.
- "inlineContent": "A String", # Content that is supplied inlined within the update method.
- # The maximum length is 102400 bytes (100 KiB).
},
"version": "A String", # Required. The indexing system stores the version from the datasource as a
# byte string and compares the Item version in the index
# to the version of the queued Item using lexical ordering.
- # <br /><br />
+ # <br /><br />
# Cloud Search Indexing won't index or delete any queued item with
# a version value that is less than or equal to the version of the
# currently indexed item.
# The maximum length for this field is 1024 bytes.
- "itemType": "A String", # Type for this item.
"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
# object definition in the schema for the data source.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
@@ -1104,17 +1134,15 @@
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
],
},
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
"enumValues": { # List of enum values.
"values": [ # The maximum allowable length for string values is 32 characters.
"A String",
@@ -1141,9 +1169,11 @@
"A String",
],
},
- "name": "A String", # The name of the property. This name should correspond to the name of the
- # property that was registered for object definition in the schema.
- # The maximum allowable length for this property is 256 characters.
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
@@ -1213,8 +1243,10 @@
# The maximum length is 8192 characters.
"A String",
],
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
# this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
# The maximum length is 2048 characters.
"createTime": "A String", # The time when the item was created in the source repository.
"objectType": "A String", # The type of the item. This should correspond to the name of an object
@@ -1244,20 +1276,20 @@
</div>
<div class="method">
- <code class="details" id="poll">poll(name, body, x__xgafv=None)</code>
+ <code class="details" id="poll">poll(name, body=None, x__xgafv=None)</code>
<pre>Polls for unreserved items from the indexing queue and marks a
set as reserved, starting with items that have
the oldest timestamp from the highest priority
ItemStatus.
-The priority order is as follows: <br />
+The priority order is as follows: <br />
ERROR
-<br />
+<br />
MODIFIED
-<br />
+<br />
NEW_ITEM
-<br />
+<br />
ACCEPTED
-<br />
+<br />
Reserving items ensures that polling from other threads
cannot create overlapping sets.
@@ -1271,24 +1303,27 @@
Items automatically become available (unreserved) after 4 hours even if no
update or push method is called.
+This API requires an admin or service account to execute. The service
+account used is the one whitelisted in the corresponding data source.
+
Args:
name: string, Name of the Data Source to poll items.
Format: datasources/{source_id} (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{
"queue": "A String", # Queue name to fetch items from. If unspecified, PollItems will
# fetch from 'default' queue.
# The maximum length is 100 characters.
+ "connectorName": "A String", # Name of connector making this call.
+ # <br />Format: datasources/{source_id}/connectors/{ID}
+ "limit": 42, # Maximum number of items to return.
+ # <br />The maximum value is 100 and the default value is 20.
"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
# Otherwise, ignore this field.
},
- "limit": 42, # Maximum number of items to return.
- # <br />The maximum and the default value is 1000
- "connectorName": "A String", # Name of connector making this call.
- # <br />Format: datasources/{source_id}/connectors/{ID}
"statusCodes": [ # Limit the items polled to the ones with these statuses.
"A String",
],
@@ -1304,14 +1339,14 @@
{
"items": [ # Set of items from the queue available for connector to process.
- # <br />These items have the following subset of fields populated: <br />
- # <br />version
- # <br />metadata.hash
- # <br />structured_data.hash
- # <br />content.hash
- # <br />payload
- # <br />status
- # <br />queue
+ # <br />These items have the following subset of fields populated: <br />
+ # <br />version
+ # <br />metadata.hash
+ # <br />structured_data.hash
+ # <br />content.hash
+ # <br />payload
+ # <br />status
+ # <br />queue
{ # Represents a single object that is an item in the search index, such as a
# file, folder, or a database record.
"status": { # This contains item's status and any errors. # Status of the item.
@@ -1341,12 +1376,13 @@
},
"queue": "A String", # Queue this item belongs to.
# The maximum length is 100 characters.
+ "itemType": "A String", # Type for this item.
"name": "A String", # Name of the Item. Format:
# datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
+ # <br />This is a required field.
# The maximum length is 1536 characters.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
- # https://developers.google.com/cloud-search/docs/guides/index-your-data#acls
+ # [Map ACLs](/cloud-search/docs/guides/acls).
"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
# parent. This should always be set in tandem with the
# inheritAclFrom
@@ -1436,21 +1472,20 @@
# The maximum length is 2048 characters.
},
"contentFormat": "A String",
+ "inlineContent": "A String", # Content that is supplied inlined within the update method.
+ # The maximum length is 102400 bytes (100 KiB).
"hash": "A String", # Hashing info calculated and provided by the API client for content.
# Can be used with the items.push method to calculate modified state.
# The maximum length is 2048 characters.
- "inlineContent": "A String", # Content that is supplied inlined within the update method.
- # The maximum length is 102400 bytes (100 KiB).
},
"version": "A String", # Required. The indexing system stores the version from the datasource as a
# byte string and compares the Item version in the index
# to the version of the queued Item using lexical ordering.
- # <br /><br />
+ # <br /><br />
# Cloud Search Indexing won't index or delete any queued item with
# a version value that is less than or equal to the version of the
# currently indexed item.
# The maximum length for this field is 1024 bytes.
- "itemType": "A String", # Type for this item.
"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
# object definition in the schema for the data source.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
@@ -1468,17 +1503,15 @@
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
],
},
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
"enumValues": { # List of enum values.
"values": [ # The maximum allowable length for string values is 32 characters.
"A String",
@@ -1505,9 +1538,11 @@
"A String",
],
},
- "name": "A String", # The name of the property. This name should correspond to the name of the
- # property that was registered for object definition in the schema.
- # The maximum allowable length for this property is 256 characters.
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
@@ -1577,8 +1612,10 @@
# The maximum length is 8192 characters.
"A String",
],
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
# this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
# The maximum length is 2048 characters.
"createTime": "A String", # The time when the item was created in the source repository.
"objectType": "A String", # The type of the item. This should correspond to the name of an object
@@ -1594,16 +1631,19 @@
</div>
<div class="method">
- <code class="details" id="push">push(name, body, x__xgafv=None)</code>
+ <code class="details" id="push">push(name, body=None, x__xgafv=None)</code>
<pre>Pushes an item onto a queue for later polling and updating.
+This API requires an admin or service account to execute. The service
+account used is the one whitelisted in the corresponding data source.
+
Args:
name: string, Name of the item to
-push into the indexing queue.<br />
+push into the indexing queue.<br />
Format: datasources/{source_id}/items/{ID}
-<br />This is a required field.
+<br />This is a required field.
The maximum length is 1536 characters. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{
@@ -1620,7 +1660,7 @@
# type field results in argument
# error.
# The maximum length is 2048 characters.
- "queue": "A String", # Queue to which this item belongs to. The <code>default</code> queue is
+ "queue": "A String", # Queue to which this item belongs to. The <code>default</code> queue is
# chosen if this field is not specified. The maximum length is
# 512 characters.
"repositoryError": { # Errors when the connector is communicating to the source repository. # Populate this field to store Connector or repository error details.
@@ -1643,12 +1683,12 @@
# such as an alternate repository ID and other metadata.
# The maximum length is 8192 bytes.
},
- "connectorName": "A String", # Name of connector making this call.
- # <br />Format: datasources/{source_id}/connectors/{ID}
"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
# Otherwise, ignore this field.
},
+ "connectorName": "A String", # Name of connector making this call.
+ # <br />Format: datasources/{source_id}/connectors/{ID}
}
x__xgafv: string, V1 error format.
@@ -1688,12 +1728,13 @@
},
"queue": "A String", # Queue this item belongs to.
# The maximum length is 100 characters.
+ "itemType": "A String", # Type for this item.
"name": "A String", # Name of the Item. Format:
# datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
+ # <br />This is a required field.
# The maximum length is 1536 characters.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
- # https://developers.google.com/cloud-search/docs/guides/index-your-data#acls
+ # [Map ACLs](/cloud-search/docs/guides/acls).
"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a
# parent. This should always be set in tandem with the
# inheritAclFrom
@@ -1783,21 +1824,20 @@
# The maximum length is 2048 characters.
},
"contentFormat": "A String",
+ "inlineContent": "A String", # Content that is supplied inlined within the update method.
+ # The maximum length is 102400 bytes (100 KiB).
"hash": "A String", # Hashing info calculated and provided by the API client for content.
# Can be used with the items.push method to calculate modified state.
# The maximum length is 2048 characters.
- "inlineContent": "A String", # Content that is supplied inlined within the update method.
- # The maximum length is 102400 bytes (100 KiB).
},
"version": "A String", # Required. The indexing system stores the version from the datasource as a
# byte string and compares the Item version in the index
# to the version of the queued Item using lexical ordering.
- # <br /><br />
+ # <br /><br />
# Cloud Search Indexing won't index or delete any queued item with
# a version value that is less than or equal to the version of the
# currently indexed item.
# The maximum length for this field is 1024 bytes.
- "itemType": "A String", # Type for this item.
"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered
# object definition in the schema for the data source.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object
@@ -1815,17 +1855,15 @@
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
- "month": 42, # Month of date. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
"year": 42, # Year of date. Must be from 1 to 9999.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
+ "month": 42, # Month of date. Must be from 1 to 12.
},
],
},
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
"enumValues": { # List of enum values.
"values": [ # The maximum allowable length for string values is 32 characters.
"A String",
@@ -1852,9 +1890,11 @@
"A String",
],
},
- "name": "A String", # The name of the property. This name should correspond to the name of the
- # property that was registered for object definition in the schema.
- # The maximum allowable length for this property is 256 characters.
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
@@ -1924,8 +1964,10 @@
# The maximum length is 8192 characters.
"A String",
],
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
# this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
# The maximum length is 2048 characters.
"createTime": "A String", # The time when the item was created in the source repository.
"objectType": "A String", # The type of the item. This should correspond to the name of an object
@@ -1939,15 +1981,18 @@
</div>
<div class="method">
- <code class="details" id="unreserve">unreserve(name, body, x__xgafv=None)</code>
+ <code class="details" id="unreserve">unreserve(name, body=None, x__xgafv=None)</code>
<pre>Unreserves all items from a queue, making them all eligible to be
polled. This method is useful for resetting the indexing queue
after a connector has been restarted.
+This API requires an admin or service account to execute. The service
+account used is the one whitelisted in the corresponding data source.
+
Args:
name: string, Name of the Data Source to unreserve all items.
Format: datasources/{source_id} (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{
@@ -1957,7 +2002,7 @@
# Otherwise, ignore this field.
},
"connectorName": "A String", # Name of connector making this call.
- # <br />Format: datasources/{source_id}/connectors/{ID}
+ # <br />Format: datasources/{source_id}/connectors/{ID}
}
x__xgafv: string, V1 error format.
@@ -1976,6 +2021,22 @@
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -1994,36 +2055,24 @@
},
],
},
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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}`.
}</pre>
</div>
<div class="method">
- <code class="details" id="upload">upload(name, body, x__xgafv=None)</code>
+ <code class="details" id="upload">upload(name, body=None, x__xgafv=None)</code>
<pre>Creates an upload session for uploading item content. For items smaller
-than 100 KiB, it's easier to embed the content
+than 100 KB, it's easier to embed the content
inline within
-update.
+an index request.
+
+This API requires an admin or service account to execute. The service
+account used is the one whitelisted in the corresponding data source.
Args:
name: string, Name of the Item to start a resumable upload.
-Format: datasources/{source_id}/items/{item_id}. (required)
- body: object, The request body. (required)
+Format: datasources/{source_id}/items/{item_id}.
+The maximum length is 1536 bytes. (required)
+ body: object, The request body.
The object takes the form of:
{ # Start upload file request.
@@ -2032,7 +2081,7 @@
# Otherwise, ignore this field.
},
"connectorName": "A String", # Name of connector making this call.
- # <br />Format: datasources/{source_id}/connectors/{ID}
+ # <br />Format: datasources/{source_id}/connectors/{ID}
}
x__xgafv: string, V1 error format.