ClientEncryptionIncludedPath Class

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.46.0

• java.lang.Object
• • com.azure.resourcemanager.cosmos.models.ClientEncryptionIncludedPath

Implements

JsonSerializable<ClientEncryptionIncludedPath>

public final class ClientEncryptionIncludedPath
implements JsonSerializable<ClientEncryptionIncludedPath>

.

Constructor Summary

Constructor	Description
ClientEncryptionIncludedPath()	Creates an instance of ClientEncryptionIncludedPath class.

Method Summary

Modifier and Type	Method and Description
String	clientEncryptionKeyId() Get the clientEncryptionKeyId property: The identifier of the Client Encryption Key to be used to encrypt the path.
String	encryptionAlgorithm() Get the encryptionAlgorithm property: The encryption algorithm which will be used.
String	encryptionType() Get the encryptionType property: The type of encryption to be performed.
static ClientEncryptionIncludedPath	fromJson(JsonReader jsonReader) Reads an instance of ClientEncryptionIncludedPath from the JsonReader.
String	path() Get the path property: Path that needs to be encrypted.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
ClientEncryptionIncludedPath	withClientEncryptionKeyId(String clientEncryptionKeyId) Set the clientEncryptionKeyId property: The identifier of the Client Encryption Key to be used to encrypt the path.
ClientEncryptionIncludedPath	withEncryptionAlgorithm(String encryptionAlgorithm) Set the encryptionAlgorithm property: The encryption algorithm which will be used.
ClientEncryptionIncludedPath	withEncryptionType(String encryptionType) Set the encryptionType property: The type of encryption to be performed.
ClientEncryptionIncludedPath	withPath(String path) Set the path property: Path that needs to be encrypted.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ClientEncryptionIncludedPath

public ClientEncryptionIncludedPath()

Creates an instance of ClientEncryptionIncludedPath class.

Method Details

clientEncryptionKeyId

public String clientEncryptionKeyId()

Get the clientEncryptionKeyId property: The identifier of the Client Encryption Key to be used to encrypt the path.

Returns:

the clientEncryptionKeyId value.

encryptionAlgorithm

public String encryptionAlgorithm()

Get the encryptionAlgorithm property: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.

Returns:

the encryptionAlgorithm value.

encryptionType

public String encryptionType()

Get the encryptionType property: The type of encryption to be performed. Eg - Deterministic, Randomized.

Returns:

the encryptionType value.

fromJson

public static ClientEncryptionIncludedPath fromJson(JsonReader jsonReader)

Reads an instance of ClientEncryptionIncludedPath from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ClientEncryptionIncludedPath if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

path

public String path()

Get the path property: Path that needs to be encrypted.

Returns:

the path value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withClientEncryptionKeyId

public ClientEncryptionIncludedPath withClientEncryptionKeyId(String clientEncryptionKeyId)

Set the clientEncryptionKeyId property: The identifier of the Client Encryption Key to be used to encrypt the path.

Parameters:

clientEncryptionKeyId - the clientEncryptionKeyId value to set.

Returns:

the ClientEncryptionIncludedPath object itself.

withEncryptionAlgorithm

public ClientEncryptionIncludedPath withEncryptionAlgorithm(String encryptionAlgorithm)

Set the encryptionAlgorithm property: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.

Parameters:

encryptionAlgorithm - the encryptionAlgorithm value to set.

Returns:

the ClientEncryptionIncludedPath object itself.

withEncryptionType

public ClientEncryptionIncludedPath withEncryptionType(String encryptionType)

Set the encryptionType property: The type of encryption to be performed. Eg - Deterministic, Randomized.

Parameters:

encryptionType - the encryptionType value to set.

Returns:

the ClientEncryptionIncludedPath object itself.

withPath

public ClientEncryptionIncludedPath withPath(String path)

Set the path property: Path that needs to be encrypted.

Parameters:

path - the path value to set.

Returns:

the ClientEncryptionIncludedPath object itself.