com.configcat.publicapi.java.client.model

Class CodeReferenceModel

java.lang.Object

com.configcat.publicapi.java.client.model.CodeReferenceModel

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-02-20T16:55:24.304297906Z[Etc/UTC]",
           comments="Generator version: 7.7.0")
public class CodeReferenceModel
extends java.lang.Object

CodeReferenceModel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeReferenceModel.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_BRANCH
static java.lang.String	SERIALIZED_NAME_CODE_REFERENCE_ID
static java.lang.String	SERIALIZED_NAME_COMMIT_HASH
static java.lang.String	SERIALIZED_NAME_COMMIT_URL
static java.lang.String	SERIALIZED_NAME_REFERENCES
static java.lang.String	SERIALIZED_NAME_REPOSITORY
static java.lang.String	SERIALIZED_NAME_SYNCED_AT
static java.lang.String	SERIALIZED_NAME_UPLOADER

Constructor Summary

Constructors

Constructor and Description
CodeReferenceModel()

Method Summary

Modifier and Type	Method and Description
CodeReferenceModel	addReferencesItem(ReferenceLines referencesItem)
CodeReferenceModel	branch(java.lang.String branch)
CodeReferenceModel	codeReferenceId(java.util.UUID codeReferenceId)
CodeReferenceModel	commitHash(java.lang.String commitHash)
CodeReferenceModel	commitUrl(java.lang.String commitUrl)
boolean	equals(java.lang.Object o)
static CodeReferenceModel	fromJson(java.lang.String jsonString) Create an instance of CodeReferenceModel given an JSON string
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties() Return the additional (undeclared) property.
java.lang.Object	getAdditionalProperty(java.lang.String key) Return the additional (undeclared) property with the specified name.
java.lang.String	getBranch() The source control branch on where the scan was performed.
java.util.UUID	getCodeReferenceId() The identifier of the reference report.
java.lang.String	getCommitHash() The related commit's hash.
java.lang.String	getCommitUrl() The related commit's URL.
java.util.List<ReferenceLines>	getReferences() The actual references to the given Feature Flag or Setting.
java.lang.String	getRepository() The source control repository that contains the scanned code.
java.time.OffsetDateTime	getSyncedAt() The date and time when the reference report was uploaded.
java.lang.String	getUploader() The code reference scanning tool's name.
int	hashCode()
CodeReferenceModel	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
CodeReferenceModel	references(java.util.List<ReferenceLines> references)
CodeReferenceModel	repository(java.lang.String repository)
void	setBranch(java.lang.String branch)
void	setCodeReferenceId(java.util.UUID codeReferenceId)
void	setCommitHash(java.lang.String commitHash)
void	setCommitUrl(java.lang.String commitUrl)
void	setReferences(java.util.List<ReferenceLines> references)
void	setRepository(java.lang.String repository)
void	setSyncedAt(java.time.OffsetDateTime syncedAt)
void	setUploader(java.lang.String uploader)
CodeReferenceModel	syncedAt(java.time.OffsetDateTime syncedAt)
java.lang.String	toJson() Convert an instance of CodeReferenceModel to an JSON string
java.lang.String	toString()
CodeReferenceModel	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_BRANCH

public static final java.lang.String SERIALIZED_NAME_BRANCH

See Also:

Constant Field Values

SERIALIZED_NAME_REFERENCES

public static final java.lang.String SERIALIZED_NAME_REFERENCES

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_SYNCED_AT

public static final java.lang.String SERIALIZED_NAME_SYNCED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_REPOSITORY

public static final java.lang.String SERIALIZED_NAME_REPOSITORY

See Also:

Constant Field Values

SERIALIZED_NAME_CODE_REFERENCE_ID

public static final java.lang.String SERIALIZED_NAME_CODE_REFERENCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_UPLOADER

public static final java.lang.String SERIALIZED_NAME_UPLOADER

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

CodeReferenceModel

public CodeReferenceModel()

Method Detail

branch

public CodeReferenceModel branch(java.lang.String branch)

getBranch

@Nullable
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)

references

public CodeReferenceModel references(java.util.List<ReferenceLines> references)

addReferencesItem

public CodeReferenceModel addReferencesItem(ReferenceLines referencesItem)

getReferences

@Nullable
public java.util.List<ReferenceLines> getReferences()

The actual references to the given Feature Flag or Setting.

Returns:

references

setReferences

public void setReferences(java.util.List<ReferenceLines> references)

commitUrl

public CodeReferenceModel commitUrl(java.lang.String commitUrl)

getCommitUrl

@Nullable
public java.lang.String getCommitUrl()

The related commit's URL.

Returns:

commitUrl

setCommitUrl

public void setCommitUrl(java.lang.String commitUrl)

commitHash

public CodeReferenceModel commitHash(java.lang.String commitHash)

getCommitHash

@Nullable
public java.lang.String getCommitHash()

The related commit's hash.

Returns:

commitHash

setCommitHash

public void setCommitHash(java.lang.String commitHash)

syncedAt

public CodeReferenceModel syncedAt(java.time.OffsetDateTime syncedAt)

getSyncedAt

@Nullable
public java.time.OffsetDateTime getSyncedAt()

The date and time when the reference report was uploaded.

Returns:

syncedAt

setSyncedAt

public void setSyncedAt(java.time.OffsetDateTime syncedAt)

repository

public CodeReferenceModel repository(java.lang.String repository)

getRepository

@Nullable
public java.lang.String getRepository()

The source control repository that contains the scanned code.

Returns:

repository

setRepository

public void setRepository(java.lang.String repository)

codeReferenceId

public CodeReferenceModel codeReferenceId(java.util.UUID codeReferenceId)

getCodeReferenceId

@Nullable
public java.util.UUID getCodeReferenceId()

The identifier of the reference report.

Returns:

codeReferenceId

setCodeReferenceId

public void setCodeReferenceId(java.util.UUID codeReferenceId)

uploader

public CodeReferenceModel uploader(java.lang.String uploader)

getUploader

@Nullable
public java.lang.String getUploader()

The code reference scanning tool's name.

Returns:

uploader

setUploader

public void setUploader(java.lang.String uploader)

putAdditionalProperty

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

fromJson

public static CodeReferenceModel fromJson(java.lang.String jsonString)
                                   throws java.io.IOException

Create an instance of CodeReferenceModel given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CodeReferenceModel

Throws:

java.io.IOException - if the JSON string is invalid with respect to CodeReferenceModel

toJson

public java.lang.String toJson()

Convert an instance of CodeReferenceModel to an JSON string

Returns:

JSON string