Package com.configcat.publicapi.java.client.model

Class CodeReferenceRequest

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-11-07T15:32:06.171915713Z[Etc/UTC]",
           comments="Generator version: 7.7.0")
public class CodeReferenceRequest
extends java.lang.Object
    CodeReferenceRequest

    • Field Detail

      • SERIALIZED_NAME_CONFIG_ID

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

      • SERIALIZED_NAME_REPOSITORY

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

      • SERIALIZED_NAME_BRANCH

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

      • SERIALIZED_NAME_COMMIT_URL

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

      • SERIALIZED_NAME_COMMIT_HASH

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

      • SERIALIZED_NAME_UPLOADER

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

      • SERIALIZED_NAME_ACTIVE_BRANCHES

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

      • SERIALIZED_NAME_FLAG_REFERENCES

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

      • CodeReferenceRequest

        public CodeReferenceRequest()

    • Method Detail

      • getConfigId

        @Nonnull
public java.util.UUID getConfigId()
        The Config's identifier the scanning was performed against.
        Returns:
        configId

      • setConfigId

        public void setConfigId​(java.util.UUID configId)

      • getRepository

        @Nonnull
public java.lang.String getRepository()
        The source control repository that contains the scanned code. (Source of the repository selector on the ConfigCat Dashboard)
        Returns:
        repository

      • setRepository

        public void setRepository​(java.lang.String repository)

      • getBranch

        @Nonnull
public java.lang.String getBranch()
        The source control branch on where the scan was performed. (Source of the branch selector on the ConfigCat Dashboard)
        Returns:
        branch

      • setBranch

        public void setBranch​(java.lang.String branch)

      • getCommitUrl

        @Nullable
public java.lang.String getCommitUrl()
        The related commit's URL. (Appears on the ConfigCat Dashboard)
        Returns:
        commitUrl

      • setCommitUrl

        public void setCommitUrl​(java.lang.String commitUrl)

      • getCommitHash

        @Nullable
public java.lang.String getCommitHash()
        The related commit's hash. (Appears on the ConfigCat Dashboard)
        Returns:
        commitHash

      • setCommitHash

        public void setCommitHash​(java.lang.String commitHash)

      • getUploader

        @Nullable
public java.lang.String getUploader()
        The scanning tool's name. (Appears on the ConfigCat Dashboard)
        Returns:
        uploader

      • setUploader

        public void setUploader​(java.lang.String uploader)

      • activeBranches

        public CodeReferenceRequest activeBranches​(java.util.List<java.lang.String> activeBranches)

      • addActiveBranchesItem

        public CodeReferenceRequest addActiveBranchesItem​(java.lang.String activeBranchesItem)

      • getActiveBranches

        @Nullable
public java.util.List<java.lang.String> getActiveBranches()
        The currently active branches of the repository. Each previously uploaded report that belongs to a non-reported active branch is being deleted.
        Returns:
        activeBranches

      • setActiveBranches

        public void setActiveBranches​(java.util.List<java.lang.String> activeBranches)

      • getFlagReferences

        @Nullable
public java.util.List<FlagReference> getFlagReferences()
        The actual code reference collection.
        Returns:
        flagReferences

      • setFlagReferences

        public void setFlagReferences​(java.util.List<FlagReference> flagReferences)

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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