IndexingConnectorContext
Stay organized with collections
Save and categorize content based on your preferences.
Public Methods
public
abstract
void
registerTraverser
(TraverserConfiguration configuration)
Parameters
| configuration |
parameters for a Cloud Search queue polling task
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-18 UTC.
[null,null,["Last updated 2025-03-18 UTC."],[],[],null,["# IndexingConnectorContext\n\npublic interface **IndexingConnectorContext** implements [ConnectorContext](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/ConnectorContext) \nInterface for a context object created by the SDK to pass to the [IndexingConnector](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingConnector) code.\n\nThe [IndexingApplication](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingApplication) object creates a context instance containing an\n[IndexingService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingService) instance, [ExceptionHandler](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/ExceptionHandler)\ninstances, and [TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration) instances for the connector to access. It calls the\n[init(IndexingConnectorContext)](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingConnector#init(com.google.enterprise.cloudsearch.sdk.indexing.IndexingConnectorContext)) method to pass the context to\nthe connector code. \n\n### Public Method Summary\n\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [IndexingService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingService) | [getIndexingService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingConnectorContext#getIndexingService())() Returns the [IndexingService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingService) instance used to communicate with the Cloud Search API. |\n| abstract List\\\u003c[TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration)\\\u003e | [getTraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingConnectorContext#getTraverserConfiguration())() Returns the list of [TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration) registered by the connector during [init(IndexingConnectorContext)](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingConnector#init(com.google.enterprise.cloudsearch.sdk.indexing.IndexingConnectorContext)). |\n| abstract void | [registerTraverser](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingConnectorContext#registerTraverser(com.google.enterprise.cloudsearch.sdk.indexing.traverser.TraverserConfiguration))([TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration) configuration) Creates and registers [TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration) instances. |\n\n### Inherited Method Summary\n\nFrom interface [com.google.enterprise.cloudsearch.sdk.ConnectorContext](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/ConnectorContext) \n\n|--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [ExceptionHandler](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/ExceptionHandler) | [getIncrementalTraversalExceptionHandler](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/ConnectorContext#getIncrementalTraversalExceptionHandler())() Returns the exception handler used by the [handleIncrementalChanges()](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/IncrementalChangeHandler#handleIncrementalChanges()) method call. |\n| abstract [ExceptionHandler](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/ExceptionHandler) | [getTraversalExceptionHandler](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/ConnectorContext#getTraversalExceptionHandler())() Returns the exception handler used by the [traverse()](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/Connector#traverse()) method call. |\n\nPublic Methods\n--------------\n\n#### public abstract [IndexingService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingService)\n**getIndexingService**\n()\n\nReturns the [IndexingService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingService) instance used to communicate with the Cloud Search API. \n\n##### Returns\n\n- an [IndexingService](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingService) instance \n\n#### public abstract List\\\u003c[TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration)\\\u003e\n**getTraverserConfiguration**\n()\n\nReturns the list of [TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration) registered by the connector during\n[init(IndexingConnectorContext)](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingConnector#init(com.google.enterprise.cloudsearch.sdk.indexing.IndexingConnectorContext)). \n\n##### Returns\n\n- a list of [TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration) \n\n#### public abstract void\n**registerTraverser**\n([TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration) configuration)\n\nCreates and registers [TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration) instances.\n\nA [TraverserConfiguration](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/traverser/TraverserConfiguration) instance defines a Cloud Search queue polling task. The\n[IndexingConnector](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/IndexingConnector) uses this method when it implements the [ItemRetriever](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/indexing/ItemRetriever)\ninterface. \n\n##### Parameters\n\n| configuration | parameters for a Cloud Search queue polling task |\n|---------------|--------------------------------------------------|"]]
