Package software.amazon.awssdk.services.sesv2.model

Class ListRecommendationsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sesv2.model.SesV2Request

software.amazon.awssdk.services.sesv2.model.ListRecommendationsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRecommendationsRequest.Builder,ListRecommendationsRequest>

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

Represents a request to list the existing recommendations for your account.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListRecommendationsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListRecommendationsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<ListRecommendationsFilterKey,String>	filter()	Filters applied when retrieving recommendations.
Map<String,String>	filterAsStrings()	Filters applied when retrieving recommendations.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilter()	For responses, this returns true if the service returned a value for the Filter property.
int	hashCode()
String	nextToken()	A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.
Integer	pageSize()	The number of results to show in a single call to ListRecommendations.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListRecommendationsRequest.Builder>	serializableBuilderClass()
ListRecommendationsRequest.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

filter

public final Map<ListRecommendationsFilterKey,String> filter()

Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

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

Returns:

Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

hasFilter

public final boolean hasFilter()

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

filterAsStrings

public final Map<String,String> filterAsStrings()

Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

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

Returns:

Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

nextToken

public final String nextToken()

A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.

Returns:

A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.

pageSize

public final Integer pageSize()

The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 1, and can be no more than 100.

Returns:

The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 1, and can be no more than 100.

toBuilder

public ListRecommendationsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRecommendationsRequest.Builder,ListRecommendationsRequest>

Specified by:

toBuilder in class SesV2Request

builder

public static ListRecommendationsRequest.Builder builder()

serializableBuilderClass

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