Package com.launchdarkly.api.model

Class MetricRep

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

    • Field Detail

      • SERIALIZED_NAME_EXPERIMENT_COUNT

        public static final java.lang.String SERIALIZED_NAME_EXPERIMENT_COUNT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_METRIC_GROUP_COUNT

        public static final java.lang.String SERIALIZED_NAME_METRIC_GROUP_COUNT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ACTIVE_EXPERIMENT_COUNT

        public static final java.lang.String SERIALIZED_NAME_ACTIVE_EXPERIMENT_COUNT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ACTIVE_GUARDED_ROLLOUT_COUNT

        public static final java.lang.String SERIALIZED_NAME_ACTIVE_GUARDED_ROLLOUT_COUNT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ID

        public static final java.lang.String SERIALIZED_NAME_ID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_VERSION_ID

        public static final java.lang.String SERIALIZED_NAME_VERSION_ID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_VERSION

        public static final java.lang.String SERIALIZED_NAME_VERSION
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_KEY

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

      • SERIALIZED_NAME_NAME

        public static final java.lang.String SERIALIZED_NAME_NAME
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_KIND

        public static final java.lang.String SERIALIZED_NAME_KIND
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ATTACHED_FLAG_COUNT

        public static final java.lang.String SERIALIZED_NAME_ATTACHED_FLAG_COUNT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_LINKS

        public static final java.lang.String SERIALIZED_NAME_LINKS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SITE

        public static final java.lang.String SERIALIZED_NAME_SITE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ACCESS

        public static final java.lang.String SERIALIZED_NAME_ACCESS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_TAGS

        public static final java.lang.String SERIALIZED_NAME_TAGS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_CREATION_DATE

        public static final java.lang.String SERIALIZED_NAME_CREATION_DATE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_LAST_MODIFIED

        public static final java.lang.String SERIALIZED_NAME_LAST_MODIFIED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_MAINTAINER_ID

        public static final java.lang.String SERIALIZED_NAME_MAINTAINER_ID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_MAINTAINER

        public static final java.lang.String SERIALIZED_NAME_MAINTAINER
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_DESCRIPTION

        public static final java.lang.String SERIALIZED_NAME_DESCRIPTION
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_CATEGORY

        public static final java.lang.String SERIALIZED_NAME_CATEGORY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_IS_NUMERIC

        public static final java.lang.String SERIALIZED_NAME_IS_NUMERIC
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SUCCESS_CRITERIA

        public static final java.lang.String SERIALIZED_NAME_SUCCESS_CRITERIA
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_UNIT

        public static final java.lang.String SERIALIZED_NAME_UNIT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_EVENT_KEY

        public static final java.lang.String SERIALIZED_NAME_EVENT_KEY
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_RANDOMIZATION_UNITS

        public static final java.lang.String SERIALIZED_NAME_RANDOMIZATION_UNITS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_FILTERS

        public static final java.lang.String SERIALIZED_NAME_FILTERS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_UNIT_AGGREGATION_TYPE

        public static final java.lang.String SERIALIZED_NAME_UNIT_AGGREGATION_TYPE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ANALYSIS_TYPE

        public static final java.lang.String SERIALIZED_NAME_ANALYSIS_TYPE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_PERCENTILE_VALUE

        public static final java.lang.String SERIALIZED_NAME_PERCENTILE_VALUE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_EVENT_DEFAULT

        public static final java.lang.String SERIALIZED_NAME_EVENT_DEFAULT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_DATA_SOURCE

        public static final java.lang.String SERIALIZED_NAME_DATA_SOURCE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_LAST_SEEN

        public static final java.lang.String SERIALIZED_NAME_LAST_SEEN
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ARCHIVED

        public static final java.lang.String SERIALIZED_NAME_ARCHIVED
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ARCHIVED_AT

        public static final java.lang.String SERIALIZED_NAME_ARCHIVED_AT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_SELECTOR

        public static final java.lang.String SERIALIZED_NAME_SELECTOR
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_URLS

        public static final java.lang.String SERIALIZED_NAME_URLS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_EXPERIMENTS

        public static final java.lang.String SERIALIZED_NAME_EXPERIMENTS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_METRIC_GROUPS

        public static final java.lang.String SERIALIZED_NAME_METRIC_GROUPS
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_LAST_USED_IN_EXPERIMENT

        public static final java.lang.String SERIALIZED_NAME_LAST_USED_IN_EXPERIMENT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_LAST_USED_IN_GUARDED_ROLLOUT

        public static final java.lang.String SERIALIZED_NAME_LAST_USED_IN_GUARDED_ROLLOUT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_IS_ACTIVE

        public static final java.lang.String SERIALIZED_NAME_IS_ACTIVE
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ATTACHED_FEATURES

        public static final java.lang.String SERIALIZED_NAME_ATTACHED_FEATURES
        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

      • MetricRep

        public MetricRep()

    • Method Detail

      • experimentCount

        public MetricRep experimentCount​(@Nullable
                                 java.lang.Integer experimentCount)

      • getExperimentCount

        @Nullable
