com.configcat.publicapi.java.client.model

Class CodeReferenceRequest

java.lang.Object

com.configcat.publicapi.java.client.model.CodeReferenceRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-10T12:39:37.024419310Z[Etc/UTC]",
           comments="Generator version: 7.7.0")
public class CodeReferenceRequest
extends java.lang.Object

CodeReferenceRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeReferenceRequest.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashSet<java.lang.String>	openapiFields
static java.util.HashSet<java.lang.String>	openapiRequiredFields
static java.lang.String	SERIALIZED_NAME_ACTIVE_BRANCHES
static java.lang.String	SERIALIZED_NAME_BRANCH
static java.lang.String	SERIALIZED_NAME_COMMIT_HASH
static java.lang.String	SERIALIZED_NAME_COMMIT_URL
static java.lang.String	SERIALIZED_NAME_CONFIG_ID
static java.lang.String	SERIALIZED_NAME_FLAG_REFERENCES
static java.lang.String	SERIALIZED_NAME_REPOSITORY
static java.lang.String	SERIALIZED_NAME_UPLOADER

Constructor Summary

Constructors

Constructor and Description
CodeReferenceRequest()

Method Summary

Modifier and Type	Method and Description
CodeReferenceRequest	activeBranches(java.util.List<java.lang.String> activeBranches)
CodeReferenceRequest	addActiveBranchesItem(java.lang.String activeBranchesItem)
CodeReferenceRequest	addFlagReferencesItem(FlagReference flagReferencesItem)
CodeReferenceRequest	branch(java.lang.String branch)
CodeReferenceRequest	commitHash(java.lang.String commitHash)
CodeReferenceRequest	commitUrl(java.lang.String commitUrl)
CodeReferenceRequest	configId(java.util.UUID configId)
boolean	equals(java.lang.Object o)
CodeReferenceRequest	flagReferences(java.util.List<FlagReference> flagReferences)
static CodeReferenceRequest	fromJson(java.lang.String jsonString) Create an instance of CodeReferenceRequest given an JSON string
java.util.List<java.lang.String>	getActiveBranches() The currently active branches of the repository.
java.lang.String	getBranch() The source control branch on where the scan was performed.
java.lang.String	getCommitHash() The related commit's hash.
java.lang.String	getCommitUrl() The related commit's URL.
java.util.UUID	getConfigId() The Config's identifier the scanning was performed against.
java.util.List<FlagReference>	getFlagReferences() The actual code reference collection.
java.lang.String	getRepository() The source control repository that contains the scanned code.
java.lang.String	getUploader() The scanning tool's name.
int	hashCode()
CodeReferenceRequest	repository(java.lang.String repository)
void	setActiveBranches(java.util.List<java.lang.String> activeBranches)
void	setBranch(java.lang.String branch)
void	setCommitHash(java.lang.String commitHash)
void	setCommitUrl(java.lang.String commitUrl)
void	setConfigId(java.util.UUID configId)
void	setFlagReferences(java.util.List<FlagReference> flagReferences)
void	setRepository(java.lang.String repository)
void	setUploader(java.lang.String uploader)
java.lang.String	toJson() Convert an instance of CodeReferenceRequest to an JSON string
java.lang.String	toString()
CodeReferenceRequest	uploader(java.lang.String uploader)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

configId

public CodeReferenceRequest configId(java.util.UUID configId)

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)

repository

public CodeReferenceRequest repository(java.lang.String repository)

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)

branch

public CodeReferenceRequest branch(java.lang.String branch)

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)

commitUrl

public CodeReferenceRequest commitUrl(java.lang.String commitUrl)

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)

commitHash

public CodeReferenceRequest commitHash(java.lang.String commitHash)

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)

uploader

public CodeReferenceRequest uploader(java.lang.String uploader)

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)

flagReferences

public CodeReferenceRequest flagReferences(java.util.List<FlagReference> flagReferences)

addFlagReferencesItem

public CodeReferenceRequest addFlagReferencesItem(FlagReference flagReferencesItem)

getFlagReferences

@Nullable
public java.util.List<FlagReference> getFlagReferences()

The actual code reference collection.

Returns:

flagReferences

setFlagReferences

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

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