Class ApplicationDateRangeKpiResponse
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ApplicationDateRangeKpiResponse.Builder,
ApplicationDateRangeKpiResponse>
Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The unique identifier for the application that the metric applies to.builder()
final Instant
endTime()
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
kpiName()
The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for.final BaseKpiResult
An array of objects that contains the results of the query.final String
The string to use in a subsequent request to get the next page of results in a paginated response.static Class
<? extends ApplicationDateRangeKpiResponse.Builder> final Instant
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The unique identifier for the application that the metric applies to.
- Returns:
- The unique identifier for the application that the metric applies to.
-
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:
- 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.
-
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:
- 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.
-
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:
- An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
-
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 Application 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 Application Metrics resource because the resource returns all results in a single page.
-
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:
- 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.
-
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 interfaceToCopyableBuilder<ApplicationDateRangeKpiResponse.Builder,
ApplicationDateRangeKpiResponse> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-