software.amazon.awssdk.services.customerprofiles.model

Class AddProfileKeyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AddProfileKeyRequest.Builder,AddProfileKeyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AddProfileKeyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static AddProfileKeyRequest.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() For responses, this returns true if the service returned a value for the Values property.
String	keyName() A searchable identifier of a customer profile.
String	profileId() The unique identifier of a customer profile.
List<SdkField<?>>	sdkFields()
static Class<? extends AddProfileKeyRequest.Builder>	serializableBuilderClass()
AddProfileKeyRequest.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

profileId

public final String profileId()

The unique identifier of a customer profile.

Returns:

The unique identifier of a customer profile.

keyName

public final String keyName()

A searchable identifier of a customer profile. The predefined keys you can use 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 include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

hasValues

public final boolean hasValues()

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

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.

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

Returns:

A list of key values.

domainName

public final String domainName()

The unique name of the domain.

Returns:

The unique name of the domain.

toBuilder

public AddProfileKeyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AddProfileKeyRequest.Builder,AddProfileKeyRequest>

Specified by:

toBuilder in class CustomerProfilesRequest

builder

public static AddProfileKeyRequest.Builder builder()

serializableBuilderClass

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