docs: update generated docs (#981)
diff --git a/docs/dyn/cloudsearch_v1.debug.datasources.items.html b/docs/dyn/cloudsearch_v1.debug.datasources.items.html
index 6c2adf9..aaf7459 100644
--- a/docs/dyn/cloudsearch_v1.debug.datasources.items.html
+++ b/docs/dyn/cloudsearch_v1.debug.datasources.items.html
@@ -102,18 +102,18 @@
The object takes the form of:
{ # 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}
}
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
@@ -145,13 +145,13 @@
The object takes the form of:
{
+ "viewUrl": "A String", # Specify the full view URL to find the corresponding item.
+ # The maximum length is 2048 characters.
+ "pageToken": "A String", # The next_page_token value returned from a previous request, if any.
"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.
},
- "pageToken": "A String", # The next_page_token value returned from a previous request, if any.
- "viewUrl": "A String", # Specify the full view URL to find the corresponding item.
- # The maximum length is 2048 characters.
}
x__xgafv: string, V1 error format.
@@ -163,10 +163,13 @@
An object of the form:
{
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
"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.
@@ -181,46 +184,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.
},
],
},
@@ -229,41 +213,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. Search results apply
+ # this link to the title.
+ # Whitespace or special characters may cause Cloud Search result links to
+ # trigger a redirect notice; to avoid this, encode the URL.
+ # The maximum length is 2048 characters.
+ "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
@@ -271,43 +322,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.
@@ -330,93 +375,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.
@@ -425,27 +408,44 @@
"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
- # more results in the list.
}</pre>
</div>