Client SDK Version 1.8.0
Ionic Security client SDK for Python users
Public Member Functions | Public Attributes | List of all members
ionicsdk.filecipher.FileCipherEncryptAttributes Class Reference

Allows for extended input and output options during encryption. More...

Inheritance diagram for ionicsdk.filecipher.FileCipherEncryptAttributes:

Public Member Functions

def __init__ (self, attributes=None, metadata=None, version=None, mutableAttributes=None, enablePortionMarking=False)
 Constructs encrypt attributes from passed in arguments. More...
 

Public Attributes

 keyidOut
 (string) The key ID (also known as the key tag)
 
 keydataOut
 (KeyData) The key bytes
 
 familyOut
 (FileCipherFamily) The file cipher family the file was encrypted with
 
 version
 (string) The file format version to encrypt with - It can be left empty to use the latest version (recommended).
 
 attributes
 (agent::KeyAttributesDict) The key attributes to associate with the key used to encrypt the file
 
 mutableAttributes
 (agent::KeyAttributesDict) The key mutable attributes to associate with data chunk protection key
 
 metadata
 (agent::MetadataDict) The metadata properties to send along with the HTTP request
 
 enablePortionMarking
 (boolean) Determines if portion marking is enabled.
 

Detailed Description

Allows for extended input and output options during encryption.

Constructor & Destructor Documentation

◆ __init__()

def ionicsdk.filecipher.FileCipherEncryptAttributes.__init__ (   self,
  attributes = None,
  metadata = None,
  version = None,
  mutableAttributes = None,
  enablePortionMarking = False 
)

Constructs encrypt attributes from passed in arguments.

Parameters
attributes(agent::KeyAttributesDict) The key attributes to associate with the key used to encrypt the file
metadata(agent::MetadataDict) The metadata properties to send along with the HTTP request
version(string) The file format version to encrypt with - It can be left empty to use the latest version (recommended).
mutableAttributes(agent::KeyAttributesDict) The key mutable attributes to associate with data chunk protection key
enablePortionMarking(boolean) Determines if portion marking is enabled.

The documentation for this class was generated from the following file: