public static interface GetJourneyDateRangeKpiRequest.Builder extends PinpointRequest.Builder, SdkPojo, CopyableBuilder<GetJourneyDateRangeKpiRequest.Builder,GetJourneyDateRangeKpiRequest>
| Modifier and Type | Method and Description |
|---|---|
GetJourneyDateRangeKpiRequest.Builder |
applicationId(String applicationId)
The unique identifier for the application.
|
GetJourneyDateRangeKpiRequest.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.
|
GetJourneyDateRangeKpiRequest.Builder |
journeyId(String journeyId)
The unique identifier for the journey.
|
GetJourneyDateRangeKpiRequest.Builder |
kpiName(String kpiName)
The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for.
|
GetJourneyDateRangeKpiRequest.Builder |
nextToken(String nextToken)
The string that specifies which page of results to return in a paginated response.
|
GetJourneyDateRangeKpiRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
GetJourneyDateRangeKpiRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
GetJourneyDateRangeKpiRequest.Builder |
pageSize(String pageSize)
The maximum number of items to include in each page of a paginated response.
|
GetJourneyDateRangeKpiRequest.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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildGetJourneyDateRangeKpiRequest.Builder applicationId(String applicationId)
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on
the Amazon Pinpoint console.GetJourneyDateRangeKpiRequest.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 and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
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 and use Coordinated Universal Time (UTC),
for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.GetJourneyDateRangeKpiRequest.Builder journeyId(String journeyId)
The unique identifier for the journey.
journeyId - The unique identifier for the journey.GetJourneyDateRangeKpiRequest.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.
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.GetJourneyDateRangeKpiRequest.Builder nextToken(String nextToken)
The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
nextToken - The string that specifies which page of results to return in a paginated response. This parameter is
not supported for application, campaign, and journey metrics.GetJourneyDateRangeKpiRequest.Builder pageSize(String pageSize)
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
pageSize - The maximum number of items to include in each page of a paginated response. This parameter is not
supported for application, campaign, and journey metrics.GetJourneyDateRangeKpiRequest.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 and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
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 and use Coordinated Universal Time
(UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be
fewer than 90 days from the current day.GetJourneyDateRangeKpiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.GetJourneyDateRangeKpiRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.