public java.lang.Integer getExperimentCount()
        The number of experiments using this metric
        Returns:
        experimentCount

      • setExperimentCount

        public void setExperimentCount​(@Nullable
                               java.lang.Integer experimentCount)

      • metricGroupCount

        public MetricRep metricGroupCount​(@Nullable
                                  java.lang.Integer metricGroupCount)

      • getMetricGroupCount

        @Nullable
public java.lang.Integer getMetricGroupCount()
        The number of metric groups using this metric
        Returns:
        metricGroupCount

      • setMetricGroupCount

        public void setMetricGroupCount​(@Nullable
                                java.lang.Integer metricGroupCount)

      • activeExperimentCount

        public MetricRep activeExperimentCount​(@Nullable
                                       java.lang.Integer activeExperimentCount)

      • getActiveExperimentCount

        @Nullable
public java.lang.Integer getActiveExperimentCount()
        The number of active experiments using this metric
        Returns:
        activeExperimentCount

      • setActiveExperimentCount

        public void setActiveExperimentCount​(@Nullable
                                     java.lang.Integer activeExperimentCount)

      • activeGuardedRolloutCount

        public MetricRep activeGuardedRolloutCount​(@Nullable
                                           java.lang.Integer activeGuardedRolloutCount)

      • getActiveGuardedRolloutCount

        @Nullable
public java.lang.Integer getActiveGuardedRolloutCount()
        The number of active guarded rollouts using this metric
        Returns:
        activeGuardedRolloutCount

      • setActiveGuardedRolloutCount

        public void setActiveGuardedRolloutCount​(@Nullable
                                         java.lang.Integer activeGuardedRolloutCount)

      • id

        public MetricRep id​(@Nonnull
                    java.lang.String id)

      • getId

        @Nonnull
public java.lang.String getId()
        The ID of this metric
        Returns:
        id

      • setId

        public void setId​(@Nonnull
                  java.lang.String id)

      • versionId

        public MetricRep versionId​(@Nonnull
                           java.lang.String versionId)

      • getVersionId

        @Nonnull
public java.lang.String getVersionId()
        The version ID of the metric
        Returns:
        versionId

      • setVersionId

        public void setVersionId​(@Nonnull
                         java.lang.String versionId)

      • version

        public MetricRep version​(@Nullable
                         java.lang.Integer version)

      • getVersion

        @Nullable
public java.lang.Integer getVersion()
        Version of the metric
        Returns:
        version

      • setVersion

        public void setVersion​(@Nullable
                       java.lang.Integer version)

      • key

        public MetricRep key​(@Nonnull
                     java.lang.String key)

      • getKey

        @Nonnull
public java.lang.String getKey()
        A unique key to reference the metric
        Returns:
        key

      • setKey

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

      • name

        public MetricRep name​(@Nonnull
                      java.lang.String name)

      • getName

        @Nonnull
public java.lang.String getName()
        A human-friendly name for the metric
        Returns:
        name

      • setName

        public void setName​(@Nonnull
                    java.lang.String name)

      • getKind

        @Nonnull
public MetricRep.KindEnum getKind()
        The kind of event the metric tracks
        Returns:
        kind

      • attachedFlagCount

        public MetricRep attachedFlagCount​(@Nullable
                                   java.lang.Integer attachedFlagCount)

      • getAttachedFlagCount

        @Nullable
public java.lang.Integer getAttachedFlagCount()
        The number of feature flags currently attached to this metric
        Returns:
        attachedFlagCount

      • setAttachedFlagCount

        public void setAttachedFlagCount​(@Nullable
                                 java.lang.Integer attachedFlagCount)

      • links

        public MetricRep links​(@Nonnull
                       java.util.Map<java.lang.String,​Link> links)

      • putLinksItem

        public MetricRep putLinksItem​(java.lang.String key,
                              Link linksItem)

      • getLinks

        @Nonnull
public java.util.Map<java.lang.String,​Link> getLinks()
        The location and content type of related resources
        Returns:
        links

      • setLinks

        public void setLinks​(@Nonnull
                     java.util.Map<java.lang.String,​Link> links)

      • getSite

        @Nullable
