Class SearchRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SearchRequest.Builder,
SearchRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies additional attributes for theSearch
action.Specifies additional attributes for theSearch
action.static SearchRequest.Builder
builder()
final String
The identifier of the Amazon DataZone domain.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FilterClause
filters()
Specifies the search filters.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AdditionalAttributes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SearchIn property.final Integer
The maximum number of results to return in a single call toSearch
.final String
When the number of results is greater than the default value for theMaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of results, the response includes a pagination token namedNextToken
.final String
The identifier of the owning project specified for the search.final List
<SearchInItem> searchIn()
The details of the search.final InventorySearchScope
The scope of the search.final String
The scope of the search.final String
Specifies the text for which to search.static Class
<? extends SearchRequest.Builder> final SearchSort
sort()
Specifies the way in which the search results are to be sorted.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
additionalAttributes
Specifies additional attributes for the
Search
action.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.- Returns:
- Specifies additional attributes for the
Search
action.
-
hasAdditionalAttributes
public final boolean hasAdditionalAttributes()For responses, this returns true if the service returned a value for the AdditionalAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
additionalAttributesAsStrings
Specifies additional attributes for the
Search
action.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.- Returns:
- Specifies additional attributes for the
Search
action.
-
domainIdentifier
The identifier of the Amazon DataZone domain.
- Returns:
- The identifier of the Amazon DataZone domain.
-
filters
Specifies the search filters.
- Returns:
- Specifies the search filters.
-
maxResults
The maximum number of results to return in a single call to
Search
. When the number of results to be listed is greater than the value ofMaxResults
, the response contains aNextToken
value that you can use in a subsequent call toSearch
to list the next set of results.- Returns:
- The maximum number of results to return in a single call to
Search
. When the number of results to be listed is greater than the value ofMaxResults
, the response contains aNextToken
value that you can use in a subsequent call toSearch
to list the next set of results.
-
nextToken
When the number of results is greater than the default value for the
MaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of results, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toSearch
to list the next set of results.- Returns:
- When the number of results is greater than the default value for the
MaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of results, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call toSearch
to list the next set of results.
-
owningProjectIdentifier
The identifier of the owning project specified for the search.
- Returns:
- The identifier of the owning project specified for the search.
-
hasSearchIn
public final boolean hasSearchIn()For responses, this returns true if the service returned a value for the SearchIn property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
searchIn
The details of 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
hasSearchIn()
method.- Returns:
- The details of the search.
-
searchScope
The scope of the search.
If the service returns an enum value that is not available in the current SDK version,
searchScope
will returnInventorySearchScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsearchScopeAsString()
.- Returns:
- The scope of the search.
- See Also:
-
searchScopeAsString
The scope of the search.
If the service returns an enum value that is not available in the current SDK version,
searchScope
will returnInventorySearchScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsearchScopeAsString()
.- Returns:
- The scope of the search.
- See Also:
-
searchText
Specifies the text for which to search.
- Returns:
- Specifies the text for which to search.
-
sort
Specifies the way in which the search results are to be sorted.
- Returns:
- Specifies the way in which the search results are to be sorted.
-
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 interfaceToCopyableBuilder<SearchRequest.Builder,
SearchRequest> - Specified by:
toBuilder
in classDataZoneRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-