software.amazon.awssdk.services.customerprofiles.model

Class GetMatchesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

software.amazon.awssdk.services.customerprofiles.model.GetMatchesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMatchesResponse.Builder,GetMatchesResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetMatchesResponse
extends CustomerProfilesResponse
implements ToCopyableBuilder<GetMatchesResponse.Builder,GetMatchesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetMatchesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetMatchesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMatches() For responses, this returns true if the service returned a value for the Matches property.
List<MatchItem>	matches() The list of matched profiles for this instance.
Instant	matchGenerationDate() The timestamp this version of Match Result generated.
String	nextToken() If there are additional results, this is the token for the next set of results.
Integer	potentialMatches() The number of potential matches found.
List<SdkField<?>>	sdkFields()
static Class<? extends GetMatchesResponse.Builder>	serializableBuilderClass()
GetMatchesResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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()

If there are additional results, this is the token for the next set of results.

Returns:

If there are additional results, this is the token for the next set of results.

matchGenerationDate

public final Instant matchGenerationDate()

The timestamp this version of Match Result generated.

Returns:

The timestamp this version of Match Result generated.

potentialMatches

public final Integer potentialMatches()

The number of potential matches found.

Returns:

The number of potential matches found.

hasMatches

public final boolean hasMatches()

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

matches

public final List<MatchItem> matches()

The list of matched profiles for this instance.

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

Returns:

The list of matched profiles for this instance.

toBuilder

public GetMatchesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetMatchesResponse.Builder,GetMatchesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetMatchesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetMatchesResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo