AnalyticsConfigurationType (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.services.cognitoidentityprovider.model.AnalyticsConfigurationType

All Implemented Interfaces:

java.io.Serializable
```
public class AnalyticsConfigurationType
extends java.lang.Object
implements java.io.Serializable
```
The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.

In Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AnalyticsConfigurationType()

Constructors
Constructor and Description
`AnalyticsConfigurationType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getApplicationArn()` The Amazon Resource Name (ARN) of an Amazon Pinpoint project.
`java.lang.String`	`getApplicationId()` The application ID for an Amazon Pinpoint application.
`java.lang.String`	`getExternalId()` The external ID.
`java.lang.String`	`getRoleArn()` The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
`java.lang.Boolean`	`getUserDataShared()` If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
`int`	`hashCode()`
`java.lang.Boolean`	`isUserDataShared()` If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
`void`	`setApplicationArn(java.lang.String applicationArn)` The Amazon Resource Name (ARN) of an Amazon Pinpoint project.
`void`	`setApplicationId(java.lang.String applicationId)` The application ID for an Amazon Pinpoint application.
`void`	`setExternalId(java.lang.String externalId)` The external ID.
`void`	`setRoleArn(java.lang.String roleArn)` The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
`void`	`setUserDataShared(java.lang.Boolean userDataShared)` If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AnalyticsConfigurationType`	`withApplicationArn(java.lang.String applicationArn)` The Amazon Resource Name (ARN) of an Amazon Pinpoint project.
`AnalyticsConfigurationType`	`withApplicationId(java.lang.String applicationId)` The application ID for an Amazon Pinpoint application.
`AnalyticsConfigurationType`	`withExternalId(java.lang.String externalId)` The external ID.
`AnalyticsConfigurationType`	`withRoleArn(java.lang.String roleArn)` The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
`AnalyticsConfigurationType`	`withUserDataShared(java.lang.Boolean userDataShared)` If `UserDataShared` is `true`, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AnalyticsConfigurationType
```
public AnalyticsConfigurationType()
```
- Method Detail
  - getApplicationId
```
public java.lang.String getApplicationId()
```
    The application ID for an Amazon Pinpoint application.
    
    Constraints:
    Pattern: ^[0-9a-fA-F]+$
    
    Returns:
    
    The application ID for an Amazon Pinpoint application.
  - setApplicationId
```
public void setApplicationId(java.lang.String applicationId)
```
    The application ID for an Amazon Pinpoint application.
    
    Constraints:
    Pattern: ^[0-9a-fA-F]+$
    
    Parameters:
    
    applicationId -
    The application ID for an Amazon Pinpoint application.
  - withApplicationId
```
public AnalyticsConfigurationType withApplicationId(java.lang.String applicationId)
```
    The application ID for an Amazon Pinpoint application.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^[0-9a-fA-F]+$
    
    Parameters:
    
    applicationId -
    The application ID for an Amazon Pinpoint application.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getApplicationArn
```
public java.lang.String getApplicationArn()
```
    The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Returns:
    
    The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
  - setApplicationArn
```
public void setApplicationArn(java.lang.String applicationArn)
```
    The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Parameters:
    
    applicationArn -
    The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
  - withApplicationArn
```
public AnalyticsConfigurationType withApplicationArn(java.lang.String applicationArn)
```
    The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Parameters:
    
    applicationArn -
    The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Returns:
    
    The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
  - setRoleArn
```
public void setRoleArn(java.lang.String roleArn)
```
    The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Parameters:
    
    roleArn -
    The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
  - withRoleArn
```
public AnalyticsConfigurationType withRoleArn(java.lang.String roleArn)
```
    The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+= /,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
    
    Parameters:
    
    roleArn -
    The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExternalId
```
public java.lang.String getExternalId()
```
    The external ID.
    
    Constraints:
    Length: 0 - 131072
    
    Returns:
    
    The external ID.
  - setExternalId
```
public void setExternalId(java.lang.String externalId)
```
    The external ID.
    
    Constraints:
    Length: 0 - 131072
    
    Parameters:
    
    externalId -
    The external ID.
  - withExternalId
```
public AnalyticsConfigurationType withExternalId(java.lang.String externalId)
```
    The external ID.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 131072
    
    Parameters:
    
    externalId -
    The external ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isUserDataShared
```
public java.lang.Boolean isUserDataShared()
```
    If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
    
    Returns:
    
    If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
  - getUserDataShared
```
public java.lang.Boolean getUserDataShared()
```
    If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
    
    Returns:
    
    If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
  - setUserDataShared
```
public void setUserDataShared(java.lang.Boolean userDataShared)
```
    If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
    
    Parameters:
    
    userDataShared -
    If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
  - withUserDataShared
```
public AnalyticsConfigurationType withUserDataShared(java.lang.Boolean userDataShared)
```
    If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    userDataShared -
    If UserDataShared is true, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class AnalyticsConfigurationType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnalyticsConfigurationType

Method Detail

getApplicationId

setApplicationId

withApplicationId

getApplicationArn

setApplicationArn

withApplicationArn

getRoleArn

setRoleArn

withRoleArn

getExternalId

setExternalId

withExternalId

isUserDataShared

getUserDataShared

setUserDataShared

withUserDataShared

toString

hashCode

equals