com.amazonaws.services.cognitosync.model

Class SetCognitoEventsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitosync.model.SetCognitoEventsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SetCognitoEventsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the SetCognitoEvents operation.

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

See Also:

AmazonCognitoSync.setCognitoEvents(SetCognitoEventsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetCognitoEventsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
SetCognitoEventsRequest	addEventsEntry(String key, String value) The events to configure
SetCognitoEventsRequest	clearEventsEntries() Removes all the entries added into Events.
SetCognitoEventsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Map<String,String>	getEvents() The events to configure
String	getIdentityPoolId() The Cognito Identity Pool to use when configuring Cognito Events
int	hashCode()
void	setEvents(Map<String,String> events) The events to configure
void	setIdentityPoolId(String identityPoolId) The Cognito Identity Pool to use when configuring Cognito Events
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetCognitoEventsRequest	withEvents(Map<String,String> events) The events to configure
SetCognitoEventsRequest	withIdentityPoolId(String identityPoolId) The Cognito Identity Pool to use when configuring Cognito Events

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetCognitoEventsRequest

public SetCognitoEventsRequest()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

The Cognito Identity Pool to use when configuring Cognito Events

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Returns:

The Cognito Identity Pool to use when configuring Cognito Events

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

The Cognito Identity Pool to use when configuring Cognito Events

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - The Cognito Identity Pool to use when configuring Cognito Events

withIdentityPoolId

public SetCognitoEventsRequest withIdentityPoolId(String identityPoolId)

The Cognito Identity Pool to use when configuring Cognito Events

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - The Cognito Identity Pool to use when configuring Cognito Events

Returns:

A reference to this updated object so that method calls can be chained together.

getEvents

public Map<String,String> getEvents()

The events to configure

Constraints:
Length: 0 - 1

Returns:

The events to configure

setEvents

public void setEvents(Map<String,String> events)

The events to configure

Constraints:
Length: 0 - 1

Parameters:

events - The events to configure

withEvents

public SetCognitoEventsRequest withEvents(Map<String,String> events)

The events to configure

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

Constraints:
Length: 0 - 1

Parameters:

events - The events to configure

Returns:

A reference to this updated object so that method calls can be chained together.

addEventsEntry

public SetCognitoEventsRequest addEventsEntry(String key,
                                     String value)

The events to configure

The method adds a new key-value pair into Events parameter, and returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 1

Parameters:

key - The key of the entry to be added into Events.

value - The corresponding value of the entry to be added into Events.

clearEventsEntries

public SetCognitoEventsRequest clearEventsEntries()

Removes all the entries added into Events.

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public SetCognitoEventsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()