Class Experiment


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

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

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

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

        public static final java.lang.String SERIALIZED_NAME_ENVIRONMENT_KEY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_ARCHIVED_DATE

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

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

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

        public static final java.lang.String SERIALIZED_NAME_HOLDOUT_ID
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_CURRENT_ITERATION

        public static final java.lang.String SERIALIZED_NAME_CURRENT_ITERATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_DRAFT_ITERATION

        public static final java.lang.String SERIALIZED_NAME_DRAFT_ITERATION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PREVIOUS_ITERATIONS

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

      • Experiment

        public Experiment()
    • Method Detail

      • id

        public Experiment id​(@Nullable
                             java.lang.String id)
      • getId

        @Nullable
        public java.lang.String getId()
        The experiment ID
        Returns:
        id
      • setId

        public void setId​(@Nullable
                          java.lang.String id)
      • key

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

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

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

        public Experiment name​(@Nonnull
                               java.lang.String name)
      • getName

        @Nonnull
        public java.lang.String getName()
        The experiment name
        Returns:
        name
      • setName

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

        public Experiment description​(@Nullable
                                      java.lang.String description)
      • getDescription

        @Nullable
        public java.lang.String getDescription()
        The experiment description
        Returns:
        description
      • setDescription

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

        public Experiment maintainerId​(@Nonnull
                                       java.lang.String maintainerId)
      • getMaintainerId

        @Nonnull
        public java.lang.String getMaintainerId()
        The ID of the member who maintains this experiment.
        Returns:
        maintainerId
      • setMaintainerId

        public void setMaintainerId​(@Nonnull
                                    java.lang.String maintainerId)
      • creationDate

        public Experiment 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)
      • environmentKey

        public Experiment environmentKey​(@Nonnull
                                         java.lang.String environmentKey)
      • getEnvironmentKey

        @Nonnull
        public java.lang.String getEnvironmentKey()
        Get environmentKey
        Returns:
        environmentKey
      • setEnvironmentKey

        public void setEnvironmentKey​(@Nonnull
                                      java.lang.String environmentKey)
      • archivedDate

        public Experiment archivedDate​(@Nullable
                                       java.lang.Long archivedDate)
      • getArchivedDate

        @Nullable
        public java.lang.Long getArchivedDate()
        Get archivedDate
        Returns:
        archivedDate
      • setArchivedDate

        public void setArchivedDate​(@Nullable
                                    java.lang.Long archivedDate)
      • tags

        public Experiment tags​(@Nullable
                               java.util.List<java.lang.String> tags)
      • addTagsItem

        public Experiment addTagsItem​(java.lang.String tagsItem)
      • getTags

        @Nullable
        public java.util.List<java.lang.String> getTags()
        Tags for the experiment
        Returns:
        tags
      • setTags

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

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

        public Experiment 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)
      • holdoutId

        public Experiment holdoutId​(@Nullable
                                    java.lang.String holdoutId)
      • getHoldoutId

        @Nullable
        public java.lang.String getHoldoutId()
        The holdout ID
        Returns:
        holdoutId
      • setHoldoutId

        public void setHoldoutId​(@Nullable
                                 java.lang.String holdoutId)
      • getCurrentIteration

        @Nullable
        public IterationRep getCurrentIteration()
        Get currentIteration
        Returns:
        currentIteration
      • setCurrentIteration

        public void setCurrentIteration​(@Nullable
                                        IterationRep currentIteration)
      • getDraftIteration

        @Nullable
        public IterationRep getDraftIteration()
        Get draftIteration
        Returns:
        draftIteration
      • setDraftIteration

        public void setDraftIteration​(@Nullable
                                      IterationRep draftIteration)
      • previousIterations

        public Experiment previousIterations​(@Nullable
                                             java.util.List<IterationRep> previousIterations)
      • addPreviousIterationsItem

        public Experiment addPreviousIterationsItem​(IterationRep previousIterationsItem)
      • getPreviousIterations

        @Nullable
        public java.util.List<IterationRep> getPreviousIterations()
        Details on the previous iterations for this experiment.
        Returns:
        previousIterations
      • setPreviousIterations

        public void setPreviousIterations​(@Nullable
                                          java.util.List<IterationRep> previousIterations)
      • putAdditionalProperty

        public Experiment 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 Experiment 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 Experiment
      • fromJson

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

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