docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html
index ee728fe..5008cd4 100644
--- a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html
+++ b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html
@@ -78,7 +78,7 @@
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#delete">delete(name, mode=None, version=None, debugOptions_enableDebugging=None, connectorName=None, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(name, debugOptions_enableDebugging=None, connectorName=None, version=None, mode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes Item resource for the 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.</p>
<p class="toc_element">
<code><a href="#deleteQueueItems">deleteQueueItems(name, body=None, x__xgafv=None)</a></code></p>
@@ -90,7 +90,7 @@
<code><a href="#index">index(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
- <code><a href="#list">list(name, debugOptions_enableDebugging=None, pageSize=None, pageToken=None, connectorName=None, brief=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(name, pageToken=None, debugOptions_enableDebugging=None, brief=None, connectorName=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -114,19 +114,19 @@
</div>
<div class="method">
- <code class="details" id="delete">delete(name, mode=None, version=None, debugOptions_enableDebugging=None, connectorName=None, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, connectorName=None, version=None, mode=None, x__xgafv=None)</code>
<pre>Deletes Item resource for the 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)
+ debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
+ connectorName: string, Name of connector making this call. 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. 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. The maximum length for this field is 1024 bytes.
mode: string, Required. The RequestMode for this request.
Allowed values
UNSPECIFIED - Priority is not specified in the update request. Leaving priority unspecified results in an update failure.
SYNCHRONOUS - For real-time updates.
ASYNCHRONOUS - For changes that are executed after the response is sent back to the caller.
- 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. 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. The maximum length for this field is 1024 bytes.
- debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- connectorName: string, Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -137,13 +137,6 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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 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.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -153,6 +146,13 @@
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
},
+ "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}`.
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -166,10 +166,10 @@
The object takes the form of:
{
+ "queue": "A String", # Name of a queue to delete items from.
"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.
},
- "queue": "A String", # Name of a queue to delete items from.
"connectorName": "A String", # Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
}
@@ -183,13 +183,6 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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 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.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -199,6 +192,13 @@
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
},
+ "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}`.
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
@@ -219,25 +219,59 @@
An object of the form:
{ # Represents a single object that is an item in the search index, such as a file, folder, or a database record.
- "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
+ "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
+ "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
+ "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
+ "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
+ "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ },
"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.
"hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object definition in the schema for the data source.
"properties": [ # The properties for the object. The maximum number of elements is 1000.
{ # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
+ "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.
+ "integerValues": { # List of integer values.
+ "values": [
"A String",
],
},
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "timestampValues": { # List of timestamp values.
- "values": [
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
"A String",
],
},
@@ -246,13 +280,8 @@
# Object with schema name: StructuredDataObject
],
},
- "enumValues": { # List of enum values.
- "values": [ # The maximum allowable length for string values is 32 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
+ "timestampValues": { # List of timestamp values.
+ "values": [
"A String",
],
},
@@ -265,76 +294,44 @@
},
],
},
- "integerValues": { # List of integer values.
+ "doubleValues": { # List of double values.
"values": [
+ 3.14,
+ ],
+ },
+ "enumValues": { # List of enum values.
+ "values": [ # The maximum allowable length for string values is 32 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.
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
},
- "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
- "contentFormat": "A String",
- "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.
+ "content": { # Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded. # Item content to be indexed and made text searchable.
"contentDataRef": { # Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef. # Upload reference ID of a previously uploaded content via write method.
"name": "A String", # Name of the content reference. 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.
},
- "itemType": "A String", # Type for this item.
- "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
- "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
- "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
- "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
- },
- "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. 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.
- "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
"status": { # This contains item's status and any errors. # Status of the item. Output only field.
"repositoryErrors": [ # Repository error reported by connector.
{ # Errors when the connector is communicating to the source repository.
"errorMessage": "A String", # Message that describes the error. The maximum allowable length of the message is 8192 characters.
- "type": "A String", # Type of error.
"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "type": "A String", # Type of error.
},
],
"processingErrors": [ # Error details in case the item is in ERROR state.
{
- "code": "A String", # Error code indicating the nature of the error.
"fieldViolations": [ # In case the item fields are invalid, this field contains the details about the validation errors.
{
"description": "A String", # Description of the error.
@@ -342,42 +339,45 @@
},
],
"errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
},
],
"code": "A String", # Status code.
},
+ "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
"metadata": { # Available metadata fields for the item. # Metadata information.
- "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
- "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
- },
- "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
- "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search 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.
"interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
{ # Represents an interaction between a user and an item.
- "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
- "type": "A String",
"principal": { # Reference to a user, group, or domain. # The user that acted on the item.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
"gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
},
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
},
+ "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
+ "type": "A String",
},
],
"title": "A String", # The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.
- "createTime": "A String", # The time when the item was created in the source repository.
- "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.
"objectType": "A String", # The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.
- "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
+ "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
"keywords": [ # Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.
"A String",
],
- "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
+ "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
+ "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
+ },
},
+ "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. 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.
}</pre>
</div>
@@ -391,34 +391,63 @@
The object takes the form of:
{
- "connectorName": "A String", # Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
- "mode": "A String", # Required. The RequestMode for this request.
"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.
},
- "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.
- },
"item": { # Represents a single object that is an item in the search index, such as a file, folder, or a database record. # Name of the item. Format: datasources/{source_id}/items/{item_id}
- "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
+ "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
+ "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
+ "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
+ "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
+ "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ },
"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.
"hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object definition in the schema for the data source.
"properties": [ # The properties for the object. The maximum number of elements is 1000.
{ # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
+ "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.
+ "integerValues": { # List of integer values.
+ "values": [
"A String",
],
},
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "timestampValues": { # List of timestamp values.
- "values": [
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
"A String",
],
},
@@ -427,13 +456,8 @@
# Object with schema name: StructuredDataObject
],
},
- "enumValues": { # List of enum values.
- "values": [ # The maximum allowable length for string values is 32 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
+ "timestampValues": { # List of timestamp values.
+ "values": [
"A String",
],
},
@@ -446,76 +470,44 @@
},
],
},
- "integerValues": { # List of integer values.
+ "doubleValues": { # List of double values.
"values": [
+ 3.14,
+ ],
+ },
+ "enumValues": { # List of enum values.
+ "values": [ # The maximum allowable length for string values is 32 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.
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
},
- "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
- "contentFormat": "A String",
- "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.
+ "content": { # Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded. # Item content to be indexed and made text searchable.
"contentDataRef": { # Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef. # Upload reference ID of a previously uploaded content via write method.
"name": "A String", # Name of the content reference. 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.
},
- "itemType": "A String", # Type for this item.
- "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
- "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
- "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
- "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
- },
- "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. 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.
- "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
"status": { # This contains item's status and any errors. # Status of the item. Output only field.
"repositoryErrors": [ # Repository error reported by connector.
{ # Errors when the connector is communicating to the source repository.
"errorMessage": "A String", # Message that describes the error. The maximum allowable length of the message is 8192 characters.
- "type": "A String", # Type of error.
"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "type": "A String", # Type of error.
},
],
"processingErrors": [ # Error details in case the item is in ERROR state.
{
- "code": "A String", # Error code indicating the nature of the error.
"fieldViolations": [ # In case the item fields are invalid, this field contains the details about the validation errors.
{
"description": "A String", # Description of the error.
@@ -523,43 +515,51 @@
},
],
"errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
},
],
"code": "A String", # Status code.
},
+ "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
"metadata": { # Available metadata fields for the item. # Metadata information.
- "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
- "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
- },
- "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
- "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search 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.
"interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
{ # Represents an interaction between a user and an item.
- "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
- "type": "A String",
"principal": { # Reference to a user, group, or domain. # The user that acted on the item.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
"gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
},
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
},
+ "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
+ "type": "A String",
},
],
"title": "A String", # The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.
- "createTime": "A String", # The time when the item was created in the source repository.
- "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.
"objectType": "A String", # The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.
- "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
+ "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
"keywords": [ # Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.
"A String",
],
- "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
+ "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
+ "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
+ },
},
+ "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. 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.
},
+ "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. Format: datasources/{source_id}/connectors/{ID}
+ "mode": "A String", # Required. The RequestMode for this request.
}
x__xgafv: string, V1 error format.
@@ -572,13 +572,6 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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 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.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -588,20 +581,27 @@
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
},
+ "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}`.
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(name, debugOptions_enableDebugging=None, pageSize=None, pageToken=None, connectorName=None, brief=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(name, pageToken=None, debugOptions_enableDebugging=None, brief=None, connectorName=None, pageSize=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)
- debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
- 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. The default value is 10
pageToken: string, The next_page_token value returned from a previous List request, if any.
- connectorName: string, Name of connector making this call. 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.
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, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, If this value is false, then all the fields are populated in Item.
+ connectorName: string, Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
+ 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. The default value is 10
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -613,25 +613,59 @@
{
"items": [
{ # Represents a single object that is an item in the search index, such as a file, folder, or a database record.
- "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
+ "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
+ "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
+ "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
+ "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
+ "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ },
"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.
"hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object definition in the schema for the data source.
"properties": [ # The properties for the object. The maximum number of elements is 1000.
{ # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
+ "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.
+ "integerValues": { # List of integer values.
+ "values": [
"A String",
],
},
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "timestampValues": { # List of timestamp values.
- "values": [
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
"A String",
],
},
@@ -640,13 +674,8 @@
# Object with schema name: StructuredDataObject
],
},
- "enumValues": { # List of enum values.
- "values": [ # The maximum allowable length for string values is 32 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
+ "timestampValues": { # List of timestamp values.
+ "values": [
"A String",
],
},
@@ -659,76 +688,44 @@
},
],
},
- "integerValues": { # List of integer values.
+ "doubleValues": { # List of double values.
"values": [
+ 3.14,
+ ],
+ },
+ "enumValues": { # List of enum values.
+ "values": [ # The maximum allowable length for string values is 32 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.
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
},
- "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
- "contentFormat": "A String",
- "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.
+ "content": { # Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded. # Item content to be indexed and made text searchable.
"contentDataRef": { # Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef. # Upload reference ID of a previously uploaded content via write method.
"name": "A String", # Name of the content reference. 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.
},
- "itemType": "A String", # Type for this item.
- "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
- "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
- "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
- "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
- },
- "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. 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.
- "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
"status": { # This contains item's status and any errors. # Status of the item. Output only field.
"repositoryErrors": [ # Repository error reported by connector.
{ # Errors when the connector is communicating to the source repository.
"errorMessage": "A String", # Message that describes the error. The maximum allowable length of the message is 8192 characters.
- "type": "A String", # Type of error.
"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "type": "A String", # Type of error.
},
],
"processingErrors": [ # Error details in case the item is in ERROR state.
{
- "code": "A String", # Error code indicating the nature of the error.
"fieldViolations": [ # In case the item fields are invalid, this field contains the details about the validation errors.
{
"description": "A String", # Description of the error.
@@ -736,42 +733,45 @@
},
],
"errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
},
],
"code": "A String", # Status code.
},
+ "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
"metadata": { # Available metadata fields for the item. # Metadata information.
- "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
- "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
- },
- "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
- "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search 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.
"interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
{ # Represents an interaction between a user and an item.
- "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
- "type": "A String",
"principal": { # Reference to a user, group, or domain. # The user that acted on the item.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
"gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
},
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
},
+ "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
+ "type": "A String",
},
],
"title": "A String", # The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.
- "createTime": "A String", # The time when the item was created in the source repository.
- "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.
"objectType": "A String", # The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.
- "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
+ "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
"keywords": [ # Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.
"A String",
],
- "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
+ "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
+ "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
+ },
},
+ "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. 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.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
@@ -802,15 +802,15 @@
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.
- "limit": 42, # Maximum number of items to return. The maximum value is 100 and the default value is 20.
"connectorName": "A String", # Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
- "statusCodes": [ # Limit the items polled to the ones with these statuses.
- "A String",
- ],
"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. The maximum value is 100 and the default value is 20.
+ "queue": "A String", # Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.
+ "statusCodes": [ # Limit the items polled to the ones with these statuses.
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
@@ -824,25 +824,59 @@
{
"items": [ # Set of items from the queue available for connector to process. These items have the following subset of fields populated: version metadata.hash structured_data.hash content.hash payload status queue
{ # Represents a single object that is an item in the search index, such as a file, folder, or a database record.
- "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
+ "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
+ "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
+ "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
+ "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
+ "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ },
"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.
"hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object definition in the schema for the data source.
"properties": [ # The properties for the object. The maximum number of elements is 1000.
{ # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
+ "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.
+ "integerValues": { # List of integer values.
+ "values": [
"A String",
],
},
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "timestampValues": { # List of timestamp values.
- "values": [
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
"A String",
],
},
@@ -851,13 +885,8 @@
# Object with schema name: StructuredDataObject
],
},
- "enumValues": { # List of enum values.
- "values": [ # The maximum allowable length for string values is 32 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
+ "timestampValues": { # List of timestamp values.
+ "values": [
"A String",
],
},
@@ -870,76 +899,44 @@
},
],
},
- "integerValues": { # List of integer values.
+ "doubleValues": { # List of double values.
"values": [
+ 3.14,
+ ],
+ },
+ "enumValues": { # List of enum values.
+ "values": [ # The maximum allowable length for string values is 32 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.
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
},
- "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
- "contentFormat": "A String",
- "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.
+ "content": { # Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded. # Item content to be indexed and made text searchable.
"contentDataRef": { # Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef. # Upload reference ID of a previously uploaded content via write method.
"name": "A String", # Name of the content reference. 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.
},
- "itemType": "A String", # Type for this item.
- "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
- "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
- "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
- "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
- },
- "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. 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.
- "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
"status": { # This contains item's status and any errors. # Status of the item. Output only field.
"repositoryErrors": [ # Repository error reported by connector.
{ # Errors when the connector is communicating to the source repository.
"errorMessage": "A String", # Message that describes the error. The maximum allowable length of the message is 8192 characters.
- "type": "A String", # Type of error.
"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "type": "A String", # Type of error.
},
],
"processingErrors": [ # Error details in case the item is in ERROR state.
{
- "code": "A String", # Error code indicating the nature of the error.
"fieldViolations": [ # In case the item fields are invalid, this field contains the details about the validation errors.
{
"description": "A String", # Description of the error.
@@ -947,42 +944,45 @@
},
],
"errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
},
],
"code": "A String", # Status code.
},
+ "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
"metadata": { # Available metadata fields for the item. # Metadata information.
- "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
- "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
- },
- "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
- "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search 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.
"interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
{ # Represents an interaction between a user and an item.
- "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
- "type": "A String",
"principal": { # Reference to a user, group, or domain. # The user that acted on the item.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
"gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
},
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
},
+ "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
+ "type": "A String",
},
],
"title": "A String", # The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.
- "createTime": "A String", # The time when the item was created in the source repository.
- "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.
"objectType": "A String", # The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.
- "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
+ "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
"keywords": [ # Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.
"A String",
],
- "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
+ "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
+ "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
+ },
},
+ "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. 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.
},
],
}</pre>
@@ -998,23 +998,23 @@
The object takes the form of:
{
+ "connectorName": "A String", # Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
"item": { # Represents an item to be pushed to the indexing queue. # Item to push onto the queue.
+ "metadataHash": "A String", # Metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
"contentHash": "A String", # Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
- "queue": "A String", # Queue to which this item belongs to. The default queue is chosen if this field is not specified. The maximum length is 512 characters.
"structuredDataHash": "A String", # Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
"repositoryError": { # Errors when the connector is communicating to the source repository. # Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR.
"errorMessage": "A String", # Message that describes the error. The maximum allowable length of the message is 8192 characters.
- "type": "A String", # Type of error.
"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "type": "A String", # Type of error.
},
"payload": "A String", # Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes.
- "metadataHash": "A String", # Metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
"type": "A String", # The type of the push operation that defines the push behavior.
+ "queue": "A String", # Queue to which this item belongs to. The default queue is chosen if this field is not specified. The maximum length is 512 characters.
},
"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. Format: datasources/{source_id}/connectors/{ID}
}
x__xgafv: string, V1 error format.
@@ -1026,25 +1026,59 @@
An object of the form:
{ # Represents a single object that is an item in the search index, such as a file, folder, or a database record.
- "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
+ "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
+ "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
+ "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
+ "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
+ "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
+ { # Reference to a user, group, or domain.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
+ },
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
+ "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
+ },
+ ],
+ },
"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.
"hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object definition in the schema for the data source.
"properties": [ # The properties for the object. The maximum number of elements is 1000.
{ # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
+ "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.
+ "integerValues": { # List of integer values.
+ "values": [
"A String",
],
},
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "timestampValues": { # List of timestamp values.
- "values": [
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
"A String",
],
},
@@ -1053,13 +1087,8 @@
# Object with schema name: StructuredDataObject
],
},
- "enumValues": { # List of enum values.
- "values": [ # The maximum allowable length for string values is 32 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
+ "timestampValues": { # List of timestamp values.
+ "values": [
"A String",
],
},
@@ -1072,76 +1101,44 @@
},
],
},
- "integerValues": { # List of integer values.
+ "doubleValues": { # List of double values.
"values": [
+ 3.14,
+ ],
+ },
+ "enumValues": { # List of enum values.
+ "values": [ # The maximum allowable length for string values is 32 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.
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
},
],
},
},
- "content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
- "contentFormat": "A String",
- "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.
+ "content": { # Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded. # Item content to be indexed and made text searchable.
"contentDataRef": { # Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef. # Upload reference ID of a previously uploaded content via write method.
"name": "A String", # Name of the content reference. 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.
},
- "itemType": "A String", # Type for this item.
- "queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.
- "acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.
- "owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
- "deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
- { # Reference to a user, group, or domain.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
- "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
- "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
- "gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
- },
- "groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
- },
- ],
- "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 field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
- },
- "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. 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.
- "payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.
"status": { # This contains item's status and any errors. # Status of the item. Output only field.
"repositoryErrors": [ # Repository error reported by connector.
{ # Errors when the connector is communicating to the source repository.
"errorMessage": "A String", # Message that describes the error. The maximum allowable length of the message is 8192 characters.
- "type": "A String", # Type of error.
"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "type": "A String", # Type of error.
},
],
"processingErrors": [ # Error details in case the item is in ERROR state.
{
- "code": "A String", # Error code indicating the nature of the error.
"fieldViolations": [ # In case the item fields are invalid, this field contains the details about the validation errors.
{
"description": "A String", # Description of the error.
@@ -1149,42 +1146,45 @@
},
],
"errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
},
],
"code": "A String", # Status code.
},
+ "name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
"metadata": { # Available metadata fields for the item. # Metadata information.
- "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
- "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
- },
- "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
- "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search 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.
"interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
{ # Represents an interaction between a user and an item.
- "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
- "type": "A String",
"principal": { # Reference to a user, group, or domain. # The user that acted on the item.
- "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
"gsuiteUserEmail": "A String", # This principal references a G Suite user account
- "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the customer.
},
+ "userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
},
+ "interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
+ "type": "A String",
},
],
"title": "A String", # The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.
- "createTime": "A String", # The time when the item was created in the source repository.
- "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
- "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.
"objectType": "A String", # The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.
- "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
+ "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
"keywords": [ # Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.
"A String",
],
- "hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
+ "contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
+ "mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
+ "searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item
+ "quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.
+ },
},
+ "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. 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.
}</pre>
</div>
@@ -1198,11 +1198,11 @@
The object takes the form of:
{
+ "connectorName": "A String", # Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
+ "queue": "A String", # Name of a queue to unreserve items from.
"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.
},
- "queue": "A String", # Name of a queue to unreserve items from.
- "connectorName": "A String", # Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
}
x__xgafv: string, V1 error format.
@@ -1215,13 +1215,6 @@
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
- "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.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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 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.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -1231,6 +1224,13 @@
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
},
+ "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}`.
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>