Skip to content

Latest commit

 

History

History
722 lines (389 loc) · 22.2 KB

CreateClassicKey.md

File metadata and controls

722 lines (389 loc) · 22.2 KB

CreateClassicKey

Properties

Name Type Description Notes
Alg string Classic Key type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, RSA1024, RSA2048, RSA3072, RSA4096, EC256, EC384, GPG]
AutoRotate Pointer to string Whether to automatically rotate every rotation_interval days, or disable existing automatic rotation [true/false] [optional]
CertFileData Pointer to string Certificate in a PEM format. [optional]
CertificateCommonName Pointer to string Common name for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
CertificateCountry Pointer to string Country name for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
CertificateDigestAlgo Pointer to string Digest algorithm to be used for the certificate key signing. Currently, we support only "sha256" so we hide this option for CLI. [optional]
CertificateFormat Pointer to string [optional]
CertificateLocality Pointer to string Locality for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
CertificateOrganization Pointer to string Organization name for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
CertificateProvince Pointer to string Province name for the generated certificate. Relevant only for generate-self-signed-certificate. [optional]
CertificateTtl Pointer to int64 TTL in days for the generated certificate. Required only for generate-self-signed-certificate. [optional]
ConfFileData Pointer to string The csr config data in base64 encoding [optional]
DeleteProtection Pointer to string Protection from accidental deletion of this object [true/false] [optional]
Description Pointer to string Description of the object [optional]
ExpirationEventIn Pointer to []string How many days before the expiration of the certificate would you like to be notified. [optional]
GenerateSelfSignedCertificate Pointer to bool Whether to generate a self signed certificate with the key. If set, --certificate-ttl must be provided. [optional]
GpgAlg Pointer to string gpg alg: Relevant only if GPG key type selected; options: [RSA1024, RSA2048, RSA3072, RSA4096, Ed25519] [optional]
Json Pointer to bool Set output format to JSON [optional] [default to false]
KeyData Pointer to string Base64-encoded classic key value [optional]
Metadata Pointer to string Deprecated - use description [optional]
Name string ClassicKey name
ProtectionKeyName Pointer to string The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used) [optional]
RotationEventIn Pointer to []string How many days before the rotation of the item would you like to be notified [optional]
RotationInterval Pointer to string The number of days to wait between every automatic rotation (1-365) [optional]
Tags Pointer to []string Add tags attached to this object [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]

Methods

NewCreateClassicKey

func NewCreateClassicKey(alg string, name string, ) *CreateClassicKey

NewCreateClassicKey instantiates a new CreateClassicKey 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

NewCreateClassicKeyWithDefaults

func NewCreateClassicKeyWithDefaults() *CreateClassicKey

NewCreateClassicKeyWithDefaults instantiates a new CreateClassicKey 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

GetAlg

func (o *CreateClassicKey) GetAlg() string

GetAlg returns the Alg field if non-nil, zero value otherwise.

GetAlgOk

func (o *CreateClassicKey) GetAlgOk() (*string, bool)

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

SetAlg

func (o *CreateClassicKey) SetAlg(v string)

SetAlg sets Alg field to given value.

GetAutoRotate

func (o *CreateClassicKey) GetAutoRotate() string

GetAutoRotate returns the AutoRotate field if non-nil, zero value otherwise.

GetAutoRotateOk

func (o *CreateClassicKey) GetAutoRotateOk() (*string, bool)

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

SetAutoRotate

func (o *CreateClassicKey) SetAutoRotate(v string)

SetAutoRotate sets AutoRotate field to given value.

HasAutoRotate

func (o *CreateClassicKey) HasAutoRotate() bool

HasAutoRotate returns a boolean if a field has been set.

GetCertFileData

func (o *CreateClassicKey) GetCertFileData() string

GetCertFileData returns the CertFileData field if non-nil, zero value otherwise.

GetCertFileDataOk

func (o *CreateClassicKey) GetCertFileDataOk() (*string, bool)

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

SetCertFileData

func (o *CreateClassicKey) SetCertFileData(v string)

SetCertFileData sets CertFileData field to given value.

HasCertFileData

func (o *CreateClassicKey) HasCertFileData() bool

HasCertFileData returns a boolean if a field has been set.

GetCertificateCommonName

func (o *CreateClassicKey) GetCertificateCommonName() string

GetCertificateCommonName returns the CertificateCommonName field if non-nil, zero value otherwise.

GetCertificateCommonNameOk

func (o *CreateClassicKey) GetCertificateCommonNameOk() (*string, bool)

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

SetCertificateCommonName

func (o *CreateClassicKey) SetCertificateCommonName(v string)

SetCertificateCommonName sets CertificateCommonName field to given value.

HasCertificateCommonName

func (o *CreateClassicKey) HasCertificateCommonName() bool

HasCertificateCommonName returns a boolean if a field has been set.

GetCertificateCountry

func (o *CreateClassicKey) GetCertificateCountry() string

GetCertificateCountry returns the CertificateCountry field if non-nil, zero value otherwise.

GetCertificateCountryOk

func (o *CreateClassicKey) GetCertificateCountryOk() (*string, bool)

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

SetCertificateCountry

func (o *CreateClassicKey) SetCertificateCountry(v string)

SetCertificateCountry sets CertificateCountry field to given value.

HasCertificateCountry

func (o *CreateClassicKey) HasCertificateCountry() bool

HasCertificateCountry returns a boolean if a field has been set.

GetCertificateDigestAlgo

func (o *CreateClassicKey) GetCertificateDigestAlgo() string

GetCertificateDigestAlgo returns the CertificateDigestAlgo field if non-nil, zero value otherwise.

GetCertificateDigestAlgoOk

func (o *CreateClassicKey) GetCertificateDigestAlgoOk() (*string, bool)

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

SetCertificateDigestAlgo

func (o *CreateClassicKey) SetCertificateDigestAlgo(v string)

SetCertificateDigestAlgo sets CertificateDigestAlgo field to given value.

HasCertificateDigestAlgo

func (o *CreateClassicKey) HasCertificateDigestAlgo() bool

HasCertificateDigestAlgo returns a boolean if a field has been set.

GetCertificateFormat

func (o *CreateClassicKey) GetCertificateFormat() string

GetCertificateFormat returns the CertificateFormat field if non-nil, zero value otherwise.

GetCertificateFormatOk

func (o *CreateClassicKey) GetCertificateFormatOk() (*string, bool)

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

SetCertificateFormat

func (o *CreateClassicKey) SetCertificateFormat(v string)

SetCertificateFormat sets CertificateFormat field to given value.

HasCertificateFormat

func (o *CreateClassicKey) HasCertificateFormat() bool

HasCertificateFormat returns a boolean if a field has been set.

GetCertificateLocality

func (o *CreateClassicKey) GetCertificateLocality() string

GetCertificateLocality returns the CertificateLocality field if non-nil, zero value otherwise.

GetCertificateLocalityOk

func (o *CreateClassicKey) GetCertificateLocalityOk() (*string, bool)

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

SetCertificateLocality

func (o *CreateClassicKey) SetCertificateLocality(v string)

SetCertificateLocality sets CertificateLocality field to given value.

HasCertificateLocality

func (o *CreateClassicKey) HasCertificateLocality() bool

HasCertificateLocality returns a boolean if a field has been set.

GetCertificateOrganization

func (o *CreateClassicKey) GetCertificateOrganization() string

GetCertificateOrganization returns the CertificateOrganization field if non-nil, zero value otherwise.

GetCertificateOrganizationOk

func (o *CreateClassicKey) GetCertificateOrganizationOk() (*string, bool)

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

SetCertificateOrganization

func (o *CreateClassicKey) SetCertificateOrganization(v string)

SetCertificateOrganization sets CertificateOrganization field to given value.

HasCertificateOrganization

func (o *CreateClassicKey) HasCertificateOrganization() bool

HasCertificateOrganization returns a boolean if a field has been set.

GetCertificateProvince

func (o *CreateClassicKey) GetCertificateProvince() string

GetCertificateProvince returns the CertificateProvince field if non-nil, zero value otherwise.

GetCertificateProvinceOk

func (o *CreateClassicKey) GetCertificateProvinceOk() (*string, bool)

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

SetCertificateProvince

func (o *CreateClassicKey) SetCertificateProvince(v string)

SetCertificateProvince sets CertificateProvince field to given value.

HasCertificateProvince

func (o *CreateClassicKey) HasCertificateProvince() bool

