Package ai.shipeasy.admin.model

Class GetConfigResponse

java.lang.Object

ai.shipeasy.admin.model.GetConfigResponse

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class GetConfigResponse
extends Object

GetConfigResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetConfigResponse.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_DRAFT_VALUES
static final String	SERIALIZED_NAME_DRAFTS
static final String	SERIALIZED_NAME_ENVS
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_SCHEMA
static final String	SERIALIZED_NAME_UPDATED_AT
static final String	SERIALIZED_NAME_VALUES

Constructor Summary

Constructors

Constructor	Description
GetConfigResponse()

Method Summary

Modifier and Type	Method	Description
GetConfigResponse	description(String description)
GetConfigResponse	drafts(Map<String,ListConfigsResponseDataInnerDraftsValue> drafts)
GetConfigResponse	draftValues(Map<String,Object> draftValues)
GetConfigResponse	envs(Map<String,ListConfigsResponseDataInnerEnvsValue> envs)
boolean	equals(Object o)
static GetConfigResponse	fromJson(String jsonString)	Create an instance of GetConfigResponse given an JSON string
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
String	getDescription()	Get description
Map<String,ListConfigsResponseDataInnerDraftsValue>	getDrafts()	Per-env active drafts (if any).
Map<String,Object>	getDraftValues()	Per-env draft values (only returned by `GET /{id}`).
Map<String,ListConfigsResponseDataInnerEnvsValue>	getEnvs()	Per-env latest published version metadata.
String	getId()	Stable opaque config id (`cfg_…`).
String	getName()	Stable config key in `folder.name` form (two lowercase segments separated by a dot, e.g.
Map<String,Object>	getSchema()	JSON Schema (draft 2020-12) describing the shape of the config value.
String	getUpdatedAt()	ISO-8601 timestamp of last mutation.
Map<String,Object>	getValues()	Per-env latest published values (only returned by `GET /{id}`, not list).
int	hashCode()
GetConfigResponse	id(String id)
GetConfigResponse	name(String name)
GetConfigResponse	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
GetConfigResponse	putDraftsItem(String key, ListConfigsResponseDataInnerDraftsValue draftsItem)
GetConfigResponse	putDraftValuesItem(String key, Object draftValuesItem)
GetConfigResponse	putEnvsItem(String key, ListConfigsResponseDataInnerEnvsValue envsItem)
GetConfigResponse	putSchemaItem(String key, Object schemaItem)
GetConfigResponse	putValuesItem(String key, Object valuesItem)
GetConfigResponse	schema(Map<String,Object> schema)
void	setDescription(String description)
void	setDrafts(Map<String,ListConfigsResponseDataInnerDraftsValue> drafts)
void	setDraftValues(Map<String,Object> draftValues)
void	setEnvs(Map<String,ListConfigsResponseDataInnerEnvsValue> envs)
void	setId(String id)
void	setName(String name)
void	setSchema(Map<String,Object> schema)
void	setUpdatedAt(String updatedAt)
void	setValues(Map<String,Object> values)
String	toJson()	Convert an instance of GetConfigResponse to an JSON string
String	toString()
GetConfigResponse	updatedAt(String updatedAt)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found
GetConfigResponse	values(Map<String,Object> values)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_SCHEMA

public static final String SERIALIZED_NAME_SCHEMA

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_ENVS

public static final String SERIALIZED_NAME_ENVS

See Also:

• Constant Field Values

SERIALIZED_NAME_DRAFTS

public static final String SERIALIZED_NAME_DRAFTS

See Also:

• Constant Field Values

SERIALIZED_NAME_VALUES

public static final String SERIALIZED_NAME_VALUES

See Also:

• Constant Field Values

SERIALIZED_NAME_DRAFT_VALUES

public static final String SERIALIZED_NAME_DRAFT_VALUES

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

GetConfigResponse

public GetConfigResponse()

Method Details

id

public GetConfigResponse id(@Nonnull
 String id)

getId

@Nonnull
public String getId()

Stable opaque config id (`cfg_…`).

Returns:

id

setId

public void setId(@Nonnull
 String id)

name

public GetConfigResponse name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

Stable config key in `folder.name` form (two lowercase segments separated by a dot, e.g. `pricing.tiers`). Used by SDKs as `Shipeasy.getConfig('<name>')`. Immutable after create.

Returns:

name

setName

public void setName(@Nonnull
 String name)

description

public GetConfigResponse description(@Nullable
 String description)

getDescription

@Nullable
public String getDescription()

Get description

Returns:

description

setDescription

public void setDescription(@Nullable
 String description)

schema

public GetConfigResponse schema(@Nonnull
 Map<String,Object> schema)

putSchemaItem

public GetConfigResponse putSchemaItem(String key,
 Object schemaItem)

getSchema

@Nonnull
public Map<String,Object> getSchema()

JSON Schema (draft 2020-12) describing the shape of the config value. Top-level `type` must be `'object'`; every published value is validated against this schema.

Returns:

schema

setSchema

public void setSchema(@Nonnull
 Map<String,Object> schema)

updatedAt

public GetConfigResponse updatedAt(@Nonnull
 String updatedAt)

getUpdatedAt

@Nonnull
public String getUpdatedAt()

ISO-8601 timestamp of last mutation.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(@Nonnull
 String updatedAt)

envs

public GetConfigResponse envs(@Nonnull
 Map<String,ListConfigsResponseDataInnerEnvsValue> envs)

putEnvsItem

public GetConfigResponse putEnvsItem(String key,
 ListConfigsResponseDataInnerEnvsValue envsItem)

getEnvs

@Nonnull
public Map<String,ListConfigsResponseDataInnerEnvsValue> getEnvs()

Per-env latest published version metadata.

Returns:

envs

setEnvs

public void setEnvs(@Nonnull
 Map<String,ListConfigsResponseDataInnerEnvsValue> envs)

drafts

public GetConfigResponse drafts(@Nonnull
 Map<String,ListConfigsResponseDataInnerDraftsValue> drafts)

putDraftsItem

public GetConfigResponse putDraftsItem(String key,
 ListConfigsResponseDataInnerDraftsValue draftsItem)

getDrafts

@Nonnull
public Map<String,ListConfigsResponseDataInnerDraftsValue> getDrafts()

Per-env active drafts (if any).

Returns:

drafts

setDrafts

public void setDrafts(@Nonnull
 Map<String,ListConfigsResponseDataInnerDraftsValue> drafts)

values

public GetConfigResponse values(@Nullable
 Map<String,Object> values)

putValuesItem

public GetConfigResponse putValuesItem(String key,
 Object valuesItem)

getValues

@Nullable
public Map<String,Object> getValues()

Per-env latest published values (only returned by `GET /{id}`, not list).

Returns:

values

setValues

public void setValues(@Nullable
 Map<String,Object> values)

draftValues

public GetConfigResponse draftValues(@Nullable
 Map<String,Object> draftValues)

putDraftValuesItem

public GetConfigResponse putDraftValuesItem(String key,
 Object draftValuesItem)

getDraftValues

@Nullable
public Map<String,Object> getDraftValues()

Per-env draft values (only returned by `GET /{id}`).

Returns:

draftValues

setDraftValues

public void setDraftValues(@Nullable
 Map<String,Object> draftValues)

putAdditionalProperty

public GetConfigResponse putAdditionalProperty(String key,
 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 GetConfigResponse instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to GetConfigResponse

fromJson

public static GetConfigResponse fromJson(String jsonString)
                                  throws IOException

Create an instance of GetConfigResponse given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of GetConfigResponse

Throws:

IOException - if the JSON string is invalid with respect to GetConfigResponse

toJson

public String toJson()

Convert an instance of GetConfigResponse to an JSON string

Returns:

JSON string