software.amazon.awssdk.services.pinpoint.model

Interface GetCampaignDateRangeKpiRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetCampaignDateRangeKpiRequest.Builder,GetCampaignDateRangeKpiRequest>, PinpointRequest.Builder, SdkBuilder<GetCampaignDateRangeKpiRequest.Builder,GetCampaignDateRangeKpiRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetCampaignDateRangeKpiRequest

public static interface GetCampaignDateRangeKpiRequest.Builder
extends PinpointRequest.Builder, SdkPojo, CopyableBuilder<GetCampaignDateRangeKpiRequest.Builder,GetCampaignDateRangeKpiRequest>

Method Summary

Modifier and Type	Method and Description
GetCampaignDateRangeKpiRequest.Builder	applicationId(String applicationId) The unique identifier for the application.
GetCampaignDateRangeKpiRequest.Builder	campaignId(String campaignId) The unique identifier for the campaign.
GetCampaignDateRangeKpiRequest.Builder	endTime(Instant endTime) The last date and time to retrieve data for, as part of an inclusive date range that filters the query results.
GetCampaignDateRangeKpiRequest.Builder	kpiName(String kpiName) The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for.
GetCampaignDateRangeKpiRequest.Builder	nextToken(String nextToken) The NextToken string that specifies which page of results to return in a paginated response.
GetCampaignDateRangeKpiRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetCampaignDateRangeKpiRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetCampaignDateRangeKpiRequest.Builder	pageSize(String pageSize) The maximum number of items to include in each page of a paginated response.
GetCampaignDateRangeKpiRequest.Builder	startTime(Instant startTime) The first date and time to retrieve data for, as part of an inclusive date range that filters the query results.

Methods inherited from interface software.amazon.awssdk.services.pinpoint.model.PinpointRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

applicationId

GetCampaignDateRangeKpiRequest.Builder applicationId(String applicationId)

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Parameters:

applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Returns:

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

campaignId

GetCampaignDateRangeKpiRequest.Builder campaignId(String campaignId)

The unique identifier for the campaign.

Parameters:

campaignId - The unique identifier for the campaign.

Returns:

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

endTime

GetCampaignDateRangeKpiRequest.Builder endTime(Instant endTime)

The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.

Parameters:

endTime - The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.

Returns:

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

kpiName

GetCampaignDateRangeKpiRequest.Builder kpiName(String kpiName)

The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data 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. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

Parameters:

kpiName - The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data 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. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

Returns:

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

nextToken

GetCampaignDateRangeKpiRequest.Builder nextToken(String nextToken)

The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.

Parameters:

nextToken - The NextToken string that specifies which page of results to return in a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.

Returns:

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

pageSize

GetCampaignDateRangeKpiRequest.Builder pageSize(String pageSize)

The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.

Parameters:

pageSize - The maximum number of items to include in each page of a paginated response. This parameter is currently not supported by the Application Metrics and Campaign Metrics resources.

Returns:

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

startTime

GetCampaignDateRangeKpiRequest.Builder startTime(Instant startTime)

The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.

Parameters:

startTime - The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.

Returns:

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

overrideConfiguration

GetCampaignDateRangeKpiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetCampaignDateRangeKpiRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder