Package software.amazon.awssdk.services.datazone.model

Class SearchTypesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datazone.model.DataZoneRequest

software.amazon.awssdk.services.datazone.model.SearchTypesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchTypesRequest.Builder,SearchTypesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SearchTypesRequest
extends DataZoneRequest
implements ToCopyableBuilder<SearchTypesRequest.Builder,SearchTypesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchTypesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchTypesRequest.Builder	builder()
String	domainIdentifier()	The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FilterClause	filters()	The filters for the SearchTypes action.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSearchIn()	For responses, this returns true if the service returned a value for the SearchIn property.
Boolean	managed()	Specifies whether the search is managed.
Integer	maxResults()	The maximum number of results to return in a single call to SearchTypes.
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()	The details of the search.
TypesSearchScope	searchScope()	Specifies the scope of the search for types.
String	searchScopeAsString()	Specifies the scope of the search for types.
String	searchText()	Specifies the text for which to search.
static Class<? extends SearchTypesRequest.Builder>	serializableBuilderClass()
SearchSort	sort()	The specifies the way to sort the SearchTypes results.
SearchTypesRequest.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

domainIdentifier

public final String domainIdentifier()

The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.

Returns:

The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.

filters

public final FilterClause filters()

The filters for the SearchTypes action.

Returns:

The filters for the SearchTypes action.

managed

public final Boolean managed()

Specifies whether the search is managed.

Returns:

Specifies whether the search is managed.

maxResults

public final Integer maxResults()

The maximum number of results to return in a single call to SearchTypes. 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 SearchTypes to list the next set of results.

Returns:

The maximum number of results to return in a single call to SearchTypes. 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 SearchTypes to list the next set of results.

nextToken

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 SearchTypes 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 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 SearchTypes to list the next set of results.

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

searchIn

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

public final TypesSearchScope searchScope()

Specifies the scope of the search for types.

If the service returns an enum value that is not available in the current SDK version, searchScope will return TypesSearchScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from searchScopeAsString().

Returns:

Specifies the scope of the search for types.

See Also:

TypesSearchScope

searchScopeAsString

public final String searchScopeAsString()

Specifies the scope of the search for types.

If the service returns an enum value that is not available in the current SDK version, searchScope will return TypesSearchScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from searchScopeAsString().

Returns:

Specifies the scope of the search for types.

See Also:

TypesSearchScope

searchText

public final String searchText()

Specifies the text for which to search.

Returns:

Specifies the text for which to search.

sort

public final SearchSort sort()

The specifies the way to sort the SearchTypes results.

Returns:

The specifies the way to sort the SearchTypes results.

toBuilder

public SearchTypesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchTypesRequest.Builder,SearchTypesRequest>

Specified by:

toBuilder in class DataZoneRequest

builder

public static SearchTypesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchTypesRequest.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