org.openapitools.client.model

Class ServerlessSpec

java.lang.Object

org.openapitools.client.model.ServerlessSpec

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-04-06T02:44:17.986783Z[Etc/UTC]")
public class ServerlessSpec
extends java.lang.Object

Configuration needed to deploy a serverless index.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerlessSpec.CloudEnum The public cloud where you would like your index hosted.
static class	ServerlessSpec.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_CLOUD
static java.lang.String	SERIALIZED_NAME_REGION

Constructor Summary

Constructors

Constructor and Description
ServerlessSpec()

Method Summary

Modifier and Type	Method and Description
ServerlessSpec	cloud(ServerlessSpec.CloudEnum cloud)
boolean	equals(java.lang.Object o)
static ServerlessSpec	fromJson(java.lang.String jsonString) Create an instance of ServerlessSpec 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.
ServerlessSpec.CloudEnum	getCloud() The public cloud where you would like your index hosted.
java.lang.String	getRegion() The region where you would like your index to be created.
int	hashCode()
ServerlessSpec	putAdditionalProperty(java.lang.String key, java.lang.Object value) Set the additional (undeclared) property with the specified name and value.
ServerlessSpec	region(java.lang.String region)
void	setCloud(ServerlessSpec.CloudEnum cloud)
void	setRegion(java.lang.String region)
java.lang.String	toJson() Convert an instance of ServerlessSpec to an JSON string
java.lang.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 Detail

SERIALIZED_NAME_CLOUD

public static final java.lang.String SERIALIZED_NAME_CLOUD

See Also:

Constant Field Values

SERIALIZED_NAME_REGION

public static final java.lang.String SERIALIZED_NAME_REGION

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

ServerlessSpec

public ServerlessSpec()

Method Detail

cloud

public ServerlessSpec cloud(ServerlessSpec.CloudEnum cloud)

getCloud

@Nonnull
public ServerlessSpec.CloudEnum getCloud()

The public cloud where you would like your index hosted. Serverless indexes can be hosted only in AWS at this time.

Returns:

cloud

setCloud

public void setCloud(ServerlessSpec.CloudEnum cloud)

region

public ServerlessSpec region(java.lang.String region)

getRegion

@Nonnull
public java.lang.String getRegion()

The region where you would like your index to be created. Serverless indexes can be created only in the us-west-2 and us-east-1 regions of AWS at this time.

Returns:

region

setRegion

public void setRegion(java.lang.String region)

putAdditionalProperty

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

fromJson

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

Create an instance of ServerlessSpec given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ServerlessSpec

Throws:

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

toJson

public java.lang.String toJson()

Convert an instance of ServerlessSpec to an JSON string

Returns:

JSON string