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

Class SearchResourcesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.workdocs.model.WorkDocsRequest
software.amazon.awssdk.services.workdocs.model.SearchResourcesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchResourcesRequest extends WorkDocsRequest implements ToCopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>

  • Method Details

    • 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.

    • toBuilder

      public SearchResourcesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>
      Specified by:
      toBuilder in class WorkDocsRequest
      Returns:
      a builder for type T

    • builder

      public static SearchResourcesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SearchResourcesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.