Package software.amazon.awssdk.services.pinpoint.model

Class GetJourneyDateRangeKpiRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.pinpoint.model.PinpointRequest
software.amazon.awssdk.services.pinpoint.model.GetJourneyDateRangeKpiRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetJourneyDateRangeKpiRequest.Builder,GetJourneyDateRangeKpiRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetJourneyDateRangeKpiRequest extends PinpointRequest implements ToCopyableBuilder<GetJourneyDateRangeKpiRequest.Builder,GetJourneyDateRangeKpiRequest>

  • Method Details

    • applicationId

      public final String applicationId()

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

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

    • endTime

      public final 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.

      Returns:
      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.

    • journeyId

      public final String journeyId()

      The unique identifier for the journey.

      Returns:
      The unique identifier for the journey.

    • kpiName

      public final 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.

      Returns:
      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.

    • nextToken

      public final 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.

      Returns:
      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.

    • pageSize

      public final 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.

      Returns:
      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.

    • startTime

      public final 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.

      Returns:
      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.

    • toBuilder

      public GetJourneyDateRangeKpiRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetJourneyDateRangeKpiRequest.Builder,GetJourneyDateRangeKpiRequest>
      Specified by:
      toBuilder in class PinpointRequest
      Returns:
      a builder for type T

    • builder

      public static GetJourneyDateRangeKpiRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetJourneyDateRangeKpiRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.