Interface GetCampaignDateRangeKpiRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetCampaignDateRangeKpiRequest.Builder,
,GetCampaignDateRangeKpiRequest> PinpointRequest.Builder
,SdkBuilder<GetCampaignDateRangeKpiRequest.Builder,
,GetCampaignDateRangeKpiRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetCampaignDateRangeKpiRequest
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The unique identifier for the application.campaignId
(String campaignId) The unique identifier for the campaign.The last date and time to retrieve data for, as part of an inclusive date range that filters the query results.The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for.The string that specifies which page of results to return in a paginated response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The maximum number of items to include in each page of a paginated response.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.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.pinpoint.model.PinpointRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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.
- 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 and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetCampaignDateRangeKpiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetCampaignDateRangeKpiRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-