Package ai.shipeasy.admin.model

Class CreateGateTemplateRequest

java.lang.Object

ai.shipeasy.admin.model.CreateGateTemplateRequest

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

Body for `POST /api/admin/gate-templates`. Creates a per-project (customer) template. At minimum supply `name` + `rules`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateGateTemplateRequest.CategoryEnum	Gets or Sets category
static class	CreateGateTemplateRequest.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_AUTO
static final String	SERIALIZED_NAME_CATEGORY
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_ICON_KEY
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_RULES

Constructor Summary

Constructors

Constructor	Description
CreateGateTemplateRequest()

Method Summary

Modifier and Type	Method	Description
CreateGateTemplateRequest	addRulesItem(GateTemplateRule rulesItem)
CreateGateTemplateRequest	auto(Boolean auto)
CreateGateTemplateRequest	category(CreateGateTemplateRequest.CategoryEnum category)
CreateGateTemplateRequest	description(String description)
boolean	equals(Object o)
static CreateGateTemplateRequest	fromJson(String jsonString)	Create an instance of CreateGateTemplateRequest given an JSON string
Boolean	getAuto()	Mark the attribute as request-derived (resolved at the SDK edge).
CreateGateTemplateRequest.CategoryEnum	getCategory()	Get category
String	getDescription()	One-liner shown in pickers and matched by the list `query` filter.
String	getIconKey()	Display-only icon hint.
String	getName()	Human label.
List<GateTemplateRule>	getRules()	The rule definition captured by the template.
int	hashCode()
CreateGateTemplateRequest	iconKey(String iconKey)
CreateGateTemplateRequest	name(String name)
CreateGateTemplateRequest	rules(List<GateTemplateRule> rules)
void	setAuto(Boolean auto)
void	setCategory(CreateGateTemplateRequest.CategoryEnum category)
void	setDescription(String description)
void	setIconKey(String iconKey)
void	setName(String name)
void	setRules(List<GateTemplateRule> rules)
String	toJson()	Convert an instance of CreateGateTemplateRequest to an JSON string
String	toString()
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 Details

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_CATEGORY

public static final String SERIALIZED_NAME_CATEGORY

See Also:

• Constant Field Values

SERIALIZED_NAME_ICON_KEY

public static final String SERIALIZED_NAME_ICON_KEY

See Also:

• Constant Field Values

SERIALIZED_NAME_AUTO

public static final String SERIALIZED_NAME_AUTO

See Also:

• Constant Field Values

SERIALIZED_NAME_RULES

public static final String SERIALIZED_NAME_RULES

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

CreateGateTemplateRequest

public CreateGateTemplateRequest()

Method Details

name

public CreateGateTemplateRequest name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

Human label. Unique per project.

Returns:

name

setName

public void setName(@Nonnull
 String name)

description

public CreateGateTemplateRequest description(@Nullable
 String description)

getDescription

@Nullable
public String getDescription()

One-liner shown in pickers and matched by the list `query` filter.

Returns:

description

setDescription

public void setDescription(@Nullable
 String description)

category

public CreateGateTemplateRequest category(@Nullable
 CreateGateTemplateRequest.CategoryEnum category)

getCategory

@Nullable
public CreateGateTemplateRequest.CategoryEnum getCategory()

Get category

Returns:

category

setCategory

public void setCategory(@Nullable
 CreateGateTemplateRequest.CategoryEnum category)

iconKey

public CreateGateTemplateRequest iconKey(@Nullable
 String iconKey)

getIconKey

@Nullable
public String getIconKey()

Display-only icon hint.

Returns:

iconKey

setIconKey

public void setIconKey(@Nullable
 String iconKey)

auto

public CreateGateTemplateRequest auto(@Nullable
 Boolean auto)

getAuto

@Nullable
public Boolean getAuto()

Mark the attribute as request-derived (resolved at the SDK edge).

Returns:

auto

setAuto

public void setAuto(@Nullable
 Boolean auto)

rules

public CreateGateTemplateRequest rules(@Nonnull
 List<GateTemplateRule> rules)

addRulesItem

public CreateGateTemplateRequest addRulesItem(GateTemplateRule rulesItem)

getRules

@Nonnull
public List<GateTemplateRule> getRules()

The rule definition captured by the template.

Returns:

rules

setRules

public void setRules(@Nonnull
 List<GateTemplateRule> rules)

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 CreateGateTemplateRequest

fromJson

public static CreateGateTemplateRequest fromJson(String jsonString)
                                          throws IOException

Create an instance of CreateGateTemplateRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateGateTemplateRequest

Throws:

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

toJson

public String toJson()

Convert an instance of CreateGateTemplateRequest to an JSON string

Returns:

JSON string