Package software.amazon.awssdk.services.customerprofiles.model

Class GetSimilarProfilesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesRequest

software.amazon.awssdk.services.customerprofiles.model.GetSimilarProfilesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSimilarProfilesRequest.Builder,GetSimilarProfilesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSimilarProfilesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetSimilarProfilesRequest.Builder	builder()
String	domainName()	The unique name of the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MatchType	matchType()	Specify the type of matching to get similar profiles for.
String	matchTypeAsString()	Specify the type of matching to get similar profiles for.
Integer	maxResults()	The maximum number of objects returned per page.
String	nextToken()	The pagination token from the previous GetSimilarProfiles API call.
List<SdkField<?>>	sdkFields()
String	searchKey()	The string indicating the search key to be used.
String	searchValue()	The string based on SearchKey to be searched for similar profiles.
static Class<? extends GetSimilarProfilesRequest.Builder>	serializableBuilderClass()
GetSimilarProfilesRequest.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

nextToken

public final String nextToken()

The pagination token from the previous GetSimilarProfiles API call.

Returns:

The pagination token from the previous GetSimilarProfiles API call.

maxResults

public final Integer maxResults()

The maximum number of objects returned per page.

Returns:

The maximum number of objects returned per page.

domainName

public final String domainName()

The unique name of the domain.

Returns:

The unique name of the domain.

matchType

public final MatchType matchType()

Specify the type of matching to get similar profiles for.

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

Returns:

Specify the type of matching to get similar profiles for.

See Also:

MatchType

matchTypeAsString

public final String matchTypeAsString()

Specify the type of matching to get similar profiles for.

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

Returns:

Specify the type of matching to get similar profiles for.

See Also:

MatchType

searchKey

public final String searchKey()

The string indicating the search key to be used.

Returns:

The string indicating the search key to be used.

searchValue

public final String searchValue()

The string based on SearchKey to be searched for similar profiles.

Returns:

The string based on SearchKey to be searched for similar profiles.

toBuilder

public GetSimilarProfilesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSimilarProfilesRequest.Builder,GetSimilarProfilesRequest>

Specified by:

toBuilder in class CustomerProfilesRequest

builder

public static GetSimilarProfilesRequest.Builder builder()

serializableBuilderClass

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