Package software.amazon.awssdk.services.servicecatalog.model

Class SearchProductsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.servicecatalog.model.ServiceCatalogRequest

software.amazon.awssdk.services.servicecatalog.model.SearchProductsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchProductsRequest.Builder,SearchProductsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchProductsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	acceptLanguage()	The language code.
static SearchProductsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<ProductViewFilterBy,List<String>>	filters()	The search filters.
Map<String,List<String>>	filtersAsStrings()	The search filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Integer	pageSize()	The maximum number of items to return with this call.
String	pageToken()	The page token for the next set of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SearchProductsRequest.Builder>	serializableBuilderClass()
ProductViewSortBy	sortBy()	The sort field.
String	sortByAsString()	The sort field.
SortOrder	sortOrder()	The sort order.
String	sortOrderAsString()	The sort order.
SearchProductsRequest.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

acceptLanguage

public final String acceptLanguage()

The language code.

• jp - Japanese

• zh - Chinese

Returns:

The language code.

• jp - Japanese

• zh - Chinese

filters

public final Map<ProductViewFilterBy,List<String>> filters()

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

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 hasFilters() method.

Returns:

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filtersAsStrings

public final Map<String,List<String>> filtersAsStrings()

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

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 hasFilters() method.

Returns:

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

pageSize

public final Integer pageSize()

The maximum number of items to return with this call.

Returns:

The maximum number of items to return with this call.

sortBy

public final ProductViewSortBy sortBy()

The sort field. If no value is specified, the results are not sorted.

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

Returns:

The sort field. If no value is specified, the results are not sorted.

See Also:

ProductViewSortBy

sortByAsString

public final String sortByAsString()

The sort field. If no value is specified, the results are not sorted.

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

Returns:

The sort field. If no value is specified, the results are not sorted.

See Also:

ProductViewSortBy

sortOrder

public final SortOrder sortOrder()

The sort order. If no value is specified, the results are not sorted.

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

Returns:

The sort order. If no value is specified, the results are not sorted.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

The sort order. If no value is specified, the results are not sorted.

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

Returns:

The sort order. If no value is specified, the results are not sorted.

See Also:

SortOrder

pageToken

public final String pageToken()

The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

The page token for the next set of results. To retrieve the first set of results, use null.

toBuilder

public SearchProductsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchProductsRequest.Builder,SearchProductsRequest>

Specified by:

toBuilder in class ServiceCatalogRequest

builder

public static SearchProductsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo