Class SetUriPatternDocumentDataRequest (0.12.2)

Version 0.12.2

• 0.12.3 (latest)
• 0.12.2
• 0.11.14
• 0.10.0
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.1

SetUriPatternDocumentDataRequest(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Request message for SiteSearchEngineService.SetUriPatternDocumentData method.

Attributes
Name	Description
site_search_engine	str Required. Full resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.
document_data_map	MutableMapping[str, google.protobuf.struct_pb2.Struct] Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" } } } document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
empty_document_data_map	bool If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.
schema	google.protobuf.struct_pb2.Struct Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.

Classes

DocumentDataMapEntry

DocumentDataMapEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.