Class RemoteSharePointKnowledgeSourceParameters

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

  • Constructor Details

    • RemoteSharePointKnowledgeSourceParameters

      public RemoteSharePointKnowledgeSourceParameters()
      Creates an instance of RemoteSharePointKnowledgeSourceParameters class.

  • Method Details

    • getFilterExpression

      public String getFilterExpression()
      Get the filterExpression property: Keyword Query Language (KQL) expression with queryable SharePoint properties and attributes to scope the retrieval before the query runs. See documentation: https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference.
      Returns:
      the filterExpression value.

    • setFilterExpression

      public RemoteSharePointKnowledgeSourceParameters setFilterExpression(String filterExpression)
      Set the filterExpression property: Keyword Query Language (KQL) expression with queryable SharePoint properties and attributes to scope the retrieval before the query runs. See documentation: https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference.
      Parameters:
      filterExpression - the filterExpression value to set.
      Returns:
      the RemoteSharePointKnowledgeSourceParameters object itself.

    • getResourceMetadata

      public List<String> getResourceMetadata()
      Get the resourceMetadata property: A list of metadata fields to be returned for each item in the response. Only retrievable metadata properties can be included in this list. By default, no metadata is returned. Optional.
      Returns:
      the resourceMetadata value.

    • setResourceMetadata

      public RemoteSharePointKnowledgeSourceParameters setResourceMetadata(List<String> resourceMetadata)
      Set the resourceMetadata property: A list of metadata fields to be returned for each item in the response. Only retrievable metadata properties can be included in this list. By default, no metadata is returned. Optional.
      Parameters:
      resourceMetadata - the resourceMetadata value to set.
      Returns:
      the RemoteSharePointKnowledgeSourceParameters object itself.

    • getContainerTypeId

      public String getContainerTypeId()
      Get the containerTypeId property: Container ID for SharePoint Embedded connection. When this is null, it will use SharePoint Online.
      Returns:
      the containerTypeId value.

    • setContainerTypeId

      public RemoteSharePointKnowledgeSourceParameters setContainerTypeId(String containerTypeId)
      Set the containerTypeId property: Container ID for SharePoint Embedded connection. When this is null, it will use SharePoint Online.
      Parameters:
      containerTypeId - the containerTypeId value to set.
      Returns:
      the RemoteSharePointKnowledgeSourceParameters object itself.

    • toJson

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

    • fromJson

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