Package software.amazon.awssdk.services.workdocs.model

Class SearchResourcesRequest

    • Method Detail

      • authenticationToken

        public final String authenticationToken()

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

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

      • queryText

        public final 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.

        Returns:
        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.

      • queryScopes

        public final List<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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueryScopes() method.

        Returns:
        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

      • hasQueryScopes

        public final boolean hasQueryScopes()
        For responses, this returns true if the service returned a value for the QueryScopes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • queryScopesAsStrings

        public final List<String> queryScopesAsStrings()

        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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueryScopes() method.

        Returns:
        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

      • organizationId

        public final String organizationId()

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

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

      • additionalResponseFields

        public final List<AdditionalResponseFieldType> additionalResponseFields()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalResponseFields() method.

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

      • hasAdditionalResponseFields

        public final boolean hasAdditionalResponseFields()
        For responses, this returns true if the service returned a value for the AdditionalResponseFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • additionalResponseFieldsAsStrings

        public final List<String> additionalResponseFieldsAsStrings()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalResponseFields() method.

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

      • filters

        public final Filters filters()

        Filters results based on entity metadata.

        Returns:
        Filters results based on entity metadata.

      • hasOrderBy

        public final boolean hasOrderBy()
        For responses, this returns true if the service returned a value for the OrderBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • orderBy

        public final List<SearchSortResult> orderBy()

        Order by results in one or more categories.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrderBy() method.

        Returns:
        Order by results in one or more categories.

      • limit

        public final Integer limit()

        Max results count per page.

        Returns:
        Max results count per page.

      • marker

        public final String marker()

        The marker for the next set of results.

        Returns:
        The marker for the next set of results.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object