@Generated(value="software.amazon.awssdk:codegen") public final class SearchListingsRequest extends DataZoneRequest implements ToCopyableBuilder<SearchListingsRequest.Builder,SearchListingsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
SearchListingsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<SearchOutputAdditionalAttribute> |
additionalAttributes()
Specifies additional attributes for the search.
|
List<String> |
additionalAttributesAsStrings()
Specifies additional attributes for the search.
|
static SearchListingsRequest.Builder |
builder() |
String |
domainIdentifier()
The identifier of the domain in which to search listings.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
FilterClause |
filters()
Specifies the filters for the search of listings.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAdditionalAttributes()
For responses, this returns true if the service returned a value for the AdditionalAttributes property.
|
int |
hashCode() |
boolean |
hasSearchIn()
For responses, this returns true if the service returned a value for the SearchIn property.
|
Integer |
maxResults()
The maximum number of results to return in a single call to
SearchListings. |
String |
nextToken()
When the number of results is greater than the default value for the
MaxResults parameter, or if you
explicitly specify a value for MaxResults that is less than the number of results, the response
includes a pagination token named NextToken. |
List<SdkField<?>> |
sdkFields() |
List<SearchInItem> |
searchIn()
|
String |
searchText()
Specifies the text for which to search.
|
static Class<? extends SearchListingsRequest.Builder> |
serializableBuilderClass() |
SearchSort |
sort()
Specifies the way for sorting the search results.
|
SearchListingsRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final List<SearchOutputAdditionalAttribute> additionalAttributes()
Specifies additional attributes for the search.
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 hasAdditionalAttributes() method.
public final boolean hasAdditionalAttributes()
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.public final List<String> additionalAttributesAsStrings()
Specifies additional attributes for the search.
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 hasAdditionalAttributes() method.
public final String domainIdentifier()
The identifier of the domain in which to search listings.
public final FilterClause filters()
Specifies the filters for the search of listings.
public final Integer maxResults()
The maximum number of results to return in a single call to SearchListings. When the number of
results to be listed is greater than the value of MaxResults, the response contains a
NextToken value that you can use in a subsequent call to SearchListings to list the
next set of results.
SearchListings. When the number
of results to be listed is greater than the value of MaxResults, the response contains a
NextToken value that you can use in a subsequent call to SearchListings to list
the next set of results.public final String nextToken()
When the number of results is greater than the default value for the MaxResults parameter, or if you
explicitly specify a value for MaxResults that is less than the number of results, the response
includes a pagination token named NextToken. You can specify this NextToken value in a
subsequent call to SearchListings to list the next set of results.
MaxResults parameter,
or if you explicitly specify a value for MaxResults that is less than the number of results,
the response includes a pagination token named NextToken. You can specify this
NextToken value in a subsequent call to SearchListings to list the next set of
results.public final boolean hasSearchIn()
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.public final List<SearchInItem> searchIn()
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 hasSearchIn() method.
public final String searchText()
Specifies the text for which to search.
public final SearchSort sort()
Specifies the way for sorting the search results.
public SearchListingsRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<SearchListingsRequest.Builder,SearchListingsRequest>toBuilder in class DataZoneRequestpublic static SearchListingsRequest.Builder builder()
public static Class<? extends SearchListingsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.