public Link getSite()
        Get site
        Returns:
        site

      • setSite

        public void setSite​(@Nullable
                    Link site)

      • getAccess

        @Nullable
public Access getAccess()
        Get access
        Returns:
        access

      • setAccess

        public void setAccess​(@Nullable
                      Access access)

      • tags

        public MetricRep tags​(@Nonnull
                      java.util.List<java.lang.String> tags)

      • addTagsItem

        public MetricRep addTagsItem​(java.lang.String tagsItem)

      • getTags

        @Nonnull
public java.util.List<java.lang.String> getTags()
        Tags for the metric
        Returns:
        tags

      • setTags

        public void setTags​(@Nonnull
                    java.util.List<java.lang.String> tags)

      • creationDate

        public MetricRep creationDate​(@Nonnull
                              java.lang.Long creationDate)

      • getCreationDate

        @Nonnull
public java.lang.Long getCreationDate()
        Get creationDate
        Returns:
        creationDate

      • setCreationDate

        public void setCreationDate​(@Nonnull
                            java.lang.Long creationDate)

      • getLastModified

        @Nullable
public Modification getLastModified()
        Get lastModified
        Returns:
        lastModified

      • setLastModified

        public void setLastModified​(@Nullable
                            Modification lastModified)

      • maintainerId

        public MetricRep maintainerId​(@Nullable
                              java.lang.String maintainerId)

      • getMaintainerId

        @Nullable
public java.lang.String getMaintainerId()
        The ID of the member who maintains this metric
        Returns:
        maintainerId

      • setMaintainerId

        public void setMaintainerId​(@Nullable
                            java.lang.String maintainerId)

      • getMaintainer

        @Nullable
public MemberSummary getMaintainer()
        Get maintainer
        Returns:
        maintainer

      • setMaintainer

        public void setMaintainer​(@Nullable
                          MemberSummary maintainer)

      • description

        public MetricRep description​(@Nullable
                             java.lang.String description)

      • getDescription

        @Nullable
public java.lang.String getDescription()
        Description of the metric
        Returns:
        description

      • setDescription

        public void setDescription​(@Nullable
                           java.lang.String description)

      • category

        public MetricRep category​(@Nullable
                          java.lang.String category)

      • getCategory

        @Nullable
public java.lang.String getCategory()
        The category of the metric
        Returns:
        category

      • setCategory

        public void setCategory​(@Nullable
                        java.lang.String category)

      • isNumeric

        public MetricRep isNumeric​(@Nullable
                           java.lang.Boolean isNumeric)

      • getIsNumeric

        @Nullable
public java.lang.Boolean getIsNumeric()
        For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        Returns:
        isNumeric

      • setIsNumeric

        public void setIsNumeric​(@Nullable
                         java.lang.Boolean isNumeric)

      • getSuccessCriteria

        @Nullable
public MetricRep.SuccessCriteriaEnum getSuccessCriteria()
        For custom metrics, the success criteria
        Returns:
        successCriteria

      • unit

        public MetricRep unit​(@Nullable
                      java.lang.String unit)

      • getUnit

        @Nullable
public java.lang.String getUnit()
        For numeric custom metrics, the unit of measure
        Returns:
        unit

      • setUnit

        public void setUnit​(@Nullable
                    java.lang.String unit)

      • eventKey

        public MetricRep eventKey​(@Nullable
                          java.lang.String eventKey)

      • getEventKey

        @Nullable
public java.lang.String getEventKey()
        For custom metrics, the event key to use in your code
        Returns:
        eventKey

      • setEventKey

        public void setEventKey​(@Nullable
                        java.lang.String eventKey)

      • randomizationUnits

        public MetricRep randomizationUnits​(@Nullable
                                    java.util.List<java.lang.String> randomizationUnits)

      • addRandomizationUnitsItem

        public MetricRep addRandomizationUnitsItem​(java.lang.String randomizationUnitsItem)

      • getRandomizationUnits

        @Nullable
public java.util.List<java.lang.String> getRandomizationUnits()
        An array of randomization units allowed for this metric
        Returns:
        randomizationUnits

      • setRandomizationUnits

        public void setRandomizationUnits​(@Nullable
                                  java.util.List<java.lang.String> randomizationUnits)

      • getFilters

        @Nullable
public Filter getFilters()
        Get filters
        Returns:
        filters

      • setFilters

        public void setFilters​(@Nullable
                       Filter filters)

      • getUnitAggregationType

        @Nullable
public MetricRep.UnitAggregationTypeEnum getUnitAggregationType()
        The method by which multiple unit event values are aggregated
        Returns:
        unitAggregationType

      • getAnalysisType

        @Nullable
