workdocs/aws.sdk.kotlin.services.workdocs.model/SearchResourcesRequest

SearchResourcesRequest

class SearchResourcesRequest

Types

object Companion

Properties

additionalResponseFields

val additionalResponseFields: List<AdditionalResponseFieldType>?

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

authenticationToken

val authenticationToken: String?

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

val filters: Filters?

Filters results based on entity metadata.

val limit: Int?

Max results count per page.

val marker: String?

The marker for the next set of results.

val orderBy: List<SearchSortResult>?

Order by results in one or more categories.

val organizationId: String?

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

val queryScopes: List<SearchQueryScopeType>?

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

val queryText: String?

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.

Functions

inline fun copy(block: SearchResourcesRequest.Builder.() -> Unit = {}): SearchResourcesRequest

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String