Package software.amazon.awssdk.services.personalize.model

Class ListRecipesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.personalize.model.PersonalizeRequest

software.amazon.awssdk.services.personalize.model.ListRecipesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRecipesRequest.Builder,ListRecipesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListRecipesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListRecipesRequest.Builder	builder()
Domain	domain()	Filters returned recipes by domain for a Domain dataset group.
String	domainAsString()	Filters returned recipes by domain for a Domain dataset group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of recipes to return.
String	nextToken()	A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
RecipeProvider	recipeProvider()	The default is SERVICE.
String	recipeProviderAsString()	The default is SERVICE.
List<SdkField<?>>	sdkFields()
static Class<? extends ListRecipesRequest.Builder>	serializableBuilderClass()
ListRecipesRequest.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

recipeProvider

public final RecipeProvider recipeProvider()

The default is SERVICE.

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

Returns:

The default is SERVICE.

See Also:

RecipeProvider

recipeProviderAsString

public final String recipeProviderAsString()

The default is SERVICE.

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

Returns:

The default is SERVICE.

See Also:

RecipeProvider

nextToken

public final String nextToken()

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

Returns:

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

maxResults

public final Integer maxResults()

The maximum number of recipes to return.

Returns:

The maximum number of recipes to return.

domain

public final Domain domain()

Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

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

Returns:

Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

See Also:

Domain

domainAsString

public final String domainAsString()

Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

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

Returns:

Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

See Also:

Domain

toBuilder

public ListRecipesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRecipesRequest.Builder,ListRecipesRequest>

Specified by:

toBuilder in class PersonalizeRequest

builder

public static ListRecipesRequest.Builder builder()

serializableBuilderClass

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