132 строки
9.1 KiB
YAML
132 строки
9.1 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath"
|
|
name: "ClientEncryptionIncludedPath"
|
|
nameWithType: "ClientEncryptionIncludedPath"
|
|
summary: "Path that needs encryption and the associated settings within <xref uid=\"com.azure.cosmos.models.ClientEncryptionPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientEncryptionPolicy\"></xref>."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **ClientEncryptionIncludedPath**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath.ClientEncryptionIncludedPath()"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath.ClientEncryptionIncludedPath()"
|
|
name: "ClientEncryptionIncludedPath()"
|
|
nameWithType: "ClientEncryptionIncludedPath.ClientEncryptionIncludedPath()"
|
|
syntax: "public ClientEncryptionIncludedPath()"
|
|
methods:
|
|
- uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath.getClientEncryptionKeyId()"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath.getClientEncryptionKeyId()"
|
|
name: "getClientEncryptionKeyId()"
|
|
nameWithType: "ClientEncryptionIncludedPath.getClientEncryptionKeyId()"
|
|
summary: "Gets the identifier of the Data Encryption Key to be used to encrypt the path."
|
|
syntax: "public String getClientEncryptionKeyId()"
|
|
desc: "Gets the identifier of the Data Encryption Key to be used to encrypt the path."
|
|
returns:
|
|
description: "clientEncryptionKeyId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath.getEncryptionAlgorithm()"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath.getEncryptionAlgorithm()"
|
|
name: "getEncryptionAlgorithm()"
|
|
nameWithType: "ClientEncryptionIncludedPath.getEncryptionAlgorithm()"
|
|
summary: "Gets the type of encryption algorithm to be performed."
|
|
syntax: "public String getEncryptionAlgorithm()"
|
|
desc: "Gets the type of encryption algorithm to be performed. Eg - AEAD\\_AES\\_256\\_CBC\\_HMAC\\_SHA256."
|
|
returns:
|
|
description: "encryptionAlgorithm"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath.getEncryptionType()"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath.getEncryptionType()"
|
|
name: "getEncryptionType()"
|
|
nameWithType: "ClientEncryptionIncludedPath.getEncryptionType()"
|
|
summary: "Gets the type of encryption to be performed."
|
|
syntax: "public String getEncryptionType()"
|
|
desc: "Gets the type of encryption to be performed. Egs.: Deterministic Randomized."
|
|
returns:
|
|
description: "encryptionType"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath.getPath()"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath.getPath()"
|
|
name: "getPath()"
|
|
nameWithType: "ClientEncryptionIncludedPath.getPath()"
|
|
summary: "Gets the path to be encrypted."
|
|
syntax: "public String getPath()"
|
|
desc: "Gets the path to be encrypted. Must be a top level path, eg. /salary."
|
|
returns:
|
|
description: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath.setClientEncryptionKeyId(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath.setClientEncryptionKeyId(String clientEncryptionKeyId)"
|
|
name: "setClientEncryptionKeyId(String clientEncryptionKeyId)"
|
|
nameWithType: "ClientEncryptionIncludedPath.setClientEncryptionKeyId(String clientEncryptionKeyId)"
|
|
summary: "Sets the identifier of the Data Encryption Key to be used to encrypt the path."
|
|
parameters:
|
|
- description: "identifier of the Data Encryption Key"
|
|
name: "clientEncryptionKeyId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClientEncryptionIncludedPath setClientEncryptionKeyId(String clientEncryptionKeyId)"
|
|
desc: "Sets the identifier of the Data Encryption Key to be used to encrypt the path."
|
|
returns:
|
|
description: "ClientEncryptionIncludedPath."
|
|
type: "<xref href=\"com.azure.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath.setEncryptionAlgorithm(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath.setEncryptionAlgorithm(String encryptionAlgorithm)"
|
|
name: "setEncryptionAlgorithm(String encryptionAlgorithm)"
|
|
nameWithType: "ClientEncryptionIncludedPath.setEncryptionAlgorithm(String encryptionAlgorithm)"
|
|
summary: "Sets the type of encryption algorithm to be performed."
|
|
parameters:
|
|
- description: "type of encryption algorithm"
|
|
name: "encryptionAlgorithm"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClientEncryptionIncludedPath setEncryptionAlgorithm(String encryptionAlgorithm)"
|
|
desc: "Sets the type of encryption algorithm to be performed. Eg - AEAD\\_AES\\_256\\_CBC\\_HMAC\\_SHA256."
|
|
returns:
|
|
description: "ClientEncryptionIncludedPath."
|
|
type: "<xref href=\"com.azure.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath.setEncryptionType(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath.setEncryptionType(String encryptionType)"
|
|
name: "setEncryptionType(String encryptionType)"
|
|
nameWithType: "ClientEncryptionIncludedPath.setEncryptionType(String encryptionType)"
|
|
summary: "Sets the type of encryption to be performed."
|
|
parameters:
|
|
- description: "type of encryption"
|
|
name: "encryptionType"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClientEncryptionIncludedPath setEncryptionType(String encryptionType)"
|
|
desc: "Sets the type of encryption to be performed. Egs.: Deterministic Randomized."
|
|
returns:
|
|
description: "ClientEncryptionIncludedPath."
|
|
type: "<xref href=\"com.azure.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ClientEncryptionIncludedPath.setPath(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.ClientEncryptionIncludedPath.setPath(String path)"
|
|
name: "setPath(String path)"
|
|
nameWithType: "ClientEncryptionIncludedPath.setPath(String path)"
|
|
summary: "Sets the path to be encrypted."
|
|
parameters:
|
|
- description: "path to be encrypted"
|
|
name: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ClientEncryptionIncludedPath setPath(String path)"
|
|
desc: "Sets the path to be encrypted. Must be a top level path, eg. /salary."
|
|
returns:
|
|
description: "ClientEncryptionIncludedPath."
|
|
type: "<xref href=\"com.azure.cosmos.models.ClientEncryptionIncludedPath?alt=com.azure.cosmos.models.ClientEncryptionIncludedPath&text=ClientEncryptionIncludedPath\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Path that needs encryption and the associated settings within <xref uid=\"com.azure.cosmos.models.ClientEncryptionPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientEncryptionPolicy\"></xref>."
|
|
metadata: {}
|
|
package: "com.azure.cosmos.models"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|