HasCertificateProvince returns a boolean if a field has been set.

GetCertificateTtl

func (o *CreateClassicKey) GetCertificateTtl() int64

GetCertificateTtl returns the CertificateTtl field if non-nil, zero value otherwise.

GetCertificateTtlOk

func (o *CreateClassicKey) GetCertificateTtlOk() (*int64, bool)

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

SetCertificateTtl

func (o *CreateClassicKey) SetCertificateTtl(v int64)

SetCertificateTtl sets CertificateTtl field to given value.

HasCertificateTtl

func (o *CreateClassicKey) HasCertificateTtl() bool

HasCertificateTtl returns a boolean if a field has been set.

GetConfFileData

func (o *CreateClassicKey) GetConfFileData() string

GetConfFileData returns the ConfFileData field if non-nil, zero value otherwise.

GetConfFileDataOk

func (o *CreateClassicKey) GetConfFileDataOk() (*string, bool)

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

SetConfFileData

func (o *CreateClassicKey) SetConfFileData(v string)

SetConfFileData sets ConfFileData field to given value.

HasConfFileData

func (o *CreateClassicKey) HasConfFileData() bool

HasConfFileData returns a boolean if a field has been set.

GetDeleteProtection

func (o *CreateClassicKey) GetDeleteProtection() string

GetDeleteProtection returns the DeleteProtection field if non-nil, zero value otherwise.

GetDeleteProtectionOk

func (o *CreateClassicKey) GetDeleteProtectionOk() (*string, bool)

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

SetDeleteProtection

func (o *CreateClassicKey) SetDeleteProtection(v string)

SetDeleteProtection sets DeleteProtection field to given value.

HasDeleteProtection

func (o *CreateClassicKey) HasDeleteProtection() bool

HasDeleteProtection returns a boolean if a field has been set.

GetDescription

func (o *CreateClassicKey) GetDescription() string

GetDescription returns the Description field if non-nil, zero value otherwise.

GetDescriptionOk

func (o *CreateClassicKey) GetDescriptionOk() (*string, bool)

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

SetDescription

func (o *CreateClassicKey) SetDescription(v string)

SetDescription sets Description field to given value.

HasDescription

func (o *CreateClassicKey) HasDescription() bool

HasDescription returns a boolean if a field has been set.

GetExpirationEventIn

func (o *CreateClassicKey) GetExpirationEventIn() []string

GetExpirationEventIn returns the ExpirationEventIn field if non-nil, zero value otherwise.

GetExpirationEventInOk

func (o *CreateClassicKey) GetExpirationEventInOk() (*[]string, bool)

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

SetExpirationEventIn

func (o *CreateClassicKey) SetExpirationEventIn(v []string)

SetExpirationEventIn sets ExpirationEventIn field to given value.

HasExpirationEventIn

func (o *CreateClassicKey) HasExpirationEventIn() bool

HasExpirationEventIn returns a boolean if a field has been set.

GetGenerateSelfSignedCertificate

func (o *CreateClassicKey) GetGenerateSelfSignedCertificate() bool

GetGenerateSelfSignedCertificate returns the GenerateSelfSignedCertificate field if non-nil, zero value otherwise.

GetGenerateSelfSignedCertificateOk

func (o *CreateClassicKey) GetGenerateSelfSignedCertificateOk() (*bool, bool)

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

SetGenerateSelfSignedCertificate

func (o *CreateClassicKey) SetGenerateSelfSignedCertificate(v bool)

SetGenerateSelfSignedCertificate sets GenerateSelfSignedCertificate field to given value.

HasGenerateSelfSignedCertificate

func (o *CreateClassicKey) HasGenerateSelfSignedCertificate() bool

HasGenerateSelfSignedCertificate returns a boolean if a field has been set.

GetGpgAlg

func (o *CreateClassicKey) GetGpgAlg() string

GetGpgAlg returns the GpgAlg field if non-nil, zero value otherwise.

GetGpgAlgOk

func (o *CreateClassicKey) GetGpgAlgOk() (*string, bool)

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

SetGpgAlg

func (o *CreateClassicKey) SetGpgAlg(v string)

SetGpgAlg sets GpgAlg field to given value.

HasGpgAlg

func (o *CreateClassicKey) HasGpgAlg() bool

