Class ClientEncryptionIncludedPath
java.lang.Object
com.azure.resourcemanager.cosmos.models.ClientEncryptionIncludedPath
- All Implemented Interfaces:
com.azure.json.JsonSerializable<ClientEncryptionIncludedPath>
public final class ClientEncryptionIncludedPath
extends Object
implements com.azure.json.JsonSerializable<ClientEncryptionIncludedPath>
.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of ClientEncryptionIncludedPath class. -
Method Summary
Modifier and TypeMethodDescriptionGet the clientEncryptionKeyId property: The identifier of the Client Encryption Key to be used to encrypt the path.Get the encryptionAlgorithm property: The encryption algorithm which will be used.Get the encryptionType property: The type of encryption to be performed.static ClientEncryptionIncludedPath
fromJson
(com.azure.json.JsonReader jsonReader) Reads an instance of ClientEncryptionIncludedPath from the JsonReader.path()
Get the path property: Path that needs to be encrypted.com.azure.json.JsonWriter
toJson
(com.azure.json.JsonWriter jsonWriter) void
validate()
Validates the instance.withClientEncryptionKeyId
(String clientEncryptionKeyId) Set the clientEncryptionKeyId property: The identifier of the Client Encryption Key to be used to encrypt the path.withEncryptionAlgorithm
(String encryptionAlgorithm) Set the encryptionAlgorithm property: The encryption algorithm which will be used.withEncryptionType
(String encryptionType) Set the encryptionType property: The type of encryption to be performed.Set the path property: Path that needs to be encrypted.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
ClientEncryptionIncludedPath
public ClientEncryptionIncludedPath()Creates an instance of ClientEncryptionIncludedPath class.
-
-
Method Details
-
path
Get the path property: Path that needs to be encrypted.- Returns:
- the path value.
-
withPath
Set the path property: Path that needs to be encrypted.- Parameters:
path
- the path value to set.- Returns:
- the ClientEncryptionIncludedPath object itself.
-
clientEncryptionKeyId
Get the clientEncryptionKeyId property: The identifier of the Client Encryption Key to be used to encrypt the path.- Returns:
- the clientEncryptionKeyId value.
-
withClientEncryptionKeyId
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.
-
encryptionType
Get the encryptionType property: The type of encryption to be performed. Eg - Deterministic, Randomized.- Returns:
- the encryptionType value.
-
withEncryptionType
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.
-
encryptionAlgorithm
Get the encryptionAlgorithm property: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.- Returns:
- the encryptionAlgorithm value.
-
withEncryptionAlgorithm
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.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
toJson
- Specified by:
toJson
in interfacecom.azure.json.JsonSerializable<ClientEncryptionIncludedPath>
- Throws:
IOException
-
fromJson
public static ClientEncryptionIncludedPath fromJson(com.azure.json.JsonReader jsonReader) throws IOException 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:
IllegalStateException
- If the deserialized JSON object was missing any required properties.IOException
- If an error occurs while reading the ClientEncryptionIncludedPath.
-