public class MergeDeveloperIdentitiesRequest extends AmazonWebServiceRequest implements Serializable
MergeDeveloperIdentities operation
.
Merges two users having different IdentityId
s, existing
in the same identity pool, and identified by the same developer
provider. You can use this action to request that discrete users be
merged and identified as a single user in the Cognito environment.
Cognito associates the given source user (
SourceUserIdentifier
) with the IdentityId
of the DestinationUserIdentifier
. Only
developer-authenticated users can be merged. If the users to be merged
are associated with the same public provider, but as two different
users, an exception will be thrown.
NOOP
Constructor and Description |
---|
MergeDeveloperIdentitiesRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getDestinationUserIdentifier()
User identifier for the destination user.
|
String |
getDeveloperProviderName()
The "domain" by which Cognito will refer to your users.
|
String |
getIdentityPoolId()
An identity pool ID in the format REGION:GUID.
|
String |
getSourceUserIdentifier()
User identifier for the source user.
|
int |
hashCode() |
void |
setDestinationUserIdentifier(String destinationUserIdentifier)
User identifier for the destination user.
|
void |
setDeveloperProviderName(String developerProviderName)
The "domain" by which Cognito will refer to your users.
|
void |
setIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.
|
void |
setSourceUserIdentifier(String sourceUserIdentifier)
User identifier for the source user.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
MergeDeveloperIdentitiesRequest |
withDestinationUserIdentifier(String destinationUserIdentifier)
User identifier for the destination user.
|
MergeDeveloperIdentitiesRequest |
withDeveloperProviderName(String developerProviderName)
The "domain" by which Cognito will refer to your users.
|
MergeDeveloperIdentitiesRequest |
withIdentityPoolId(String identityPoolId)
An identity pool ID in the format REGION:GUID.
|
MergeDeveloperIdentitiesRequest |
withSourceUserIdentifier(String sourceUserIdentifier)
User identifier for the source user.
|
copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getSourceUserIdentifier()
DeveloperUserIdentifier
.DeveloperUserIdentifier
.public void setSourceUserIdentifier(String sourceUserIdentifier)
DeveloperUserIdentifier
.sourceUserIdentifier
- User identifier for the source user. The value should be a
DeveloperUserIdentifier
.public MergeDeveloperIdentitiesRequest withSourceUserIdentifier(String sourceUserIdentifier)
DeveloperUserIdentifier
.
Returns a reference to this object so that method calls can be chained together.
sourceUserIdentifier
- User identifier for the source user. The value should be a
DeveloperUserIdentifier
.public String getDestinationUserIdentifier()
DeveloperUserIdentifier
.DeveloperUserIdentifier
.public void setDestinationUserIdentifier(String destinationUserIdentifier)
DeveloperUserIdentifier
.destinationUserIdentifier
- User identifier for the destination user. The value should be a
DeveloperUserIdentifier
.public MergeDeveloperIdentitiesRequest withDestinationUserIdentifier(String destinationUserIdentifier)
DeveloperUserIdentifier
.
Returns a reference to this object so that method calls can be chained together.
destinationUserIdentifier
- User identifier for the destination user. The value should be a
DeveloperUserIdentifier
.public String getDeveloperProviderName()
DeveloperProviderName
, you can use letters as well as
period (.), underscore (_), and dash (-).
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
DeveloperProviderName
, you can use letters as well as
period (.), underscore (_), and dash (-).public void setDeveloperProviderName(String developerProviderName)
DeveloperProviderName
, you can use letters as well as
period (.), underscore (_), and dash (-).
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
developerProviderName
- The "domain" by which Cognito will refer to your users. This is a
(pseudo) domain name that you provide while creating an identity pool.
This name acts as a placeholder that allows your backend and the
Cognito service to communicate about the developer provider. For the
DeveloperProviderName
, you can use letters as well as
period (.), underscore (_), and dash (-).public MergeDeveloperIdentitiesRequest withDeveloperProviderName(String developerProviderName)
DeveloperProviderName
, you can use letters as well as
period (.), underscore (_), and dash (-).
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
developerProviderName
- The "domain" by which Cognito will refer to your users. This is a
(pseudo) domain name that you provide while creating an identity pool.
This name acts as a placeholder that allows your backend and the
Cognito service to communicate about the developer provider. For the
DeveloperProviderName
, you can use letters as well as
period (.), underscore (_), and dash (-).public String getIdentityPoolId()
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
public void setIdentityPoolId(String identityPoolId)
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
identityPoolId
- An identity pool ID in the format REGION:GUID.public MergeDeveloperIdentitiesRequest withIdentityPoolId(String identityPoolId)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
identityPoolId
- An identity pool ID in the format REGION:GUID.public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.