HasGpgAlg returns a boolean if a field has been set.

GetJson

func (o *CreateClassicKey) GetJson() bool

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

GetJsonOk

func (o *CreateClassicKey) 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 *CreateClassicKey) SetJson(v bool)

SetJson sets Json field to given value.

HasJson

func (o *CreateClassicKey) HasJson() bool

HasJson returns a boolean if a field has been set.

GetKeyData

func (o *CreateClassicKey) GetKeyData() string

GetKeyData returns the KeyData field if non-nil, zero value otherwise.

GetKeyDataOk

func (o *CreateClassicKey) GetKeyDataOk() (*string, bool)

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

SetKeyData

func (o *CreateClassicKey) SetKeyData(v string)

SetKeyData sets KeyData field to given value.

HasKeyData

func (o *CreateClassicKey) HasKeyData() bool

HasKeyData returns a boolean if a field has been set.

GetMetadata

func (o *CreateClassicKey) GetMetadata() string

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *CreateClassicKey) GetMetadataOk() (*string, bool)

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

SetMetadata

func (o *CreateClassicKey) SetMetadata(v string)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *CreateClassicKey) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetName

func (o *CreateClassicKey) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *CreateClassicKey) GetNameOk() (*string, bool)

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

SetName

func (o *CreateClassicKey) SetName(v string)

SetName sets Name field to given value.

GetProtectionKeyName

func (o *CreateClassicKey) GetProtectionKeyName() string

GetProtectionKeyName returns the ProtectionKeyName field if non-nil, zero value otherwise.

GetProtectionKeyNameOk

func (o *CreateClassicKey) GetProtectionKeyNameOk() (*string, bool)

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

SetProtectionKeyName

func (o *CreateClassicKey) SetProtectionKeyName(v string)

SetProtectionKeyName sets ProtectionKeyName field to given value.

HasProtectionKeyName

func (o *CreateClassicKey) HasProtectionKeyName() bool

HasProtectionKeyName returns a boolean if a field has been set.

GetRotationEventIn

func (o *CreateClassicKey) GetRotationEventIn() []string

GetRotationEventIn returns the RotationEventIn field if non-nil, zero value otherwise.

GetRotationEventInOk

func (o *CreateClassicKey) GetRotationEventInOk() (*[]string, bool)

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

SetRotationEventIn

func (o *CreateClassicKey) SetRotationEventIn(v []string)

SetRotationEventIn sets RotationEventIn field to given value.

HasRotationEventIn

func (o *CreateClassicKey) HasRotationEventIn() bool

HasRotationEventIn returns a boolean if a field has been set.

GetRotationInterval

func (o *CreateClassicKey) GetRotationInterval() string

GetRotationInterval returns the RotationInterval field if non-nil, zero value otherwise.

GetRotationIntervalOk

func (o *CreateClassicKey) GetRotationIntervalOk() (*string, bool)

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

SetRotationInterval

func (o *CreateClassicKey) SetRotationInterval(v string)

SetRotationInterval sets RotationInterval field to given value.

HasRotationInterval

func (o *CreateClassicKey) HasRotationInterval() bool

HasRotationInterval returns a boolean if a field has been set.

GetTags

func (o *CreateClassicKey) GetTags() []string

GetTags returns the Tags field if non-nil, zero value otherwise.

GetTagsOk

func (o *CreateClassicKey) GetTagsOk() (*[]string, bool)

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

SetTags

func (o *CreateClassicKey) SetTags(v []string)

SetTags sets Tags field to given value.

HasTags

func (o *CreateClassicKey) HasTags() bool

HasTags returns a boolean if a field has been set.

GetToken

func (o *CreateClassicKey) GetToken() string

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

GetTokenOk

func (o *CreateClassicKey) 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 *CreateClassicKey) SetToken(v string)

SetToken sets Token field to given value.

HasToken

func (o *CreateClassicKey) HasToken() bool

HasToken returns a boolean if a field has been set.

GetUidToken

func (o *CreateClassicKey) GetUidToken() string

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

GetUidTokenOk

func (o *CreateClassicKey) 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 *CreateClassicKey) SetUidToken(v string)

SetUidToken sets UidToken field to given value.

HasUidToken

func (o *CreateClassicKey) HasUidToken() bool

HasUidToken returns a boolean if a field has been set.

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