Interface SearchResourcesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>, SdkBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>, SdkPojo, SdkRequest.Builder, WorkDocsRequest.Builder
Enclosing class:
SearchResourcesRequest
public static interface SearchResourcesRequest.Builder extends WorkDocsRequest.Builder, SdkPojo, CopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>

  • Method Details

    • authenticationToken

      SearchResourcesRequest.Builder authenticationToken(String authenticationToken)

      Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

      Parameters:
      authenticationToken - Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryText

      SearchResourcesRequest.Builder queryText(String queryText)

      The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.

      Parameters:
      queryText - The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryScopesWithStrings

      SearchResourcesRequest.Builder queryScopesWithStrings(Collection<String> queryScopes)

      Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content

      Parameters:
      queryScopes - Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryScopesWithStrings

      SearchResourcesRequest.Builder queryScopesWithStrings(String... queryScopes)

      Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content

      Parameters:
      queryScopes - Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryScopes

      SearchResourcesRequest.Builder queryScopes(Collection<SearchQueryScopeType> queryScopes)

      Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content

      Parameters:
      queryScopes - Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryScopes

      SearchResourcesRequest.Builder queryScopes(SearchQueryScopeType... queryScopes)

      Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content

      Parameters:
      queryScopes - Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationId

      SearchResourcesRequest.Builder organizationId(String organizationId)

      Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.

      Parameters:
      organizationId - Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalResponseFieldsWithStrings

      SearchResourcesRequest.Builder additionalResponseFieldsWithStrings(Collection<String> additionalResponseFields)

      A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

      Parameters:
      additionalResponseFields - A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalResponseFieldsWithStrings

      SearchResourcesRequest.Builder additionalResponseFieldsWithStrings(String... additionalResponseFields)

      A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

      Parameters:
      additionalResponseFields - A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalResponseFields

      SearchResourcesRequest.Builder additionalResponseFields(Collection<AdditionalResponseFieldType> additionalResponseFields)

      A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

      Parameters:
      additionalResponseFields - A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalResponseFields

      SearchResourcesRequest.Builder additionalResponseFields(AdditionalResponseFieldType... additionalResponseFields)

      A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

      Parameters:
      additionalResponseFields - A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      SearchResourcesRequest.Builder filters(Filters filters)

      Filters results based on entity metadata.

      Parameters:
      filters - Filters results based on entity metadata.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      default SearchResourcesRequest.Builder filters(Consumer<Filters.Builder> filters)

      Filters results based on entity metadata.

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

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

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

    • orderBy

      SearchResourcesRequest.Builder orderBy(Collection<SearchSortResult> orderBy)

      Order by results in one or more categories.

      Parameters:
      orderBy - Order by results in one or more categories.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • orderBy

      SearchResourcesRequest.Builder orderBy(SearchSortResult... orderBy)

      Order by results in one or more categories.

      Parameters:
      orderBy - Order by results in one or more categories.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • orderBy

      SearchResourcesRequest.Builder orderBy(Consumer<SearchSortResult.Builder>... orderBy)

      Order by results in one or more categories.

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

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

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

    • limit

      SearchResourcesRequest.Builder limit(Integer limit)

      Max results count per page.

      Parameters:
      limit - Max results count per page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • marker

      SearchResourcesRequest.Builder marker(String marker)

      The marker for the next set of results.

      Parameters:
      marker - The marker for the next set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SearchResourcesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SearchResourcesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.