public static interface SearchResourcesRequest.Builder extends WorkDocsRequest.Builder, SdkPojo, CopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildSearchResourcesRequest.Builder authenticationToken(String authenticationToken)
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
authenticationToken - Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator
credentials to access the API.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.
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.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
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 contentSearchResourcesRequest.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
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 contentSearchResourcesRequest.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
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 contentSearchResourcesRequest.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
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 contentSearchResourcesRequest.Builder organizationId(String organizationId)
Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
organizationId - Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4
credentials.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.
additionalResponseFields - A list of attributes to include in the response. Used to request fields that are not normally returned
in a standard response.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.
additionalResponseFields - A list of attributes to include in the response. Used to request fields that are not normally returned
in a standard response.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.
additionalResponseFields - A list of attributes to include in the response. Used to request fields that are not normally returned
in a standard response.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.
additionalResponseFields - A list of attributes to include in the response. Used to request fields that are not normally returned
in a standard response.SearchResourcesRequest.Builder filters(Filters filters)
Filters results based on entity metadata.
filters - Filters results based on entity metadata.default SearchResourcesRequest.Builder filters(Consumer<Filters.Builder> filters)
Filters results based on entity metadata.
This is a convenience method that creates an instance of theFilters.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).
filters - a consumer that will call methods on Filters.Builderfilters(Filters)SearchResourcesRequest.Builder orderBy(Collection<SearchSortResult> orderBy)
Order by results in one or more categories.
orderBy - Order by results in one or more categories.SearchResourcesRequest.Builder orderBy(SearchSortResult... orderBy)
Order by results in one or more categories.
orderBy - Order by results in one or more categories.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 theSearchSortResult.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.
orderBy - a consumer that will call methods on
SearchSortResult.Builder#orderBy(java.util.Collection) SearchResourcesRequest.Builder limit(Integer limit)
Max results count per page.
limit - Max results count per page.SearchResourcesRequest.Builder marker(String marker)
The marker for the next set of results.
marker - The marker for the next set of results.SearchResourcesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderSearchResourcesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.