CampaignDateRangeKpiResponse (AWS Java SDK for Amazon Pinpoint 1.12.74 API)

java.lang.Object
- com.amazonaws.services.pinpoint.model.CampaignDateRangeKpiResponse

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CampaignDateRangeKpiResponse
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CampaignDateRangeKpiResponse()

Constructors
Constructor and Description
`CampaignDateRangeKpiResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CampaignDateRangeKpiResponse`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApplicationId()` The unique identifier for the application that the metric applies to.
`String`	`getCampaignId()` The unique identifier for the campaign that the metric applies to.
`Date`	`getEndTime()` The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format.
`String`	`getKpiName()` The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for.
`BaseKpiResult`	`getKpiResult()` An array of objects that contains the results of the query.
`String`	`getNextToken()` The string to use in a subsequent request to get the next page of results in a paginated response.
`Date`	`getStartTime()` The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setApplicationId(String applicationId)` The unique identifier for the application that the metric applies to.
`void`	`setCampaignId(String campaignId)` The unique identifier for the campaign that the metric applies to.
`void`	`setEndTime(Date endTime)` The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format.
`void`	`setKpiName(String kpiName)` The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for.
`void`	`setKpiResult(BaseKpiResult kpiResult)` An array of objects that contains the results of the query.
`void`	`setNextToken(String nextToken)` The string to use in a subsequent request to get the next page of results in a paginated response.
`void`	`setStartTime(Date startTime)` The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format.
`String`	`toString()` Returns a string representation of this object.
`CampaignDateRangeKpiResponse`	`withApplicationId(String applicationId)` The unique identifier for the application that the metric applies to.
`CampaignDateRangeKpiResponse`	`withCampaignId(String campaignId)` The unique identifier for the campaign that the metric applies to.
`CampaignDateRangeKpiResponse`	`withEndTime(Date endTime)` The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format.
`CampaignDateRangeKpiResponse`	`withKpiName(String kpiName)` The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for.
`CampaignDateRangeKpiResponse`	`withKpiResult(BaseKpiResult kpiResult)` An array of objects that contains the results of the query.
`CampaignDateRangeKpiResponse`	`withNextToken(String nextToken)` The string to use in a subsequent request to get the next page of results in a paginated response.
`CampaignDateRangeKpiResponse`	`withStartTime(Date startTime)` The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format.

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

- Constructor Detail
  - CampaignDateRangeKpiResponse
```
public CampaignDateRangeKpiResponse()
```
- Method Detail
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    The unique identifier for the application that the metric applies to.
    
    Parameters:
    
    applicationId - The unique identifier for the application that the metric applies to.
  - getApplicationId
```
public String getApplicationId()
```
    The unique identifier for the application that the metric applies to.
    
    Returns:
    
    The unique identifier for the application that the metric applies to.
  - withApplicationId
```
public CampaignDateRangeKpiResponse withApplicationId(String applicationId)
```
    The unique identifier for the application that the metric applies to.
    
    Parameters:
    
    applicationId - The unique identifier for the application that the metric applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCampaignId
```
public void setCampaignId(String campaignId)
```
    The unique identifier for the campaign that the metric applies to.
    
    Parameters:
    
    campaignId - The unique identifier for the campaign that the metric applies to.
  - getCampaignId
```
public String getCampaignId()
```
    The unique identifier for the campaign that the metric applies to.
    
    Returns:
    
    The unique identifier for the campaign that the metric applies to.
  - withCampaignId
```
public CampaignDateRangeKpiResponse withCampaignId(String campaignId)
```
    The unique identifier for the campaign that the metric applies to.
    
    Parameters:
    
    campaignId - The unique identifier for the campaign that the metric applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
    
    Parameters:
    
    endTime - The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
  - getEndTime
```
public Date getEndTime()
```
    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
    
    Returns:
    
    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
  - withEndTime
```
public CampaignDateRangeKpiResponse withEndTime(Date endTime)
```
    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
    
    Parameters:
    
    endTime - The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKpiName
```
public void setKpiName(String kpiName)
```
    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
    
    Parameters:
    
    kpiName - The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
  - getKpiName
```
public String getKpiName()
```
    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
    
    Returns:
    
    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
  - withKpiName
```
public CampaignDateRangeKpiResponse withKpiName(String kpiName)
```
    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
    
    Parameters:
    
    kpiName - The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKpiResult
```
public void setKpiResult(BaseKpiResult kpiResult)
```
    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
    
    Parameters:
    
    kpiResult - An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
  - getKpiResult
```
public BaseKpiResult getKpiResult()
```
    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
    
    Returns:
    
    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
  - withKpiResult
```
public CampaignDateRangeKpiResponse withKpiResult(BaseKpiResult kpiResult)
```
    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
    
    Parameters:
    
    kpiResult - An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextToken
```
public void setNextToken(String nextToken)
```
    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
    
    Parameters:
    
    nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
  - getNextToken
```
public String getNextToken()
```
    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
    
    Returns:
    
    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
  - withNextToken
```
public CampaignDateRangeKpiResponse withNextToken(String nextToken)
```
    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
    
    Parameters:
    
    nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
    
    Parameters:
    
    startTime - The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
  - getStartTime
```
public Date getStartTime()
```
    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
    
    Returns:
    
    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
  - withStartTime
```
public CampaignDateRangeKpiResponse withStartTime(Date startTime)
```
    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
    
    Parameters:
    
    startTime - The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
    
    Returns:
    
    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. 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 CampaignDateRangeKpiResponse clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class CampaignDateRangeKpiResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CampaignDateRangeKpiResponse

Method Detail

setApplicationId

getApplicationId

withApplicationId

setCampaignId

getCampaignId

withCampaignId

setEndTime

getEndTime

withEndTime

setKpiName

getKpiName

withKpiName

setKpiResult

getKpiResult

withKpiResult

setNextToken

getNextToken

withNextToken

setStartTime

getStartTime

withStartTime

toString

equals

hashCode

clone

marshall