docs: update generated docs (#981)
diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html
index 5d33bfc..1f40dd1 100644
--- a/docs/dyn/cloudsearch_v1.indexing.datasources.items.html
+++ b/docs/dyn/cloudsearch_v1.indexing.datasources.items.html
@@ -75,7 +75,7 @@
<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.indexing.html">indexing</a> . <a href="cloudsearch_v1.indexing.datasources.html">datasources</a> . <a href="cloudsearch_v1.indexing.datasources.items.html">items</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#delete">delete(name, connectorName=None, debugOptions_enableDebugging=None, version=None, mode=None, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(name, version=None, mode=None, debugOptions_enableDebugging=None, connectorName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes Item resource for the</p>
<p class="toc_element">
<code><a href="#deleteQueueItems">deleteQueueItems(name, body=None, x__xgafv=None)</a></code></p>
@@ -87,7 +87,7 @@
<code><a href="#index">index(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates Item ACL, metadata, and</p>
<p class="toc_element">
- <code><a href="#list">list(name, debugOptions_enableDebugging=None, connectorName=None, brief=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(name, connectorName=None, pageSize=None, debugOptions_enableDebugging=None, pageToken=None, brief=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all or a subset of Item resources.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -106,7 +106,7 @@
<p class="firstline">Creates an upload session for uploading item content. For items smaller</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="delete">delete(name, connectorName=None, debugOptions_enableDebugging=None, version=None, mode=None, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(name, version=None, mode=None, debugOptions_enableDebugging=None, connectorName=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
@@ -115,10 +115,6 @@
Args:
name: string, Required. Name of the item to delete.
Format: datasources/{source_id}/items/{item_id} (required)
- connectorName: string, Name of connector making this call.
-<br />Format: datasources/{source_id}/connectors/{ID}
- debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
-Otherwise, ignore this field.
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
@@ -129,6 +125,10 @@
the version of the currently indexed item.
The maximum length for this field is 1024 bytes.
mode: string, Required. The RequestMode for this request.
+ 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.
+<br />Format: datasources/{source_id}/connectors/{ID}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -149,9 +149,12 @@
# `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.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -165,17 +168,14 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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.
- },
+ "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}`.
"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.
@@ -197,13 +197,13 @@
The object takes the form of:
{
+ "queue": "A String", # Name of a queue to delete items from.
+ "connectorName": "A String", # Name of connector making this call.
+ # <br />Format: datasources/{source_id}/connectors/{ID}
"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
# Otherwise, ignore this field.
},
- "connectorName": "A String", # Name of connector making this call.
- # <br />Format: datasources/{source_id}/connectors/{ID}
- "queue": "A String", # Name of a queue to delete items from.
}
x__xgafv: string, V1 error format.
@@ -226,9 +226,12 @@
# `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.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -242,17 +245,14 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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.
- },
+ "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}`.
"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.
@@ -283,7 +283,8 @@
{ # Represents a single object that is an item in the search index, such as a
# file, folder, or a database record.
- "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to.
+ # The maximum length is 100 characters.
"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.
@@ -298,46 +299,27 @@
{ # 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`.
- "integerValues": { # List of integer values.
- "values": [
- "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.
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
"timestampValues": { # List of timestamp values.
"values": [
"A String",
],
},
- "objectValues": { # List of object values.
+ "doubleValues": { # List of double values.
"values": [
- # Object with schema name: StructuredDataObject
+ 3.14,
+ ],
+ },
+ "integerValues": { # List of integer values.
+ "values": [
+ "A String",
],
},
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
+ "year": 42, # Year of date. Must be from 1 to 9999.
"month": 42, # Month of date. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
- "year": 42, # Year of date. Must be from 1 to 9999.
},
],
},
@@ -346,41 +328,108 @@
"A String",
],
},
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
+ "objectValues": { # List of object values.
+ "values": [
+ # Object with schema name: StructuredDataObject
+ ],
+ },
},
],
},
},
- "status": { # This contains item's status and any errors. # Status of the item.
- # Output only field.
- "processingErrors": [ # Error details in case the item is in ERROR state.
- {
- "fieldViolations": [ # In case the item fields are invalid, this field contains the details
- # about the validation errors.
- {
- "description": "A String", # Description of the error.
- "field": "A String", # Path of field with violation.
+ "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.
+ },
+ "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.
+ "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.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
+ # this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
+ # The maximum length is 2048 characters.
+ "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.
+ "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
+ # customer.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
- ],
- "errorMessage": "A String", # Description of the error.
- "code": "A String", # Error code indicating the nature of the error.
+ "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}
+ "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}
+ },
+ "type": "A String",
+ "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.
},
],
- "code": "A String", # Status code.
- "repositoryErrors": [ # Repository error reported by connector.
- { # Errors when the connector is communicating to the source repository.
- "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
- "errorMessage": "A String", # Message that describes the error. The maximum allowable length
- # of the message is 8192 characters.
- "type": "A String", # Type of error.
- },
+ "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.
+ "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",
],
+ "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.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "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.
},
- "name": "A String", # Name of the Item. Format:
- # datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
- # The maximum length is 1536 characters.
- "payload": "A String", # Additional state connector can store for this item.
- # The maximum length is 10000 bytes.
+ "version": "A String", # Required. The indexing system stores the version from the datasource as a
+ # byte string and compares the Item version in the index
+ # to the version of the queued Item using lexical ordering.
+ # <br /><br />
+ # 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.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
# [Map ACLs](/cloud-search/docs/guides/acls).
"owners": [ # Optional. List of owners for the item. This field has no bearing on
@@ -388,43 +437,37 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- "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.
"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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
@@ -447,93 +490,31 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- },
- "metadata": { # Available metadata fields for the item. # Metadata information.
- "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.
- "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.
- },
- "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.
- "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.
- "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.
- "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}
- },
- "type": "A String",
- },
- ],
- "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",
- ],
- "mimeType": "A String", # The original mime-type of
- # ItemContent.content
- # in the source repository.
- # The maximum length is 256 characters.
- "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.
- "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.
- "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. &#83;earch results apply
- # this link to the title.
- # Whitespace or special characters may cause Cloud &#83;earch result links to
- # trigger a redirect notice; to avoid this, encode the URL.
- # The maximum length is 2048 characters.
- "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
+ "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. The maximum length is 1536 characters.
+ # field. Also, when the
+ # inheritAclFrom field
+ # is set, this field should be set to a valid AclInheritanceType.
},
"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
+ "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.
"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
# This reference is created via upload
# method.
@@ -542,23 +523,42 @@
"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.
- "contentFormat": "A String",
},
- "version": "A String", # Required. The indexing system stores the version from the datasource as a
- # byte string and compares the Item version in the index
- # to the version of the queued Item using lexical ordering.
- # <br /><br />
- # 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.
- "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.
+ "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.
+ "type": "A String", # Type of error.
+ "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "errorMessage": "A String", # Message that describes the error. The maximum allowable length
+ # of the message is 8192 characters.
+ },
+ ],
+ "code": "A String", # Status code.
+ "processingErrors": [ # Error details in case the item is in ERROR state.
+ {
+ "fieldViolations": [ # In case the item fields are invalid, this field contains the details
+ # about the validation errors.
+ {
+ "description": "A String", # Description of the error.
+ "field": "A String", # Path of field with violation.
+ },
+ ],
+ "errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
+ },
+ ],
+ },
+ "name": "A String", # Name of the Item. Format:
+ # datasources/{source_id}/items/{item_id}
+ # <br />This is a required field.
+ # The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
}</pre>
</div>
@@ -586,10 +586,17 @@
"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
# Otherwise, ignore this field.
},
+ "connectorName": "A String", # Name of connector making this call.
+ # <br />Format: datasources/{source_id}/connectors/{ID}
+ "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.
+ },
"item": { # Represents a single object that is an item in the search index, such as a # Name of the item. Format:
# datasources/{source_id}/items/{item_id}
# file, folder, or a database record.
- "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to.
+ # The maximum length is 100 characters.
"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.
@@ -604,46 +611,27 @@
{ # 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`.
- "integerValues": { # List of integer values.
- "values": [
- "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.
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
"timestampValues": { # List of timestamp values.
"values": [
"A String",
],
},
- "objectValues": { # List of object values.
+ "doubleValues": { # List of double values.
"values": [
- # Object with schema name: StructuredDataObject
+ 3.14,
+ ],
+ },
+ "integerValues": { # List of integer values.
+ "values": [
+ "A String",
],
},
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
+ "year": 42, # Year of date. Must be from 1 to 9999.
"month": 42, # Month of date. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
- "year": 42, # Year of date. Must be from 1 to 9999.
},
],
},
@@ -652,41 +640,108 @@
"A String",
],
},
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
+ "objectValues": { # List of object values.
+ "values": [
+ # Object with schema name: StructuredDataObject
+ ],
+ },
},
],
},
},
- "status": { # This contains item's status and any errors. # Status of the item.
- # Output only field.
- "processingErrors": [ # Error details in case the item is in ERROR state.
- {
- "fieldViolations": [ # In case the item fields are invalid, this field contains the details
- # about the validation errors.
- {
- "description": "A String", # Description of the error.
- "field": "A String", # Path of field with violation.
+ "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.
+ },
+ "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.
+ "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.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
+ # this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
+ # The maximum length is 2048 characters.
+ "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.
+ "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
+ # customer.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
- ],
- "errorMessage": "A String", # Description of the error.
- "code": "A String", # Error code indicating the nature of the error.
+ "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}
+ "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}
+ },
+ "type": "A String",
+ "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.
},
],
- "code": "A String", # Status code.
- "repositoryErrors": [ # Repository error reported by connector.
- { # Errors when the connector is communicating to the source repository.
- "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
- "errorMessage": "A String", # Message that describes the error. The maximum allowable length
- # of the message is 8192 characters.
- "type": "A String", # Type of error.
- },
+ "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.
+ "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",
],
+ "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.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "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.
},
- "name": "A String", # Name of the Item. Format:
- # datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
- # The maximum length is 1536 characters.
- "payload": "A String", # Additional state connector can store for this item.
- # The maximum length is 10000 bytes.
+ "version": "A String", # Required. The indexing system stores the version from the datasource as a
+ # byte string and compares the Item version in the index
+ # to the version of the queued Item using lexical ordering.
+ # <br /><br />
+ # 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.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
# [Map ACLs](/cloud-search/docs/guides/acls).
"owners": [ # Optional. List of owners for the item. This field has no bearing on
@@ -694,43 +749,37 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- "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.
"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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
@@ -753,93 +802,31 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- },
- "metadata": { # Available metadata fields for the item. # Metadata information.
- "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.
- "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.
- },
- "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.
- "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.
- "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.
- "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}
- },
- "type": "A String",
- },
- ],
- "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",
- ],
- "mimeType": "A String", # The original mime-type of
- # ItemContent.content
- # in the source repository.
- # The maximum length is 256 characters.
- "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.
- "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.
- "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. &#83;earch results apply
- # this link to the title.
- # Whitespace or special characters may cause Cloud &#83;earch result links to
- # trigger a redirect notice; to avoid this, encode the URL.
- # The maximum length is 2048 characters.
- "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
+ "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. The maximum length is 1536 characters.
+ # field. Also, when the
+ # inheritAclFrom field
+ # is set, this field should be set to a valid AclInheritanceType.
},
"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
+ "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.
"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
# This reference is created via upload
# method.
@@ -848,30 +835,43 @@
"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.
- "contentFormat": "A String",
},
- "version": "A String", # Required. The indexing system stores the version from the datasource as a
- # byte string and compares the Item version in the index
- # to the version of the queued Item using lexical ordering.
- # <br /><br />
- # 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.
- "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.
+ "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.
+ "type": "A String", # Type of error.
+ "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "errorMessage": "A String", # Message that describes the error. The maximum allowable length
+ # of the message is 8192 characters.
+ },
+ ],
+ "code": "A String", # Status code.
+ "processingErrors": [ # Error details in case the item is in ERROR state.
+ {
+ "fieldViolations": [ # In case the item fields are invalid, this field contains the details
+ # about the validation errors.
+ {
+ "description": "A String", # Description of the error.
+ "field": "A String", # Path of field with violation.
+ },
+ ],
+ "errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
+ },
+ ],
+ },
+ "name": "A String", # Name of the Item. Format:
+ # datasources/{source_id}/items/{item_id}
+ # <br />This is a required field.
+ # The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
},
- "indexItemOptions": {
- "allowUnknownGsuitePrincipals": True or False, # Specifies if the index request should allow gsuite principals that do not
- # exist or are deleted in the index request.
- },
- "connectorName": "A String", # Name of connector making this call.
- # <br />Format: datasources/{source_id}/connectors/{ID}
"mode": "A String", # Required. The RequestMode for this request.
}
@@ -895,9 +895,12 @@
# `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.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -911,17 +914,14 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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.
- },
+ "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}`.
"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.
@@ -929,7 +929,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(name, debugOptions_enableDebugging=None, connectorName=None, brief=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(name, connectorName=None, pageSize=None, debugOptions_enableDebugging=None, pageToken=None, brief=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
@@ -938,10 +938,15 @@
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.
connectorName: string, Name of connector making this call.
<br />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.
+<br />The default value is 10
+ debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
+Otherwise, ignore this field.
+ pageToken: string, The next_page_token value returned from a previous List request, if any.
brief: boolean, When set to true, the indexing system only populates the following fields:
name,
version,
@@ -961,11 +966,6 @@
itemStatus.processingError.code,
itemStatus.repositoryError.type,
<br />If this value is false, then all the fields are populated in Item.
- pageToken: string, The next_page_token value returned from a previous List request, if any.
- pageSize: integer, Maximum number of items to fetch in a request.
-The max value is 1000 when brief is true. The max value is 10 if brief
-is false.
-<br />The default value is 10
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -978,7 +978,8 @@
"items": [
{ # Represents a single object that is an item in the search index, such as a
# file, folder, or a database record.
- "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to.
+ # The maximum length is 100 characters.
"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.
@@ -993,46 +994,27 @@
{ # 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`.
- "integerValues": { # List of integer values.
- "values": [
- "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.
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
"timestampValues": { # List of timestamp values.
"values": [
"A String",
],
},
- "objectValues": { # List of object values.
+ "doubleValues": { # List of double values.
"values": [
- # Object with schema name: StructuredDataObject
+ 3.14,
+ ],
+ },
+ "integerValues": { # List of integer values.
+ "values": [
+ "A String",
],
},
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
+ "year": 42, # Year of date. Must be from 1 to 9999.
"month": 42, # Month of date. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
- "year": 42, # Year of date. Must be from 1 to 9999.
},
],
},
@@ -1041,41 +1023,108 @@
"A String",
],
},
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
+ "objectValues": { # List of object values.
+ "values": [
+ # Object with schema name: StructuredDataObject
+ ],
+ },
},
],
},
},
- "status": { # This contains item's status and any errors. # Status of the item.
- # Output only field.
- "processingErrors": [ # Error details in case the item is in ERROR state.
- {
- "fieldViolations": [ # In case the item fields are invalid, this field contains the details
- # about the validation errors.
- {
- "description": "A String", # Description of the error.
- "field": "A String", # Path of field with violation.
+ "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.
+ },
+ "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.
+ "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.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
+ # this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
+ # The maximum length is 2048 characters.
+ "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.
+ "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
+ # customer.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
- ],
- "errorMessage": "A String", # Description of the error.
- "code": "A String", # Error code indicating the nature of the error.
+ "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}
+ "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}
+ },
+ "type": "A String",
+ "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.
},
],
- "code": "A String", # Status code.
- "repositoryErrors": [ # Repository error reported by connector.
- { # Errors when the connector is communicating to the source repository.
- "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
- "errorMessage": "A String", # Message that describes the error. The maximum allowable length
- # of the message is 8192 characters.
- "type": "A String", # Type of error.
- },
+ "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.
+ "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",
],
+ "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.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "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.
},
- "name": "A String", # Name of the Item. Format:
- # datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
- # The maximum length is 1536 characters.
- "payload": "A String", # Additional state connector can store for this item.
- # The maximum length is 10000 bytes.
+ "version": "A String", # Required. The indexing system stores the version from the datasource as a
+ # byte string and compares the Item version in the index
+ # to the version of the queued Item using lexical ordering.
+ # <br /><br />
+ # 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.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
# [Map ACLs](/cloud-search/docs/guides/acls).
"owners": [ # Optional. List of owners for the item. This field has no bearing on
@@ -1083,43 +1132,37 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- "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.
"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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
@@ -1142,93 +1185,31 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- },
- "metadata": { # Available metadata fields for the item. # Metadata information.
- "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.
- "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.
- },
- "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.
- "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.
- "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.
- "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}
- },
- "type": "A String",
- },
- ],
- "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",
- ],
- "mimeType": "A String", # The original mime-type of
- # ItemContent.content
- # in the source repository.
- # The maximum length is 256 characters.
- "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.
- "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.
- "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. &#83;earch results apply
- # this link to the title.
- # Whitespace or special characters may cause Cloud &#83;earch result links to
- # trigger a redirect notice; to avoid this, encode the URL.
- # The maximum length is 2048 characters.
- "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
+ "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. The maximum length is 1536 characters.
+ # field. Also, when the
+ # inheritAclFrom field
+ # is set, this field should be set to a valid AclInheritanceType.
},
"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
+ "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.
"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
# This reference is created via upload
# method.
@@ -1237,23 +1218,42 @@
"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.
- "contentFormat": "A String",
},
- "version": "A String", # Required. The indexing system stores the version from the datasource as a
- # byte string and compares the Item version in the index
- # to the version of the queued Item using lexical ordering.
- # <br /><br />
- # 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.
- "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.
+ "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.
+ "type": "A String", # Type of error.
+ "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "errorMessage": "A String", # Message that describes the error. The maximum allowable length
+ # of the message is 8192 characters.
+ },
+ ],
+ "code": "A String", # Status code.
+ "processingErrors": [ # Error details in case the item is in ERROR state.
+ {
+ "fieldViolations": [ # In case the item fields are invalid, this field contains the details
+ # about the validation errors.
+ {
+ "description": "A String", # Description of the error.
+ "field": "A String", # Path of field with violation.
+ },
+ ],
+ "errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
+ },
+ ],
+ },
+ "name": "A String", # Name of the Item. Format:
+ # datasources/{source_id}/items/{item_id}
+ # <br />This is a required field.
+ # The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
@@ -1317,16 +1317,16 @@
"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
# Otherwise, ignore this field.
},
- "connectorName": "A String", # Name of connector making this call.
- # <br />Format: datasources/{source_id}/connectors/{ID}
- "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.
# <br />The maximum value is 100 and the default value is 20.
"statusCodes": [ # Limit the items polled to the ones with these statuses.
"A String",
],
+ "queue": "A String", # Queue name to fetch items from. If unspecified, PollItems will
+ # fetch from 'default' queue.
+ # The maximum length is 100 characters.
+ "connectorName": "A String", # Name of connector making this call.
+ # <br />Format: datasources/{source_id}/connectors/{ID}
}
x__xgafv: string, V1 error format.
@@ -1349,7 +1349,8 @@
# <br />queue
{ # Represents a single object that is an item in the search index, such as a
# file, folder, or a database record.
- "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to.
+ # The maximum length is 100 characters.
"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.
@@ -1364,46 +1365,27 @@
{ # 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`.
- "integerValues": { # List of integer values.
- "values": [
- "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.
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
"timestampValues": { # List of timestamp values.
"values": [
"A String",
],
},
- "objectValues": { # List of object values.
+ "doubleValues": { # List of double values.
"values": [
- # Object with schema name: StructuredDataObject
+ 3.14,
+ ],
+ },
+ "integerValues": { # List of integer values.
+ "values": [
+ "A String",
],
},
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
+ "year": 42, # Year of date. Must be from 1 to 9999.
"month": 42, # Month of date. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
- "year": 42, # Year of date. Must be from 1 to 9999.
},
],
},
@@ -1412,41 +1394,108 @@
"A String",
],
},
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
+ "objectValues": { # List of object values.
+ "values": [
+ # Object with schema name: StructuredDataObject
+ ],
+ },
},
],
},
},
- "status": { # This contains item's status and any errors. # Status of the item.
- # Output only field.
- "processingErrors": [ # Error details in case the item is in ERROR state.
- {
- "fieldViolations": [ # In case the item fields are invalid, this field contains the details
- # about the validation errors.
- {
- "description": "A String", # Description of the error.
- "field": "A String", # Path of field with violation.
+ "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.
+ },
+ "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.
+ "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.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
+ # this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
+ # The maximum length is 2048 characters.
+ "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.
+ "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
+ # customer.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
- ],
- "errorMessage": "A String", # Description of the error.
- "code": "A String", # Error code indicating the nature of the error.
+ "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}
+ "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}
+ },
+ "type": "A String",
+ "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.
},
],
- "code": "A String", # Status code.
- "repositoryErrors": [ # Repository error reported by connector.
- { # Errors when the connector is communicating to the source repository.
- "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
- "errorMessage": "A String", # Message that describes the error. The maximum allowable length
- # of the message is 8192 characters.
- "type": "A String", # Type of error.
- },
+ "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.
+ "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",
],
+ "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.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "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.
},
- "name": "A String", # Name of the Item. Format:
- # datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
- # The maximum length is 1536 characters.
- "payload": "A String", # Additional state connector can store for this item.
- # The maximum length is 10000 bytes.
+ "version": "A String", # Required. The indexing system stores the version from the datasource as a
+ # byte string and compares the Item version in the index
+ # to the version of the queued Item using lexical ordering.
+ # <br /><br />
+ # 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.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
# [Map ACLs](/cloud-search/docs/guides/acls).
"owners": [ # Optional. List of owners for the item. This field has no bearing on
@@ -1454,43 +1503,37 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- "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.
"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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
@@ -1513,93 +1556,31 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- },
- "metadata": { # Available metadata fields for the item. # Metadata information.
- "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.
- "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.
- },
- "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.
- "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.
- "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.
- "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}
- },
- "type": "A String",
- },
- ],
- "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",
- ],
- "mimeType": "A String", # The original mime-type of
- # ItemContent.content
- # in the source repository.
- # The maximum length is 256 characters.
- "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.
- "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.
- "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. &#83;earch results apply
- # this link to the title.
- # Whitespace or special characters may cause Cloud &#83;earch result links to
- # trigger a redirect notice; to avoid this, encode the URL.
- # The maximum length is 2048 characters.
- "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
+ "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. The maximum length is 1536 characters.
+ # field. Also, when the
+ # inheritAclFrom field
+ # is set, this field should be set to a valid AclInheritanceType.
},
"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
+ "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.
"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
# This reference is created via upload
# method.
@@ -1608,23 +1589,42 @@
"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.
- "contentFormat": "A String",
},
- "version": "A String", # Required. The indexing system stores the version from the datasource as a
- # byte string and compares the Item version in the index
- # to the version of the queued Item using lexical ordering.
- # <br /><br />
- # 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.
- "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.
+ "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.
+ "type": "A String", # Type of error.
+ "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "errorMessage": "A String", # Message that describes the error. The maximum allowable length
+ # of the message is 8192 characters.
+ },
+ ],
+ "code": "A String", # Status code.
+ "processingErrors": [ # Error details in case the item is in ERROR state.
+ {
+ "fieldViolations": [ # In case the item fields are invalid, this field contains the details
+ # about the validation errors.
+ {
+ "description": "A String", # Description of the error.
+ "field": "A String", # Path of field with violation.
+ },
+ ],
+ "errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
+ },
+ ],
+ },
+ "name": "A String", # Name of the Item. Format:
+ # datasources/{source_id}/items/{item_id}
+ # <br />This is a required field.
+ # The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
},
],
}</pre>
@@ -1649,11 +1649,24 @@
{
"connectorName": "A String", # Name of connector making this call.
# <br />Format: datasources/{source_id}/connectors/{ID}
- "debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
- "enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.
- # Otherwise, ignore this field.
- },
"item": { # Represents an item to be pushed to the indexing queue. # Item to push onto the queue.
+ "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.
+ "type": "A String", # Type of error.
+ "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "errorMessage": "A String", # Message that describes the error. The maximum allowable length
+ # of the message is 8192 characters.
+ },
+ "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.
+ "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 <code>default</code> queue is
+ # chosen if this field is not specified. The maximum length is
+ # 512 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
@@ -1666,29 +1679,16 @@
# type field results in argument
# error.
# The maximum length is 2048 characters.
- "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.
- "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.
- "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
- "errorMessage": "A String", # Message that describes the error. The maximum allowable length
- # of the message is 8192 characters.
- "type": "A String", # Type of error.
- },
- "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 <code>default</code> 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.
},
+ "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.
+ },
}
x__xgafv: string, V1 error format.
@@ -1701,7 +1701,8 @@
{ # Represents a single object that is an item in the search index, such as a
# file, folder, or a database record.
- "itemType": "A String", # Type for this item.
+ "queue": "A String", # Queue this item belongs to.
+ # The maximum length is 100 characters.
"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.
@@ -1716,46 +1717,27 @@
{ # 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`.
- "integerValues": { # List of integer values.
- "values": [
- "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.
- "doubleValues": { # List of double values.
- "values": [
- 3.14,
- ],
- },
- "booleanValue": True or False,
- "htmlValues": { # List of html values.
- "values": [ # The maximum allowable length for html values is 2048 characters.
- "A String",
- ],
- },
- "textValues": { # List of text values.
- "values": [ # The maximum allowable length for text values is 2048 characters.
- "A String",
- ],
- },
"timestampValues": { # List of timestamp values.
"values": [
"A String",
],
},
- "objectValues": { # List of object values.
+ "doubleValues": { # List of double values.
"values": [
- # Object with schema name: StructuredDataObject
+ 3.14,
+ ],
+ },
+ "integerValues": { # List of integer values.
+ "values": [
+ "A String",
],
},
"dateValues": { # List of date values.
"values": [
{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
+ "year": 42, # Year of date. Must be from 1 to 9999.
"month": 42, # Month of date. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.
- "year": 42, # Year of date. Must be from 1 to 9999.
},
],
},
@@ -1764,41 +1746,108 @@
"A String",
],
},
+ "textValues": { # List of text values.
+ "values": [ # The maximum allowable length for text values is 2048 characters.
+ "A String",
+ ],
+ },
+ "booleanValue": True or False,
+ "htmlValues": { # List of html values.
+ "values": [ # The maximum allowable length for html values is 2048 characters.
+ "A String",
+ ],
+ },
+ "name": "A String", # The name of the property. This name should correspond to the name of the
+ # property that was registered for object definition in the schema.
+ # The maximum allowable length for this property is 256 characters.
+ "objectValues": { # List of object values.
+ "values": [
+ # Object with schema name: StructuredDataObject
+ ],
+ },
},
],
},
},
- "status": { # This contains item's status and any errors. # Status of the item.
- # Output only field.
- "processingErrors": [ # Error details in case the item is in ERROR state.
- {
- "fieldViolations": [ # In case the item fields are invalid, this field contains the details
- # about the validation errors.
- {
- "description": "A String", # Description of the error.
- "field": "A String", # Path of field with violation.
+ "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.
+ },
+ "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.
+ "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.
+ "sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply
+ # this link to the title.
+ # Whitespace or special characters may cause Cloud &#83;earch result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
+ # The maximum length is 2048 characters.
+ "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.
+ "principal": { # Reference to a user, group, or domain. # The user that acted on the item.
+ "gsuitePrincipal": { # This principal is a GSuite user, group or domain.
+ "gsuiteGroupEmail": "A String", # This principal references a G Suite group account
+ "gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
+ # customer.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
- ],
- "errorMessage": "A String", # Description of the error.
- "code": "A String", # Error code indicating the nature of the error.
+ "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}
+ "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}
+ },
+ "type": "A String",
+ "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.
},
],
- "code": "A String", # Status code.
- "repositoryErrors": [ # Repository error reported by connector.
- { # Errors when the connector is communicating to the source repository.
- "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
- "errorMessage": "A String", # Message that describes the error. The maximum allowable length
- # of the message is 8192 characters.
- "type": "A String", # Type of error.
- },
+ "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.
+ "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",
],
+ "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.
+ "updateTime": "A String", # The time when the item was last modified in the source repository.
+ "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.
},
- "name": "A String", # Name of the Item. Format:
- # datasources/{source_id}/items/{item_id}
- # <br />This is a required field.
- # The maximum length is 1536 characters.
- "payload": "A String", # Additional state connector can store for this item.
- # The maximum length is 10000 bytes.
+ "version": "A String", # Required. The indexing system stores the version from the datasource as a
+ # byte string and compares the Item version in the index
+ # to the version of the queued Item using lexical ordering.
+ # <br /><br />
+ # 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.
"acl": { # Access control list information for the item. For more information see # Access control list for this item.
# [Map ACLs](/cloud-search/docs/guides/acls).
"owners": [ # Optional. List of owners for the item. This field has no bearing on
@@ -1806,43 +1855,37 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- "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.
"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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.
@@ -1865,93 +1908,31 @@
# 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.
+ "gsuiteUserEmail": "A String", # This principal references a G Suite user account
},
"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}
+ "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}
},
],
- },
- "metadata": { # Available metadata fields for the item. # Metadata information.
- "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.
- "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.
- },
- "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.
- "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.
- "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.
- "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}
- },
- "type": "A String",
- },
- ],
- "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",
- ],
- "mimeType": "A String", # The original mime-type of
- # ItemContent.content
- # in the source repository.
- # The maximum length is 256 characters.
- "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.
- "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.
- "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. &#83;earch results apply
- # this link to the title.
- # Whitespace or special characters may cause Cloud &#83;earch result links to
- # trigger a redirect notice; to avoid this, encode the URL.
- # The maximum length is 2048 characters.
- "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
+ "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. The maximum length is 1536 characters.
+ # field. Also, when the
+ # inheritAclFrom field
+ # is set, this field should be set to a valid AclInheritanceType.
},
"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.
+ "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.
"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.
# This reference is created via upload
# method.
@@ -1960,23 +1941,42 @@
"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.
- "contentFormat": "A String",
},
- "version": "A String", # Required. The indexing system stores the version from the datasource as a
- # byte string and compares the Item version in the index
- # to the version of the queued Item using lexical ordering.
- # <br /><br />
- # 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.
- "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.
+ "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.
+ "type": "A String", # Type of error.
+ "httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.
+ "errorMessage": "A String", # Message that describes the error. The maximum allowable length
+ # of the message is 8192 characters.
+ },
+ ],
+ "code": "A String", # Status code.
+ "processingErrors": [ # Error details in case the item is in ERROR state.
+ {
+ "fieldViolations": [ # In case the item fields are invalid, this field contains the details
+ # about the validation errors.
+ {
+ "description": "A String", # Description of the error.
+ "field": "A String", # Path of field with violation.
+ },
+ ],
+ "errorMessage": "A String", # Description of the error.
+ "code": "A String", # Error code indicating the nature of the error.
+ },
+ ],
+ },
+ "name": "A String", # Name of the Item. Format:
+ # datasources/{source_id}/items/{item_id}
+ # <br />This is a required field.
+ # The maximum length is 1536 characters.
+ "itemType": "A String", # Type for this item.
}</pre>
</div>
@@ -1996,13 +1996,13 @@
The object takes the form of:
{
- "connectorName": "A String", # Name of connector making this call.
- # <br />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.
},
+ "connectorName": "A String", # Name of connector making this call.
+ # <br />Format: datasources/{source_id}/connectors/{ID}
+ "queue": "A String", # Name of a queue to unreserve items from.
}
x__xgafv: string, V1 error format.
@@ -2025,9 +2025,12 @@
# `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.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -2041,17 +2044,14 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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.
- },
+ "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}`.
"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.