Package com.exoscale.sdk.model

Class CreateKmsKeyRequest

java.lang.Object

com.exoscale.sdk.model.CreateKmsKeyRequest

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

CreateKmsKeyRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateKmsKeyRequest.KeySpecEnum	The cryptographic key specification defining the key's algorithm and, for asymmetric keys, its curve or modulus size.
static enum	CreateKmsKeyRequest.SourceEnum	Indicates the source of the key material, either generated and held within Exoscale KMS, or backed by an external key store.
static enum	CreateKmsKeyRequest.UsageEnum	Gets or Sets usage

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_KEY_SPEC
static final String	JSON_PROPERTY_MULTI_ZONE
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_SOURCE
static final String	JSON_PROPERTY_USAGE
static final String	JSON_PROPERTY_XKS

Constructor Summary

Constructors

Constructor	Description
CreateKmsKeyRequest()

Method Summary

Modifier and Type	Method	Description
CreateKmsKeyRequest	description(String description)
boolean	equals(Object o)	Return true if this create-kms-key-request object is equal to o.
String	getDescription()	An optional detailed description providing additional context about the key's intended use case.
CreateKmsKeyRequest.KeySpecEnum	getKeySpec()	The cryptographic key specification defining the key's algorithm and, for asymmetric keys, its curve or modulus size.
Boolean	getMultiZone()	True if this is a multi-zone key.
String	getName()	A human-readable display name uniquely identifying the KMS key within the tenant space.
CreateKmsKeyRequest.SourceEnum	getSource()	Indicates the source of the key material, either generated and held within Exoscale KMS, or backed by an external key store.
CreateKmsKeyRequest.UsageEnum	getUsage()	Get usage
XksKey	getXks()	Get xks
int	hashCode()
CreateKmsKeyRequest	keySpec(CreateKmsKeyRequest.KeySpecEnum keySpec)
CreateKmsKeyRequest	multiZone(Boolean multiZone)
CreateKmsKeyRequest	name(String name)
void	setDescription(String description)
void	setKeySpec(CreateKmsKeyRequest.KeySpecEnum keySpec)
void	setMultiZone(Boolean multiZone)
void	setName(String name)
void	setSource(CreateKmsKeyRequest.SourceEnum source)
void	setUsage(CreateKmsKeyRequest.UsageEnum usage)
void	setXks(XksKey xks)
CreateKmsKeyRequest	source(CreateKmsKeyRequest.SourceEnum source)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
CreateKmsKeyRequest	usage(CreateKmsKeyRequest.UsageEnum usage)
CreateKmsKeyRequest	xks(XksKey xks)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_USAGE

public static final String JSON_PROPERTY_USAGE

See Also:

• Constant Field Values

JSON_PROPERTY_KEY_SPEC

public static final String JSON_PROPERTY_KEY_SPEC

See Also:

• Constant Field Values

JSON_PROPERTY_MULTI_ZONE

public static final String JSON_PROPERTY_MULTI_ZONE

See Also:

• Constant Field Values

JSON_PROPERTY_SOURCE

public static final String JSON_PROPERTY_SOURCE

See Also:

• Constant Field Values

JSON_PROPERTY_XKS

public static final String JSON_PROPERTY_XKS

See Also:

• Constant Field Values

Constructor Details

CreateKmsKeyRequest

public CreateKmsKeyRequest()

Method Details

name

public CreateKmsKeyRequest name(String name)

getName

@Nonnull
public String getName()

A human-readable display name uniquely identifying the KMS key within the tenant space.

Returns:

name

setName

public void setName(String name)

description

public CreateKmsKeyRequest description(String description)

getDescription

@Nullable
public String getDescription()

An optional detailed description providing additional context about the key's intended use case.

Returns:

description

setDescription

public void setDescription(String description)

usage

public CreateKmsKeyRequest usage(CreateKmsKeyRequest.UsageEnum usage)

getUsage

@Nullable
public CreateKmsKeyRequest.UsageEnum getUsage()

Get usage

Returns:

usage

setUsage

public void setUsage(CreateKmsKeyRequest.UsageEnum usage)

keySpec

public CreateKmsKeyRequest keySpec(CreateKmsKeyRequest.KeySpecEnum keySpec)

getKeySpec

@Nullable
public CreateKmsKeyRequest.KeySpecEnum getKeySpec()

The cryptographic key specification defining the key's algorithm and, for asymmetric keys, its curve or modulus size.

Returns:

keySpec

setKeySpec

public void setKeySpec(CreateKmsKeyRequest.KeySpecEnum keySpec)

multiZone

public CreateKmsKeyRequest multiZone(Boolean multiZone)

getMultiZone

@Nullable
public Boolean getMultiZone()

True if this is a multi-zone key.

Returns:

multiZone

setMultiZone

public void setMultiZone(Boolean multiZone)

source

public CreateKmsKeyRequest source(CreateKmsKeyRequest.SourceEnum source)

getSource

@Nullable
public CreateKmsKeyRequest.SourceEnum getSource()

Indicates the source of the key material, either generated and held within Exoscale KMS, or backed by an external key store.

Returns:

source

setSource

public void setSource(CreateKmsKeyRequest.SourceEnum source)

xks

public CreateKmsKeyRequest xks(XksKey xks)

getXks

@Nullable
public XksKey getXks()

Get xks

Returns:

xks

setXks

public void setXks(XksKey xks)

equals

public boolean equals(Object o)

Return true if this create-kms-key-request object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string