Class BatchGetRumMetricDefinitionsRequest

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

  • Method Details

    • appMonitorName

      public final String appMonitorName()

      The name of the CloudWatch RUM app monitor that is sending the metrics.

      Returns:
      The name of the CloudWatch RUM app monitor that is sending the metrics.

    • destination

      public final MetricDestination destination()

      The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.

      If the service returns an enum value that is not available in the current SDK version, destination will return MetricDestination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationAsString().

      Returns:
      The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.
      See Also:

    • destinationAsString

      public final String destinationAsString()

      The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.

      If the service returns an enum value that is not available in the current SDK version, destination will return MetricDestination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationAsString().

      Returns:
      The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.
      See Also:

    • destinationArn

      public final String destinationArn()

      This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

      This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.

      Returns:
      This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

      This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

      To retrieve the remaining results, make another call with the returned NextToken value.

      Returns:
      The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

      To retrieve the remaining results, make another call with the returned NextToken value.

    • nextToken

      public final String nextToken()

      Use the token returned by the previous operation to request the next page of results.

      Returns:
      Use the token returned by the previous operation to request the next page of results.

    • toBuilder

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

    • builder

      public static BatchGetRumMetricDefinitionsRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.