com.amazonaws.services.customerprofiles.model

Class SearchProfilesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.customerprofiles.model.SearchProfilesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchProfilesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SearchProfilesRequest()

Method Summary

Modifier and Type	Method and Description
SearchProfilesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<AdditionalSearchKey>	getAdditionalSearchKeys() A list of AdditionalSearchKey objects that are each searchable identifiers of a profile.
String	getDomainName() The unique name of the domain.
String	getKeyName() A searchable identifier of a customer profile.
String	getLogicalOperator() Relationship between all specified search keys that will be used to search for profiles.
Integer	getMaxResults() The maximum number of objects returned per page.
String	getNextToken() The pagination token from the previous SearchProfiles API call.
List<String>	getValues() A list of key values.
int	hashCode()
void	setAdditionalSearchKeys(Collection<AdditionalSearchKey> additionalSearchKeys) A list of AdditionalSearchKey objects that are each searchable identifiers of a profile.
void	setDomainName(String domainName) The unique name of the domain.
void	setKeyName(String keyName) A searchable identifier of a customer profile.
void	setLogicalOperator(String logicalOperator) Relationship between all specified search keys that will be used to search for profiles.
void	setMaxResults(Integer maxResults) The maximum number of objects returned per page.
void	setNextToken(String nextToken) The pagination token from the previous SearchProfiles API call.
void	setValues(Collection<String> values) A list of key values.
String	toString() Returns a string representation of this object.
SearchProfilesRequest	withAdditionalSearchKeys(AdditionalSearchKey... additionalSearchKeys) A list of AdditionalSearchKey objects that are each searchable identifiers of a profile.
SearchProfilesRequest	withAdditionalSearchKeys(Collection<AdditionalSearchKey> additionalSearchKeys) A list of AdditionalSearchKey objects that are each searchable identifiers of a profile.
SearchProfilesRequest	withDomainName(String domainName) The unique name of the domain.
SearchProfilesRequest	withKeyName(String keyName) A searchable identifier of a customer profile.
SearchProfilesRequest	withLogicalOperator(LogicalOperator logicalOperator) Relationship between all specified search keys that will be used to search for profiles.
SearchProfilesRequest	withLogicalOperator(String logicalOperator) Relationship between all specified search keys that will be used to search for profiles.
SearchProfilesRequest	withMaxResults(Integer maxResults) The maximum number of objects returned per page.
SearchProfilesRequest	withNextToken(String nextToken) The pagination token from the previous SearchProfiles API call.
SearchProfilesRequest	withValues(Collection<String> values) A list of key values.
SearchProfilesRequest	withValues(String... values) A list of key values.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchProfilesRequest

public SearchProfilesRequest()

Method Detail

setNextToken

public void setNextToken(String nextToken)

The pagination token from the previous SearchProfiles API call.

Parameters:

nextToken - The pagination token from the previous SearchProfiles API call.

getNextToken

public String getNextToken()

The pagination token from the previous SearchProfiles API call.

Returns:

The pagination token from the previous SearchProfiles API call.

withNextToken

public SearchProfilesRequest withNextToken(String nextToken)

The pagination token from the previous SearchProfiles API call.

Parameters:

nextToken - The pagination token from the previous SearchProfiles API call.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

Parameters:

maxResults - The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

getMaxResults

public Integer getMaxResults()

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

Returns:

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

withMaxResults

public SearchProfilesRequest withMaxResults(Integer maxResults)

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

Parameters:

maxResults - The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDomainName

public void setDomainName(String domainName)

The unique name of the domain.

Parameters:

domainName - The unique name of the domain.

getDomainName

public String getDomainName()

The unique name of the domain.

Returns:

The unique name of the domain.

withDomainName

public SearchProfilesRequest withDomainName(String domainName)

The unique name of the domain.

Parameters:

domainName - The unique name of the domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKeyName

public void setKeyName(String keyName)

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

Parameters:

keyName - A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

getKeyName

public String getKeyName()

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

Returns:

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

withKeyName

public SearchProfilesRequest withKeyName(String keyName)

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

Parameters:

keyName - A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

Returns:

Returns a reference to this object so that method calls can be chained together.

getValues

public List<String> getValues()

A list of key values.

Returns:

A list of key values.

setValues

public void setValues(Collection<String> values)

A list of key values.

Parameters:

values - A list of key values.

withValues

public SearchProfilesRequest withValues(String... values)

A list of key values.

NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.

Parameters:

values - A list of key values.

Returns:

Returns a reference to this object so that method calls can be chained together.

withValues

public SearchProfilesRequest withValues(Collection<String> values)

A list of key values.

Parameters:

values - A list of key values.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAdditionalSearchKeys

public List<AdditionalSearchKey> getAdditionalSearchKeys()

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

Returns:

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

setAdditionalSearchKeys

public void setAdditionalSearchKeys(Collection<AdditionalSearchKey> additionalSearchKeys)

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

Parameters:

additionalSearchKeys - A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

withAdditionalSearchKeys

public SearchProfilesRequest withAdditionalSearchKeys(AdditionalSearchKey... additionalSearchKeys)

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

NOTE: This method appends the values to the existing list (if any). Use setAdditionalSearchKeys(java.util.Collection) or withAdditionalSearchKeys(java.util.Collection) if you want to override the existing values.

Parameters:

additionalSearchKeys - A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAdditionalSearchKeys

public SearchProfilesRequest withAdditionalSearchKeys(Collection<AdditionalSearchKey> additionalSearchKeys)

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

Parameters:

additionalSearchKeys - A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLogicalOperator

public void setLogicalOperator(String logicalOperator)

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

Parameters:

logicalOperator - Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

See Also:

LogicalOperator

getLogicalOperator

public String getLogicalOperator()

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

Returns:

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

See Also:

LogicalOperator

withLogicalOperator

public SearchProfilesRequest withLogicalOperator(String logicalOperator)

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

Parameters:

logicalOperator - Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LogicalOperator

withLogicalOperator

public SearchProfilesRequest withLogicalOperator(LogicalOperator logicalOperator)

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

Parameters:

logicalOperator - Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LogicalOperator

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SearchProfilesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()