Package com.launchdarkly.api.model

Class MetricRep

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-11-16T23:57:26.096741Z[Etc/UTC]")
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_ID

        public static final java.lang.String SERIALIZED_NAME_ID
        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_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_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_EXPERIMENTS

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

      • SERIALIZED_NAME_VERSION

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

      • 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​(java.lang.Integer experimentCount)

      • getExperimentCount

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

      • setExperimentCount

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

      • id

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

      • getId

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

      • setId

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

      • key

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

      • getKey

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

      • setKey

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

      • name

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

      • getName

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

      • setName

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

      • getKind

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

      • attachedFlagCount

        public MetricRep attachedFlagCount​(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​(java.lang.Integer attachedFlagCount)

      • links

        public MetricRep links​(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​(java.util.Map<java.lang.String,​Link> links)

      • getSite

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

      • setSite

        public void setSite​(Link site)

      • getAccess

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

      • setAccess

        public void setAccess​(Access access)

      • tags

        public MetricRep tags​(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​(java.util.List<java.lang.String> tags)

      • creationDate

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

      • getCreationDate

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

      • setCreationDate

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

      • getLastModified

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

      • setLastModified

        public void setLastModified​(Modification lastModified)

      • maintainerId

        public MetricRep maintainerId​(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​(java.lang.String maintainerId)

      • getMaintainer

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

      • setMaintainer

        public void setMaintainer​(MemberSummary maintainer)

      • description

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

      • getDescription

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

      • setDescription

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

      • isNumeric

        public MetricRep isNumeric​(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​(java.lang.Boolean isNumeric)

      • getSuccessCriteria

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

      • unit

        public MetricRep unit​(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​(java.lang.String unit)

      • eventKey

        public MetricRep eventKey​(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​(java.lang.String eventKey)

      • randomizationUnits

        public MetricRep randomizationUnits​(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​(java.util.List<java.lang.String> randomizationUnits)

      • getUnitAggregationType

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

      • getAnalysisType

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

      • percentileValue

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

      • getPercentileValue

        @Nullable
public java.lang.Integer getPercentileValue()
        The percentile, an integer denoting the target percentile between 0 and 100. Only present when <code>analysisType</code> is <code>percentile</code>.
        Returns:
        percentileValue

      • setPercentileValue

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

      • getEventDefault

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

      • getExperiments

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

      • isActive

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

      • getIsActive

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

      • setIsActive

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

      • getAttachedFeatures

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

      • setAttachedFeatures

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

      • version

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

      • getVersion

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

      • setVersion

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

      • selector

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

      • getSelector

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

      • setSelector

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

      • urls

        public MetricRep urls​(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​(java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> urls)

      • 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.

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.

      • 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

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        java.io.IOException - if the JSON Object 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