Package software.amazon.awssdk.services.lexmodelsv2.model

Class ListIntentMetricsRequest

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

  • Method Details

    • botId

      public final String botId()

      The identifier for the bot for which you want to retrieve intent metrics.

      Returns:
      The identifier for the bot for which you want to retrieve intent metrics.

    • startDateTime

      public final Instant startDateTime()

      The timestamp that marks the beginning of the range of time for which you want to see intent metrics.

      Returns:
      The timestamp that marks the beginning of the range of time for which you want to see intent metrics.

    • endDateTime

      public final Instant endDateTime()

      The date and time that marks the end of the range of time for which you want to see intent metrics.

      Returns:
      The date and time that marks the end of the range of time for which you want to see intent metrics.

    • hasMetrics

      public final boolean hasMetrics()
      For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • metrics

      public final List<AnalyticsIntentMetric> metrics()

      A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the order by which to organize the results.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.

      Returns:
      A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the order by which to organize the results.

    • hasBinBy

      public final boolean hasBinBy()
      For responses, this returns true if the service returned a value for the BinBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • binBy

      public final List<AnalyticsBinBySpecification> binBy()

      A list of objects, each of which contains specifications for organizing the results by time.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBinBy() method.

      Returns:
      A list of objects, each of which contains specifications for organizing the results by time.

    • hasGroupBy

      public final boolean hasGroupBy()
      For responses, this returns true if the service returned a value for the GroupBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • groupBy

      public final List<AnalyticsIntentGroupBySpecification> groupBy()

      A list of objects, each of which specifies how to group the results. You can group by the following criteria:

      • IntentName – The name of the intent.

      • IntentEndState – The final state of the intent. The possible end states are detailed in Key definitions in the user guide.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupBy() method.

      Returns:
      A list of objects, each of which specifies how to group the results. You can group by the following criteria:

      • IntentName – The name of the intent.

      • IntentEndState – The final state of the intent. The possible end states are detailed in Key definitions in the user guide.

    • hasFilters

      public final boolean hasFilters()
      For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • filters

      public final List<AnalyticsIntentFilter> filters()

      A list of objects, each of which describes a condition by which you want to filter the results.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

      Returns:
      A list of objects, each of which describes a condition by which you want to filter the results.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

      Returns:
      The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

    • nextToken

      public final String nextToken()

      If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

      Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.

      Returns:
      If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

      Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.

    • toBuilder

      public ListIntentMetricsRequest.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<ListIntentMetricsRequest.Builder,ListIntentMetricsRequest>
      Specified by:
      toBuilder in class LexModelsV2Request
      Returns:
      a builder for type T

    • builder

      public static ListIntentMetricsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListIntentMetricsRequest.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.