Package software.amazon.awssdk.services.rum.model

Interface MetricDefinition.Builder

    • Method Detail

      • dimensionKeys

        MetricDefinition.Builder dimensionKeys​(Map<String,​String> dimensionKeys)

        This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

        Parameters:
        dimensionKeys - This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventPattern

        MetricDefinition.Builder eventPattern​(String eventPattern)

        The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

        If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

        Parameters:
        eventPattern - The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

        If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metricDefinitionId

        MetricDefinition.Builder metricDefinitionId​(String metricDefinitionId)

        The ID of this metric definition.

        Parameters:
        metricDefinitionId - The ID of this metric definition.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        MetricDefinition.Builder name​(String name)

        The name of the metric that is defined in this structure.

        Parameters:
        name - The name of the metric that is defined in this structure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • namespace

        MetricDefinition.Builder namespace​(String namespace)

        If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.

        Parameters:
        namespace - If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • unitLabel

        MetricDefinition.Builder unitLabel​(String unitLabel)

        Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

        Parameters:
        unitLabel - Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • valueKey

        MetricDefinition.Builder valueKey​(String valueKey)

        The field within the event object that the metric value is sourced from.

        Parameters:
        valueKey - The field within the event object that the metric value is sourced from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.