Skip to content

Latest commit

 

History

History
285 lines (154 loc) · 7.6 KB

Encrypt.md

File metadata and controls

285 lines (154 loc) · 7.6 KB

Encrypt

Properties

Name Type Description Notes
DisplayId Pointer to string The display id of the key to use in the encryption process [optional]
EncryptionContext Pointer to map[string]string name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the decrypt command or decryption will fail [optional]
InputFormat Pointer to string Select default assumed format for any plaintext input. Currently supported options: [base64] [optional]
ItemId Pointer to int64 The item id of the key to use in the encryption process [optional]
Json Pointer to bool Set output format to JSON [optional] [default to false]
KeyName string The name of the key to use in the encryption process
Plaintext Pointer to string Data to be encrypted [optional]
Token Pointer to string Authentication token (see `/auth` and `/configure`) [optional]
UidToken Pointer to string The universal identity token, Required only for universal_identity authentication [optional]
Version Pointer to int32 key version (relevant only for classic key) [optional]

Methods

NewEncrypt

func NewEncrypt(keyName string, ) *Encrypt

NewEncrypt instantiates a new Encrypt object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewEncryptWithDefaults

func NewEncryptWithDefaults() *Encrypt

NewEncryptWithDefaults instantiates a new Encrypt object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetDisplayId

func (o *Encrypt) GetDisplayId() string

GetDisplayId returns the DisplayId field if non-nil, zero value otherwise.

GetDisplayIdOk

func (o *Encrypt) GetDisplayIdOk() (*string, bool)

GetDisplayIdOk returns a tuple with the DisplayId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDisplayId

func (o *Encrypt) SetDisplayId(v string)

SetDisplayId sets DisplayId field to given value.

HasDisplayId

func (o *Encrypt) HasDisplayId() bool

HasDisplayId returns a boolean if a field has been set.

GetEncryptionContext

func (o *Encrypt) GetEncryptionContext() map[string]string

GetEncryptionContext returns the EncryptionContext field if non-nil, zero value otherwise.

GetEncryptionContextOk

func (o *Encrypt) GetEncryptionContextOk() (*map[string]string, bool)

GetEncryptionContextOk returns a tuple with the EncryptionContext field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEncryptionContext

func (o *Encrypt) SetEncryptionContext(v map[string]string)

SetEncryptionContext sets EncryptionContext field to given value.

HasEncryptionContext

func (o *Encrypt) HasEncryptionContext() bool

HasEncryptionContext returns a boolean if a field has been set.

GetInputFormat

func (o *Encrypt) GetInputFormat() string

GetInputFormat returns the InputFormat field if non-nil, zero value otherwise.

GetInputFormatOk

func (o *Encrypt) GetInputFormatOk() (*string, bool)

GetInputFormatOk returns a tuple with the InputFormat field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetInputFormat

func (o *Encrypt) SetInputFormat(v string)

SetInputFormat sets InputFormat field to given value.

HasInputFormat

func (o *Encrypt) HasInputFormat() bool

HasInputFormat returns a boolean if a field has been set.

GetItemId

func (o *Encrypt) GetItemId() int64

GetItemId returns the ItemId field if non-nil, zero value otherwise.

GetItemIdOk

func (o *Encrypt) GetItemIdOk() (*int64, bool)

GetItemIdOk returns a tuple with the ItemId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItemId

func (o *Encrypt) SetItemId(v int64)

SetItemId sets ItemId field to given value.

HasItemId

func (o *Encrypt) HasItemId() bool

HasItemId returns a boolean if a field has been set.

GetJson

func (o *Encrypt) GetJson() bool

GetJson returns the Json field if non-nil, zero value otherwise.

GetJsonOk

func (o *Encrypt) GetJsonOk() (*bool, bool)

GetJsonOk returns a tuple with the Json field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetJson

func (o *Encrypt) SetJson(v bool)

SetJson sets Json field to given value.

HasJson

func (o *Encrypt) HasJson() bool

HasJson returns a boolean if a field has been set.

GetKeyName

func (o *Encrypt) GetKeyName() string

GetKeyName returns the KeyName field if non-nil, zero value otherwise.

GetKeyNameOk

func (o *Encrypt) GetKeyNameOk() (*string, bool)

GetKeyNameOk returns a tuple with the KeyName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetKeyName

func (o *Encrypt) SetKeyName(v string)

SetKeyName sets KeyName field to given value.

GetPlaintext

func (o *Encrypt) GetPlaintext() string

GetPlaintext returns the Plaintext field if non-nil, zero value otherwise.

GetPlaintextOk

func (o *Encrypt) GetPlaintextOk() (*string, bool)

GetPlaintextOk returns a tuple with the Plaintext field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPlaintext

func (o *Encrypt) SetPlaintext(v string)

SetPlaintext sets Plaintext field to given value.

HasPlaintext

func (o *Encrypt) HasPlaintext() bool

HasPlaintext returns a boolean if a field has been set.

GetToken

func (o *Encrypt) GetToken() string

GetToken returns the Token field if non-nil, zero value otherwise.

GetTokenOk

func (o *Encrypt) GetTokenOk() (*string, bool)

GetTokenOk returns a tuple with the Token field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetToken

func (o *Encrypt) SetToken(v string)

SetToken sets Token field to given value.

HasToken

func (o *Encrypt) HasToken() bool

HasToken returns a boolean if a field has been set.

GetUidToken

func (o *Encrypt) GetUidToken() string

GetUidToken returns the UidToken field if non-nil, zero value otherwise.

GetUidTokenOk

func (o *Encrypt) GetUidTokenOk() (*string, bool)

GetUidTokenOk returns a tuple with the UidToken field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUidToken

func (o *Encrypt) SetUidToken(v string)

SetUidToken sets UidToken field to given value.

HasUidToken

func (o *Encrypt) HasUidToken() bool

HasUidToken returns a boolean if a field has been set.

GetVersion

func (o *Encrypt) GetVersion() int32

GetVersion returns the Version field if non-nil, zero value otherwise.

GetVersionOk

func (o *Encrypt) GetVersionOk() (*int32, bool)

GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVersion

func (o *Encrypt) SetVersion(v int32)

SetVersion sets Version field to given value.

HasVersion

func (o *Encrypt) HasVersion() bool

HasVersion returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]