SearchResourcesRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class SearchResourcesRequest
extends WorkDocsRequest
implements ToCopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SearchResourcesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SearchResourcesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdditionalResponseFieldType>`	`additionalResponseFields()` A list of attributes to include in the response.
`List<String>`	`additionalResponseFieldsAsStrings()` A list of attributes to include in the response.
`String`	`authenticationToken()` Amazon WorkDocs authentication token.
`static SearchResourcesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Filters`	`filters()` Filters results based on entity metadata.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalResponseFields()` For responses, this returns true if the service returned a value for the AdditionalResponseFields property.
`int`	`hashCode()`
`boolean`	`hasOrderBy()` For responses, this returns true if the service returned a value for the OrderBy property.
`boolean`	`hasQueryScopes()` For responses, this returns true if the service returned a value for the QueryScopes property.
`Integer`	`limit()` Max results count per page.
`String`	`marker()` The marker for the next set of results.
`List<SearchSortResult>`	`orderBy()` Order by results in one or more categories.
`String`	`organizationId()` Filters based on the resource owner OrgId.
`List<SearchQueryScopeType>`	`queryScopes()` Filter based on the text field type.
`List<String>`	`queryScopesAsStrings()` Filter based on the text field type.
`String`	`queryText()` The String to search for.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SearchResourcesRequest.Builder>`	`serializableBuilderClass()`
`SearchResourcesRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- 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.
  - toBuilder
```
public SearchResourcesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>
    
    Specified by:
    
    toBuilder in class WorkDocsRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SearchResourcesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

authenticationToken

queryText

queryScopes

hasQueryScopes

queryScopesAsStrings

organizationId

additionalResponseFields

hasAdditionalResponseFields

additionalResponseFieldsAsStrings

filters

hasOrderBy

orderBy

limit

marker

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields