software.amazon.awssdk.services.customerprofiles.model

Class SearchProfilesRequest

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.SearchProfilesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchProfilesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchProfilesRequest.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()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	keyName() A searchable identifier of a customer profile.
Integer	maxResults() The maximum number of objects returned per page.
String	nextToken() The pagination token from the previous SearchProfiles API call.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchProfilesRequest.Builder>	serializableBuilderClass()
SearchProfilesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() A list of key values.

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 SearchProfiles API call.

Returns:

The pagination token from the previous SearchProfiles 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.

keyName

public final String keyName()

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

Returns:

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

hasValues

public final boolean hasValues()

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

values

public final List<String> values()

A list of key values.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasValues() to see if a value was sent in this field.

Returns:

A list of key values.

toBuilder

public SearchProfilesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchProfilesRequest.Builder,SearchProfilesRequest>

Specified by:

toBuilder in class CustomerProfilesRequest

builder

public static SearchProfilesRequest.Builder builder()

serializableBuilderClass

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