Class IndexedSharePointKnowledgeSourceParameters

java.lang.Object
com.azure.search.documents.indexes.models.IndexedSharePointKnowledgeSourceParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<IndexedSharePointKnowledgeSourceParameters>
public final class IndexedSharePointKnowledgeSourceParameters extends Object implements com.azure.json.JsonSerializable<IndexedSharePointKnowledgeSourceParameters>
Parameters for SharePoint knowledge source.

  • Constructor Details

    • IndexedSharePointKnowledgeSourceParameters

      public IndexedSharePointKnowledgeSourceParameters(String connectionString, IndexedSharePointContainerName containerName)
      Creates an instance of IndexedSharePointKnowledgeSourceParameters class.
      Parameters:
      connectionString - the connectionString value to set.
      containerName - the containerName value to set.

  • Method Details

    • getConnectionString

      public String getConnectionString()
      Get the connectionString property: SharePoint connection string with format: SharePointOnlineEndpoint=[SharePoint site url];ApplicationId=[Azure AD App ID];ApplicationSecret=[Azure AD App client secret];TenantId=[SharePoint site tenant id].
      Returns:
      the connectionString value.

    • getContainerName

      public IndexedSharePointContainerName getContainerName()
      Get the containerName property: Specifies which SharePoint libraries to access.
      Returns:
      the containerName value.

    • getQuery

      public String getQuery()
      Get the query property: Optional query to filter SharePoint content.
      Returns:
      the query value.

    • setQuery

      public IndexedSharePointKnowledgeSourceParameters setQuery(String query)
      Set the query property: Optional query to filter SharePoint content.
      Parameters:
      query - the query value to set.
      Returns:
      the IndexedSharePointKnowledgeSourceParameters object itself.

    • getIngestionParameters

      public KnowledgeSourceIngestionParameters getIngestionParameters()
      Get the ingestionParameters property: Consolidates all general ingestion settings.
      Returns:
      the ingestionParameters value.

    • setIngestionParameters

      public IndexedSharePointKnowledgeSourceParameters setIngestionParameters(KnowledgeSourceIngestionParameters ingestionParameters)
      Set the ingestionParameters property: Consolidates all general ingestion settings.
      Parameters:
      ingestionParameters - the ingestionParameters value to set.
      Returns:
      the IndexedSharePointKnowledgeSourceParameters object itself.

    • getCreatedResources

      public Map<String,String> getCreatedResources()
      Get the createdResources property: Resources created by the knowledge source.
      Returns:
      the createdResources value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<IndexedSharePointKnowledgeSourceParameters>
      Throws:
      IOException

    • fromJson

      public static IndexedSharePointKnowledgeSourceParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of IndexedSharePointKnowledgeSourceParameters from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of IndexedSharePointKnowledgeSourceParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the IndexedSharePointKnowledgeSourceParameters.