Package com.dropbox.core.v2.files

Class SearchOptions.Builder

java.lang.Object
com.dropbox.core.v2.files.SearchOptions.Builder
Enclosing class:
SearchOptions
public static class SearchOptions.Builder extends Object
Builder for SearchOptions.

  • Field Details

    • path

      protected String path

    • maxResults

      protected long maxResults

    • orderBy

      protected SearchOrderBy orderBy

    • fileStatus

      protected FileStatus fileStatus

    • filenameOnly

      protected boolean filenameOnly

    • fileExtensions

      protected List<String> fileExtensions

    • fileCategories

      protected List<FileCategory> fileCategories

    • accountId

      protected String accountId

  • Constructor Details

    • Builder

      protected Builder()

  • Method Details

    • withPath

      public SearchOptions.Builder withPath(String path)
      Set value for optional field.
      Parameters:
      path - Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified. Must match pattern "(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/(.|[\\r\\n])*)?)".
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withMaxResults

      public SearchOptions.Builder withMaxResults(Long maxResults)
      Set value for optional field.

      If left unset or set to null, defaults to 100L.

      Parameters:
      maxResults - The maximum number of search results to return. Must be greater than or equal to 1 and be less than or equal to 1000. Defaults to 100L when set to null.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withOrderBy

      public SearchOptions.Builder withOrderBy(SearchOrderBy orderBy)
      Set value for optional field.
      Parameters:
      orderBy - Specified property of the order of search results. By default, results are sorted by relevance.
      Returns:
      this builder

    • withFileStatus

      public SearchOptions.Builder withFileStatus(FileStatus fileStatus)
      Set value for optional field.

      If left unset or set to null, defaults to FileStatus.ACTIVE.

      Parameters:
      fileStatus - Restricts search to the given file status. Must not be null. Defaults to FileStatus.ACTIVE when set to null.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withFilenameOnly

      public SearchOptions.Builder withFilenameOnly(Boolean filenameOnly)
      Set value for optional field.

      If left unset or set to null, defaults to false.

      Parameters:
      filenameOnly - Restricts search to only match on filenames. Defaults to false when set to null.
      Returns:
      this builder

    • withFileExtensions

      public SearchOptions.Builder withFileExtensions(List<String> fileExtensions)
      Set value for optional field.
      Parameters:
      fileExtensions - Restricts search to only the extensions specified. Only supported for active file search. Must not contain a null item.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withFileCategories

      public SearchOptions.Builder withFileCategories(List<FileCategory> fileCategories)
      Set value for optional field.
      Parameters:
      fileCategories - Restricts search to only the file categories specified. Only supported for active file search. Must not contain a null item.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withAccountId

      public SearchOptions.Builder withAccountId(String accountId)
      Set value for optional field.
      Parameters:
      accountId - Restricts results to the given account id. Must have length of at least 40 and have length of at most 40.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • build

      public SearchOptions build()
      Builds an instance of SearchOptions configured with this builder's values
      Returns:
      new instance of SearchOptions