Class MetricInput


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2026-03-05T10:45:26.516033Z[Etc/UTC]",
               comments="Generator version: 7.18.0")
    public class MetricInput
    extends java.lang.Object
    MetricInput
    • Field Detail

      • SERIALIZED_NAME_KEY

        public static final java.lang.String SERIALIZED_NAME_KEY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_IS_GROUP

        public static final java.lang.String SERIALIZED_NAME_IS_GROUP
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PRIMARY

        public static final java.lang.String SERIALIZED_NAME_PRIMARY
        See Also:
        Constant Field Values
      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields
      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields
    • Constructor Detail

      • MetricInput

        public MetricInput()
    • Method Detail

      • key

        public MetricInput key​(@Nonnull
                               java.lang.String key)
      • getKey

        @Nonnull
        public java.lang.String getKey()
        The metric key
        Returns:
        key
      • setKey

        public void setKey​(@Nonnull
                           java.lang.String key)
      • isGroup

        public MetricInput isGroup​(@Nullable
                                   java.lang.Boolean isGroup)
      • getIsGroup

        @Nullable
        public java.lang.Boolean getIsGroup()
        Whether this is a metric group (true) or a metric (false). Defaults to false
        Returns:
        isGroup
      • setIsGroup

        public void setIsGroup​(@Nullable
                               java.lang.Boolean isGroup)
      • primary

        @Deprecated
        public MetricInput primary​(@Nullable
                                   java.lang.Boolean primary)
        Deprecated.
      • getPrimary

        @Deprecated
        @Nullable
        public java.lang.Boolean getPrimary()
        Deprecated.
        Deprecated, use <code>primarySingleMetricKey</code> and <code>primaryFunnelKey</code>. Whether this is a primary metric (true) or a secondary metric (false)
        Returns:
        primary
      • setPrimary

        @Deprecated
        public void setPrimary​(@Nullable
                               java.lang.Boolean primary)
        Deprecated.
      • putAdditionalProperty

        public MetricInput putAdditionalProperty​(java.lang.String key,
                                                 java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
        Parameters:
        key - name of the property
        value - value of the property
        Returns:
        the MetricInput instance itself
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects
      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.
        Parameters:
        key - name of the property
        Returns:
        an object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                        throws java.io.IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        java.io.IOException - if the JSON Element is invalid with respect to MetricInput
      • fromJson

        public static MetricInput fromJson​(java.lang.String jsonString)
                                    throws java.io.IOException
        Create an instance of MetricInput given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of MetricInput
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to MetricInput
      • toJson

        public java.lang.String toJson()
        Convert an instance of MetricInput to an JSON string
        Returns:
        JSON string