public MetricRep.AnalysisTypeEnum getAnalysisType()
        The method for analyzing metric events
        Returns:
        analysisType

      • percentileValue

        public MetricRep percentileValue​(@Nullable
                                 java.lang.Integer percentileValue)

      • getPercentileValue

        @Nullable
public java.lang.Integer getPercentileValue()
        The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>.
        Returns:
        percentileValue

      • setPercentileValue

        public void setPercentileValue​(@Nullable
                               java.lang.Integer percentileValue)

      • getEventDefault

        @Nullable
public MetricEventDefaultRep getEventDefault()
        Get eventDefault
        Returns:
        eventDefault

      • lastSeen

        public MetricRep lastSeen​(@Nullable
                          java.lang.Long lastSeen)

      • getLastSeen

        @Nullable
public java.lang.Long getLastSeen()
        Get lastSeen
        Returns:
        lastSeen

      • setLastSeen

        public void setLastSeen​(@Nullable
                        java.lang.Long lastSeen)

      • archived

        public MetricRep archived​(@Nullable
                          java.lang.Boolean archived)

      • getArchived

        @Nullable
public java.lang.Boolean getArchived()
        Whether the metric version is archived
        Returns:
        archived

      • setArchived

        public void setArchived​(@Nullable
                        java.lang.Boolean archived)

      • archivedAt

        public MetricRep archivedAt​(@Nullable
                            java.lang.Long archivedAt)

      • getArchivedAt

        @Nullable
public java.lang.Long getArchivedAt()
        Get archivedAt
        Returns:
        archivedAt

      • setArchivedAt

        public void setArchivedAt​(@Nullable
                          java.lang.Long archivedAt)

      • selector

        public MetricRep selector​(@Nullable
                          java.lang.String selector)

      • getSelector

        @Nullable
public java.lang.String getSelector()
        For click metrics, the CSS selectors
        Returns:
        selector

      • setSelector

        public void setSelector​(@Nullable
                        java.lang.String selector)

      • urls

        public MetricRep urls​(@Nullable
                      java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> urls)

      • addUrlsItem

        public MetricRep addUrlsItem​(java.util.Map<java.lang.String,​java.lang.Object> urlsItem)

      • getUrls

        @Nullable
public java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> getUrls()
        Get urls
        Returns:
        urls

      • setUrls

        public void setUrls​(@Nullable
                    java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> urls)

      • getExperiments

        @Nullable
public java.util.List<DependentExperimentRep> getExperiments()
        Get experiments
        Returns:
        experiments

      • setExperiments

        public void setExperiments​(@Nullable
                           java.util.List<DependentExperimentRep> experiments)

      • getMetricGroups

        @Nullable
public java.util.List<DependentMetricGroupRep> getMetricGroups()
        Metric groups that use this metric
        Returns:
        metricGroups

      • setMetricGroups

        public void setMetricGroups​(@Nullable
                            java.util.List<DependentMetricGroupRep> metricGroups)

      • getLastUsedInExperiment

        @Nullable
public DependentExperimentRep getLastUsedInExperiment()
        Get lastUsedInExperiment
        Returns:
        lastUsedInExperiment

      • setLastUsedInExperiment

        public void setLastUsedInExperiment​(@Nullable
                                    DependentExperimentRep lastUsedInExperiment)

      • getLastUsedInGuardedRollout

        @Nullable
public DependentMeasuredRolloutRep getLastUsedInGuardedRollout()
        Get lastUsedInGuardedRollout
        Returns:
        lastUsedInGuardedRollout

      • setLastUsedInGuardedRollout

        public void setLastUsedInGuardedRollout​(@Nullable
                                        DependentMeasuredRolloutRep lastUsedInGuardedRollout)

      • isActive

        public MetricRep isActive​(@Nullable
                          java.lang.Boolean isActive)

      • getIsActive

        @Nullable
public java.lang.Boolean getIsActive()
        Whether the metric is active
        Returns:
        isActive

      • setIsActive

        public void setIsActive​(@Nullable
                        java.lang.Boolean isActive)

      • attachedFeatures

        public MetricRep attachedFeatures​(@Nullable
                                  java.util.List<FlagListingRep> attachedFeatures)

      • getAttachedFeatures

        @Nullable
public java.util.List<FlagListingRep> getAttachedFeatures()
        Details on the flags attached to this metric
        Returns:
        attachedFeatures

      • setAttachedFeatures

        public void setAttachedFeatures​(@Nullable
                                java.util.List<FlagListingRep> attachedFeatures)

      • putAdditionalProperty

        public MetricRep 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 MetricRep 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 MetricRep

      • fromJson

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

      • toJson

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