Package software.amazon.awssdk.services.kendra.model

Interface OneDriveConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OneDriveConfiguration.Builder,OneDriveConfiguration>, SdkBuilder<OneDriveConfiguration.Builder,OneDriveConfiguration>, SdkPojo
Enclosing class:
OneDriveConfiguration
public static interface OneDriveConfiguration.Builder extends SdkPojo, CopyableBuilder<OneDriveConfiguration.Builder,OneDriveConfiguration>

  • Method Details

    • tenantDomain

      OneDriveConfiguration.Builder tenantDomain(String tenantDomain)

      The Azure Active Directory domain of the organization.

      Parameters:
      tenantDomain - The Azure Active Directory domain of the organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretArn

      OneDriveConfiguration.Builder secretArn(String secretArn)

      The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

      Parameters:
      secretArn - The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oneDriveUsers

      OneDriveConfiguration.Builder oneDriveUsers(OneDriveUsers oneDriveUsers)

      A list of user accounts whose documents should be indexed.

      Parameters:
      oneDriveUsers - A list of user accounts whose documents should be indexed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • oneDriveUsers

      default OneDriveConfiguration.Builder oneDriveUsers(Consumer<OneDriveUsers.Builder> oneDriveUsers)

      A list of user accounts whose documents should be indexed.

      This is a convenience method that creates an instance of the OneDriveUsers.Builder avoiding the need to create one manually via OneDriveUsers.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to oneDriveUsers(OneDriveUsers).

      Parameters:
      oneDriveUsers - a consumer that will call methods on OneDriveUsers.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inclusionPatterns

      OneDriveConfiguration.Builder inclusionPatterns(Collection<String> inclusionPatterns)

      A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

      The pattern is applied to the file name.

      Parameters:
      inclusionPatterns - A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

      The pattern is applied to the file name.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inclusionPatterns

      OneDriveConfiguration.Builder inclusionPatterns(String... inclusionPatterns)

      A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

      The pattern is applied to the file name.

      Parameters:
      inclusionPatterns - A list of regular expression patterns to include certain documents in your OneDrive. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

      The pattern is applied to the file name.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionPatterns

      OneDriveConfiguration.Builder exclusionPatterns(Collection<String> exclusionPatterns)

      A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

      The pattern is applied to the file name.

      Parameters:
      exclusionPatterns - A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

      The pattern is applied to the file name.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclusionPatterns

      OneDriveConfiguration.Builder exclusionPatterns(String... exclusionPatterns)

      A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

      The pattern is applied to the file name.

      Parameters:
      exclusionPatterns - A list of regular expression patterns to exclude certain documents in your OneDrive. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

      The pattern is applied to the file name.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      OneDriveConfiguration.Builder fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)

      A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.

      Parameters:
      fieldMappings - A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      OneDriveConfiguration.Builder fieldMappings(DataSourceToIndexFieldMapping... fieldMappings)

      A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.

      Parameters:
      fieldMappings - A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMappings

      OneDriveConfiguration.Builder fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings)

      A list of DataSourceToIndexFieldMapping objects that map OneDrive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to OneDrive fields. For more information, see Mapping data source fields. The OneDrive data source field names must exist in your OneDrive custom metadata.

      This is a convenience method that creates an instance of the DataSourceToIndexFieldMapping.Builder avoiding the need to create one manually via DataSourceToIndexFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fieldMappings(List<DataSourceToIndexFieldMapping>).

      Parameters:
      fieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • disableLocalGroups

      OneDriveConfiguration.Builder disableLocalGroups(Boolean disableLocalGroups)

      TRUE to disable local groups information.

      Parameters:
      disableLocalGroups - TRUE to disable local groups information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.