...

Package keymanagement

import "github.com/oracle/oci-go-sdk/keymanagement"
Overview
Index

Overview ▾

Index ▾

type BackupKeyDetails
    func (m BackupKeyDetails) String() string
    func (m *BackupKeyDetails) UnmarshalJSON(data []byte) (e error)
type BackupKeyRequest
    func (request BackupKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request BackupKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request BackupKeyRequest) String() string
type BackupKeyResponse
    func (response BackupKeyResponse) HTTPResponse() *http.Response
    func (response BackupKeyResponse) String() string
type BackupLocation
type BackupLocationBucket
    func (m BackupLocationBucket) MarshalJSON() (buff []byte, e error)
    func (m BackupLocationBucket) String() string
type BackupLocationDestinationEnum
    func GetBackupLocationDestinationEnumValues() []BackupLocationDestinationEnum
type BackupLocationUri
    func (m BackupLocationUri) MarshalJSON() (buff []byte, e error)
    func (m BackupLocationUri) String() string
type BackupVaultDetails
    func (m BackupVaultDetails) String() string
    func (m *BackupVaultDetails) UnmarshalJSON(data []byte) (e error)
type BackupVaultRequest
    func (request BackupVaultRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request BackupVaultRequest) RetryPolicy() *common.RetryPolicy
    func (request BackupVaultRequest) String() string
type BackupVaultResponse
    func (response BackupVaultResponse) HTTPResponse() *http.Response
    func (response BackupVaultResponse) String() string
type CancelKeyDeletionRequest
    func (request CancelKeyDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CancelKeyDeletionRequest) RetryPolicy() *common.RetryPolicy
    func (request CancelKeyDeletionRequest) String() string
type CancelKeyDeletionResponse
    func (response CancelKeyDeletionResponse) HTTPResponse() *http.Response
    func (response CancelKeyDeletionResponse) String() string
type CancelKeyVersionDeletionRequest
    func (request CancelKeyVersionDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CancelKeyVersionDeletionRequest) RetryPolicy() *common.RetryPolicy
    func (request CancelKeyVersionDeletionRequest) String() string
type CancelKeyVersionDeletionResponse
    func (response CancelKeyVersionDeletionResponse) HTTPResponse() *http.Response
    func (response CancelKeyVersionDeletionResponse) String() string
type CancelVaultDeletionRequest
    func (request CancelVaultDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CancelVaultDeletionRequest) RetryPolicy() *common.RetryPolicy
    func (request CancelVaultDeletionRequest) String() string
type CancelVaultDeletionResponse
    func (response CancelVaultDeletionResponse) HTTPResponse() *http.Response
    func (response CancelVaultDeletionResponse) String() string
type ChangeKeyCompartmentDetails
    func (m ChangeKeyCompartmentDetails) String() string
type ChangeKeyCompartmentRequest
    func (request ChangeKeyCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeKeyCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeKeyCompartmentRequest) String() string
type ChangeKeyCompartmentResponse
    func (response ChangeKeyCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeKeyCompartmentResponse) String() string
type ChangeVaultCompartmentDetails
    func (m ChangeVaultCompartmentDetails) String() string
type ChangeVaultCompartmentRequest
    func (request ChangeVaultCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeVaultCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeVaultCompartmentRequest) String() string
type ChangeVaultCompartmentResponse
    func (response ChangeVaultCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeVaultCompartmentResponse) String() string
type CreateKeyDetails
    func (m CreateKeyDetails) String() string
type CreateKeyDetailsProtectionModeEnum
    func GetCreateKeyDetailsProtectionModeEnumValues() []CreateKeyDetailsProtectionModeEnum
type CreateKeyRequest
    func (request CreateKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateKeyRequest) String() string
type CreateKeyResponse
    func (response CreateKeyResponse) HTTPResponse() *http.Response
    func (response CreateKeyResponse) String() string
type CreateKeyVersionRequest
    func (request CreateKeyVersionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateKeyVersionRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateKeyVersionRequest) String() string
type CreateKeyVersionResponse
    func (response CreateKeyVersionResponse) HTTPResponse() *http.Response
    func (response CreateKeyVersionResponse) String() string
type CreateVaultDetails
    func (m CreateVaultDetails) String() string
type CreateVaultDetailsVaultTypeEnum
    func GetCreateVaultDetailsVaultTypeEnumValues() []CreateVaultDetailsVaultTypeEnum
type CreateVaultRequest
    func (request CreateVaultRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateVaultRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateVaultRequest) String() string
type CreateVaultResponse
    func (response CreateVaultResponse) HTTPResponse() *http.Response
    func (response CreateVaultResponse) String() string
type DecryptDataDetails
    func (m DecryptDataDetails) String() string
type DecryptDataDetailsEncryptionAlgorithmEnum
    func GetDecryptDataDetailsEncryptionAlgorithmEnumValues() []DecryptDataDetailsEncryptionAlgorithmEnum
type DecryptRequest
    func (request DecryptRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DecryptRequest) RetryPolicy() *common.RetryPolicy
    func (request DecryptRequest) String() string
type DecryptResponse
    func (response DecryptResponse) HTTPResponse() *http.Response
    func (response DecryptResponse) String() string
type DecryptedData
    func (m DecryptedData) String() string
type DecryptedDataEncryptionAlgorithmEnum
    func GetDecryptedDataEncryptionAlgorithmEnumValues() []DecryptedDataEncryptionAlgorithmEnum
type DisableKeyRequest
    func (request DisableKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DisableKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request DisableKeyRequest) String() string
type DisableKeyResponse
    func (response DisableKeyResponse) HTTPResponse() *http.Response
    func (response DisableKeyResponse) String() string
type EnableKeyRequest
    func (request EnableKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request EnableKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request EnableKeyRequest) String() string
type EnableKeyResponse
    func (response EnableKeyResponse) HTTPResponse() *http.Response
    func (response EnableKeyResponse) String() string
type EncryptDataDetails
    func (m EncryptDataDetails) String() string
type EncryptDataDetailsEncryptionAlgorithmEnum
    func GetEncryptDataDetailsEncryptionAlgorithmEnumValues() []EncryptDataDetailsEncryptionAlgorithmEnum
type EncryptRequest
    func (request EncryptRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request EncryptRequest) RetryPolicy() *common.RetryPolicy
    func (request EncryptRequest) String() string
type EncryptResponse
    func (response EncryptResponse) HTTPResponse() *http.Response
    func (response EncryptResponse) String() string
type EncryptedData
    func (m EncryptedData) String() string
type EncryptedDataEncryptionAlgorithmEnum
    func GetEncryptedDataEncryptionAlgorithmEnumValues() []EncryptedDataEncryptionAlgorithmEnum
type ExportKeyDetails
    func (m ExportKeyDetails) String() string
type ExportKeyDetailsAlgorithmEnum
    func GetExportKeyDetailsAlgorithmEnumValues() []ExportKeyDetailsAlgorithmEnum
type ExportKeyRequest
    func (request ExportKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ExportKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request ExportKeyRequest) String() string
type ExportKeyResponse
    func (response ExportKeyResponse) HTTPResponse() *http.Response
    func (response ExportKeyResponse) String() string
type ExportedKeyData
    func (m ExportedKeyData) String() string
type ExportedKeyDataAlgorithmEnum
    func GetExportedKeyDataAlgorithmEnumValues() []ExportedKeyDataAlgorithmEnum
type GenerateDataEncryptionKeyRequest
    func (request GenerateDataEncryptionKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GenerateDataEncryptionKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request GenerateDataEncryptionKeyRequest) String() string
type GenerateDataEncryptionKeyResponse
    func (response GenerateDataEncryptionKeyResponse) HTTPResponse() *http.Response
    func (response GenerateDataEncryptionKeyResponse) String() string
type GenerateKeyDetails
    func (m GenerateKeyDetails) String() string
type GeneratedKey
    func (m GeneratedKey) String() string
type GetKeyRequest
    func (request GetKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request GetKeyRequest) String() string
type GetKeyResponse
    func (response GetKeyResponse) HTTPResponse() *http.Response
    func (response GetKeyResponse) String() string
type GetKeyVersionRequest
    func (request GetKeyVersionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetKeyVersionRequest) RetryPolicy() *common.RetryPolicy
    func (request GetKeyVersionRequest) String() string
type GetKeyVersionResponse
    func (response GetKeyVersionResponse) HTTPResponse() *http.Response
    func (response GetKeyVersionResponse) String() string
type GetVaultRequest
    func (request GetVaultRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetVaultRequest) RetryPolicy() *common.RetryPolicy
    func (request GetVaultRequest) String() string
type GetVaultResponse
    func (response GetVaultResponse) HTTPResponse() *http.Response
    func (response GetVaultResponse) String() string
type GetVaultUsageRequest
    func (request GetVaultUsageRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetVaultUsageRequest) RetryPolicy() *common.RetryPolicy
    func (request GetVaultUsageRequest) String() string
type GetVaultUsageResponse
    func (response GetVaultUsageResponse) HTTPResponse() *http.Response
    func (response GetVaultUsageResponse) String() string
type GetWrappingKeyRequest
    func (request GetWrappingKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetWrappingKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWrappingKeyRequest) String() string
type GetWrappingKeyResponse
    func (response GetWrappingKeyResponse) HTTPResponse() *http.Response
    func (response GetWrappingKeyResponse) String() string
type ImportKeyDetails
    func (m ImportKeyDetails) String() string
type ImportKeyDetailsProtectionModeEnum
    func GetImportKeyDetailsProtectionModeEnumValues() []ImportKeyDetailsProtectionModeEnum
type ImportKeyRequest
    func (request ImportKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ImportKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request ImportKeyRequest) String() string
type ImportKeyResponse
    func (response ImportKeyResponse) HTTPResponse() *http.Response
    func (response ImportKeyResponse) String() string
type ImportKeyVersionDetails
    func (m ImportKeyVersionDetails) String() string
type ImportKeyVersionRequest
    func (request ImportKeyVersionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ImportKeyVersionRequest) RetryPolicy() *common.RetryPolicy
    func (request ImportKeyVersionRequest) String() string
type ImportKeyVersionResponse
    func (response ImportKeyVersionResponse) HTTPResponse() *http.Response
    func (response ImportKeyVersionResponse) String() string
type Key
    func (m Key) String() string
type KeyLifecycleStateEnum
    func GetKeyLifecycleStateEnumValues() []KeyLifecycleStateEnum
type KeyProtectionModeEnum
    func GetKeyProtectionModeEnumValues() []KeyProtectionModeEnum
type KeyShape
    func (m KeyShape) String() string
type KeyShapeAlgorithmEnum
    func GetKeyShapeAlgorithmEnumValues() []KeyShapeAlgorithmEnum
type KeyShapeCurveIdEnum
    func GetKeyShapeCurveIdEnumValues() []KeyShapeCurveIdEnum
type KeySummary
    func (m KeySummary) String() string
type KeySummaryAlgorithmEnum
    func GetKeySummaryAlgorithmEnumValues() []KeySummaryAlgorithmEnum
type KeySummaryLifecycleStateEnum
    func GetKeySummaryLifecycleStateEnumValues() []KeySummaryLifecycleStateEnum
type KeySummaryProtectionModeEnum
    func GetKeySummaryProtectionModeEnumValues() []KeySummaryProtectionModeEnum
type KeyVersion
    func (m KeyVersion) String() string
type KeyVersionLifecycleStateEnum
    func GetKeyVersionLifecycleStateEnumValues() []KeyVersionLifecycleStateEnum
type KeyVersionOriginEnum
    func GetKeyVersionOriginEnumValues() []KeyVersionOriginEnum
type KeyVersionSummary
    func (m KeyVersionSummary) String() string
type KeyVersionSummaryLifecycleStateEnum
    func GetKeyVersionSummaryLifecycleStateEnumValues() []KeyVersionSummaryLifecycleStateEnum
type KeyVersionSummaryOriginEnum
    func GetKeyVersionSummaryOriginEnumValues() []KeyVersionSummaryOriginEnum
type KmsCryptoClient
    func NewKmsCryptoClientWithConfigurationProvider(configProvider common.ConfigurationProvider, endpoint string) (client KmsCryptoClient, err error)
    func NewKmsCryptoClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string, endpoint string) (client KmsCryptoClient, err error)
    func (client *KmsCryptoClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client KmsCryptoClient) Decrypt(ctx context.Context, request DecryptRequest) (response DecryptResponse, err error)
    func (client KmsCryptoClient) Encrypt(ctx context.Context, request EncryptRequest) (response EncryptResponse, err error)
    func (client KmsCryptoClient) ExportKey(ctx context.Context, request ExportKeyRequest) (response ExportKeyResponse, err error)
    func (client KmsCryptoClient) GenerateDataEncryptionKey(ctx context.Context, request GenerateDataEncryptionKeyRequest) (response GenerateDataEncryptionKeyResponse, err error)
    func (client KmsCryptoClient) Sign(ctx context.Context, request SignRequest) (response SignResponse, err error)
    func (client KmsCryptoClient) Verify(ctx context.Context, request VerifyRequest) (response VerifyResponse, err error)
type KmsManagementClient
    func NewKmsManagementClientWithConfigurationProvider(configProvider common.ConfigurationProvider, endpoint string) (client KmsManagementClient, err error)
    func NewKmsManagementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string, endpoint string) (client KmsManagementClient, err error)
    func (client KmsManagementClient) BackupKey(ctx context.Context, request BackupKeyRequest) (response BackupKeyResponse, err error)
    func (client KmsManagementClient) CancelKeyDeletion(ctx context.Context, request CancelKeyDeletionRequest) (response CancelKeyDeletionResponse, err error)
    func (client KmsManagementClient) CancelKeyVersionDeletion(ctx context.Context, request CancelKeyVersionDeletionRequest) (response CancelKeyVersionDeletionResponse, err error)
    func (client KmsManagementClient) ChangeKeyCompartment(ctx context.Context, request ChangeKeyCompartmentRequest) (response ChangeKeyCompartmentResponse, err error)
    func (client *KmsManagementClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client KmsManagementClient) CreateKey(ctx context.Context, request CreateKeyRequest) (response CreateKeyResponse, err error)
    func (client KmsManagementClient) CreateKeyVersion(ctx context.Context, request CreateKeyVersionRequest) (response CreateKeyVersionResponse, err error)
    func (client KmsManagementClient) DisableKey(ctx context.Context, request DisableKeyRequest) (response DisableKeyResponse, err error)
    func (client KmsManagementClient) EnableKey(ctx context.Context, request EnableKeyRequest) (response EnableKeyResponse, err error)
    func (client KmsManagementClient) GetKey(ctx context.Context, request GetKeyRequest) (response GetKeyResponse, err error)
    func (client KmsManagementClient) GetKeyVersion(ctx context.Context, request GetKeyVersionRequest) (response GetKeyVersionResponse, err error)
    func (client KmsManagementClient) GetWrappingKey(ctx context.Context, request GetWrappingKeyRequest) (response GetWrappingKeyResponse, err error)
    func (client KmsManagementClient) ImportKey(ctx context.Context, request ImportKeyRequest) (response ImportKeyResponse, err error)
    func (client KmsManagementClient) ImportKeyVersion(ctx context.Context, request ImportKeyVersionRequest) (response ImportKeyVersionResponse, err error)
    func (client KmsManagementClient) ListKeyVersions(ctx context.Context, request ListKeyVersionsRequest) (response ListKeyVersionsResponse, err error)
    func (client KmsManagementClient) ListKeys(ctx context.Context, request ListKeysRequest) (response ListKeysResponse, err error)
    func (client KmsManagementClient) RestoreKeyFromFile(ctx context.Context, request RestoreKeyFromFileRequest) (response RestoreKeyFromFileResponse, err error)
    func (client KmsManagementClient) RestoreKeyFromObjectStore(ctx context.Context, request RestoreKeyFromObjectStoreRequest) (response RestoreKeyFromObjectStoreResponse, err error)
    func (client KmsManagementClient) ScheduleKeyDeletion(ctx context.Context, request ScheduleKeyDeletionRequest) (response ScheduleKeyDeletionResponse, err error)
    func (client KmsManagementClient) ScheduleKeyVersionDeletion(ctx context.Context, request ScheduleKeyVersionDeletionRequest) (response ScheduleKeyVersionDeletionResponse, err error)
    func (client KmsManagementClient) UpdateKey(ctx context.Context, request UpdateKeyRequest) (response UpdateKeyResponse, err error)
type KmsVaultClient
    func NewKmsVaultClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client KmsVaultClient, err error)
    func NewKmsVaultClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client KmsVaultClient, err error)
    func (client KmsVaultClient) BackupVault(ctx context.Context, request BackupVaultRequest) (response BackupVaultResponse, err error)
    func (client KmsVaultClient) CancelVaultDeletion(ctx context.Context, request CancelVaultDeletionRequest) (response CancelVaultDeletionResponse, err error)
    func (client KmsVaultClient) ChangeVaultCompartment(ctx context.Context, request ChangeVaultCompartmentRequest) (response ChangeVaultCompartmentResponse, err error)
    func (client *KmsVaultClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client KmsVaultClient) CreateVault(ctx context.Context, request CreateVaultRequest) (response CreateVaultResponse, err error)
    func (client KmsVaultClient) GetVault(ctx context.Context, request GetVaultRequest) (response GetVaultResponse, err error)
    func (client KmsVaultClient) GetVaultUsage(ctx context.Context, request GetVaultUsageRequest) (response GetVaultUsageResponse, err error)
    func (client KmsVaultClient) ListVaults(ctx context.Context, request ListVaultsRequest) (response ListVaultsResponse, err error)
    func (client KmsVaultClient) RestoreVaultFromFile(ctx context.Context, request RestoreVaultFromFileRequest) (response RestoreVaultFromFileResponse, err error)
    func (client KmsVaultClient) RestoreVaultFromObjectStore(ctx context.Context, request RestoreVaultFromObjectStoreRequest) (response RestoreVaultFromObjectStoreResponse, err error)
    func (client KmsVaultClient) ScheduleVaultDeletion(ctx context.Context, request ScheduleVaultDeletionRequest) (response ScheduleVaultDeletionResponse, err error)
    func (client *KmsVaultClient) SetRegion(region string)
    func (client KmsVaultClient) UpdateVault(ctx context.Context, request UpdateVaultRequest) (response UpdateVaultResponse, err error)
type ListKeyVersionsRequest
    func (request ListKeyVersionsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListKeyVersionsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListKeyVersionsRequest) String() string
type ListKeyVersionsResponse
    func (response ListKeyVersionsResponse) HTTPResponse() *http.Response
    func (response ListKeyVersionsResponse) String() string
type ListKeyVersionsSortByEnum
    func GetListKeyVersionsSortByEnumValues() []ListKeyVersionsSortByEnum
type ListKeyVersionsSortOrderEnum
    func GetListKeyVersionsSortOrderEnumValues() []ListKeyVersionsSortOrderEnum
type ListKeysAlgorithmEnum
    func GetListKeysAlgorithmEnumValues() []ListKeysAlgorithmEnum
type ListKeysCurveIdEnum
    func GetListKeysCurveIdEnumValues() []ListKeysCurveIdEnum
type ListKeysProtectionModeEnum
    func GetListKeysProtectionModeEnumValues() []ListKeysProtectionModeEnum
type ListKeysRequest
    func (request ListKeysRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListKeysRequest) RetryPolicy() *common.RetryPolicy
    func (request ListKeysRequest) String() string
type ListKeysResponse
    func (response ListKeysResponse) HTTPResponse() *http.Response
    func (response ListKeysResponse) String() string
type ListKeysSortByEnum
    func GetListKeysSortByEnumValues() []ListKeysSortByEnum
type ListKeysSortOrderEnum
    func GetListKeysSortOrderEnumValues() []ListKeysSortOrderEnum
type ListVaultsRequest
    func (request ListVaultsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListVaultsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListVaultsRequest) String() string
type ListVaultsResponse
    func (response ListVaultsResponse) HTTPResponse() *http.Response
    func (response ListVaultsResponse) String() string
type ListVaultsSortByEnum
    func GetListVaultsSortByEnumValues() []ListVaultsSortByEnum
type ListVaultsSortOrderEnum
    func GetListVaultsSortOrderEnumValues() []ListVaultsSortOrderEnum
type RestoreKeyFromFileRequest
    func (request RestoreKeyFromFileRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request RestoreKeyFromFileRequest) RetryPolicy() *common.RetryPolicy
    func (request RestoreKeyFromFileRequest) String() string
type RestoreKeyFromFileResponse
    func (response RestoreKeyFromFileResponse) HTTPResponse() *http.Response
    func (response RestoreKeyFromFileResponse) String() string
type RestoreKeyFromObjectStoreDetails
    func (m RestoreKeyFromObjectStoreDetails) String() string
    func (m *RestoreKeyFromObjectStoreDetails) UnmarshalJSON(data []byte) (e error)
type RestoreKeyFromObjectStoreRequest
    func (request RestoreKeyFromObjectStoreRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request RestoreKeyFromObjectStoreRequest) RetryPolicy() *common.RetryPolicy
    func (request RestoreKeyFromObjectStoreRequest) String() string
type RestoreKeyFromObjectStoreResponse
    func (response RestoreKeyFromObjectStoreResponse) HTTPResponse() *http.Response
    func (response RestoreKeyFromObjectStoreResponse) String() string
type RestoreVaultFromFileRequest
    func (request RestoreVaultFromFileRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request RestoreVaultFromFileRequest) RetryPolicy() *common.RetryPolicy
    func (request RestoreVaultFromFileRequest) String() string
type RestoreVaultFromFileResponse
    func (response RestoreVaultFromFileResponse) HTTPResponse() *http.Response
    func (response RestoreVaultFromFileResponse) String() string
type RestoreVaultFromObjectStoreDetails
    func (m RestoreVaultFromObjectStoreDetails) String() string
    func (m *RestoreVaultFromObjectStoreDetails) UnmarshalJSON(data []byte) (e error)
type RestoreVaultFromObjectStoreRequest
    func (request RestoreVaultFromObjectStoreRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request RestoreVaultFromObjectStoreRequest) RetryPolicy() *common.RetryPolicy
    func (request RestoreVaultFromObjectStoreRequest) String() string
type RestoreVaultFromObjectStoreResponse
    func (response RestoreVaultFromObjectStoreResponse) HTTPResponse() *http.Response
    func (response RestoreVaultFromObjectStoreResponse) String() string
type ScheduleKeyDeletionDetails
    func (m ScheduleKeyDeletionDetails) String() string
type ScheduleKeyDeletionRequest
    func (request ScheduleKeyDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ScheduleKeyDeletionRequest) RetryPolicy() *common.RetryPolicy
    func (request ScheduleKeyDeletionRequest) String() string
type ScheduleKeyDeletionResponse
    func (response ScheduleKeyDeletionResponse) HTTPResponse() *http.Response
    func (response ScheduleKeyDeletionResponse) String() string
type ScheduleKeyVersionDeletionDetails
    func (m ScheduleKeyVersionDeletionDetails) String() string
type ScheduleKeyVersionDeletionRequest
    func (request ScheduleKeyVersionDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ScheduleKeyVersionDeletionRequest) RetryPolicy() *common.RetryPolicy
    func (request ScheduleKeyVersionDeletionRequest) String() string
type ScheduleKeyVersionDeletionResponse
    func (response ScheduleKeyVersionDeletionResponse) HTTPResponse() *http.Response
    func (response ScheduleKeyVersionDeletionResponse) String() string
type ScheduleVaultDeletionDetails
    func (m ScheduleVaultDeletionDetails) String() string
type ScheduleVaultDeletionRequest
    func (request ScheduleVaultDeletionRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ScheduleVaultDeletionRequest) RetryPolicy() *common.RetryPolicy
    func (request ScheduleVaultDeletionRequest) String() string
type ScheduleVaultDeletionResponse
    func (response ScheduleVaultDeletionResponse) HTTPResponse() *http.Response
    func (response ScheduleVaultDeletionResponse) String() string
type SignDataDetails
    func (m SignDataDetails) String() string
type SignDataDetailsMessageTypeEnum
    func GetSignDataDetailsMessageTypeEnumValues() []SignDataDetailsMessageTypeEnum
type SignDataDetailsSigningAlgorithmEnum
    func GetSignDataDetailsSigningAlgorithmEnumValues() []SignDataDetailsSigningAlgorithmEnum
type SignRequest
    func (request SignRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request SignRequest) RetryPolicy() *common.RetryPolicy
    func (request SignRequest) String() string
type SignResponse
    func (response SignResponse) HTTPResponse() *http.Response
    func (response SignResponse) String() string
type SignedData
    func (m SignedData) String() string
type SignedDataSigningAlgorithmEnum
    func GetSignedDataSigningAlgorithmEnumValues() []SignedDataSigningAlgorithmEnum
type UpdateKeyDetails
    func (m UpdateKeyDetails) String() string
type UpdateKeyRequest
    func (request UpdateKeyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateKeyRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateKeyRequest) String() string
type UpdateKeyResponse
    func (response UpdateKeyResponse) HTTPResponse() *http.Response
    func (response UpdateKeyResponse) String() string
type UpdateVaultDetails
    func (m UpdateVaultDetails) String() string
type UpdateVaultRequest
    func (request UpdateVaultRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateVaultRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateVaultRequest) String() string
type UpdateVaultResponse
    func (response UpdateVaultResponse) HTTPResponse() *http.Response
    func (response UpdateVaultResponse) String() string
type Vault
    func (m Vault) String() string
type VaultLifecycleStateEnum
    func GetVaultLifecycleStateEnumValues() []VaultLifecycleStateEnum
type VaultSummary
    func (m VaultSummary) String() string
type VaultSummaryLifecycleStateEnum
    func GetVaultSummaryLifecycleStateEnumValues() []VaultSummaryLifecycleStateEnum
type VaultSummaryVaultTypeEnum
    func GetVaultSummaryVaultTypeEnumValues() []VaultSummaryVaultTypeEnum
type VaultUsage
    func (m VaultUsage) String() string
type VaultVaultTypeEnum
    func GetVaultVaultTypeEnumValues() []VaultVaultTypeEnum
type VerifiedData
    func (m VerifiedData) String() string
type VerifyDataDetails
    func (m VerifyDataDetails) String() string
type VerifyDataDetailsMessageTypeEnum
    func GetVerifyDataDetailsMessageTypeEnumValues() []VerifyDataDetailsMessageTypeEnum
type VerifyDataDetailsSigningAlgorithmEnum
    func GetVerifyDataDetailsSigningAlgorithmEnumValues() []VerifyDataDetailsSigningAlgorithmEnum
type VerifyRequest
    func (request VerifyRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request VerifyRequest) RetryPolicy() *common.RetryPolicy
    func (request VerifyRequest) String() string
type VerifyResponse
    func (response VerifyResponse) HTTPResponse() *http.Response
    func (response VerifyResponse) String() string
type WrappedImportKey
    func (m WrappedImportKey) String() string
type WrappedImportKeyWrappingAlgorithmEnum
    func GetWrappedImportKeyWrappingAlgorithmEnumValues() []WrappedImportKeyWrappingAlgorithmEnum
type WrappingKey
    func (m WrappingKey) String() string
type WrappingKeyLifecycleStateEnum
    func GetWrappingKeyLifecycleStateEnumValues() []WrappingKeyLifecycleStateEnum

Package files

backup_key_details.go backup_key_request_response.go backup_location.go backup_location_bucket.go backup_location_uri.go backup_vault_details.go backup_vault_request_response.go cancel_key_deletion_request_response.go cancel_key_version_deletion_request_response.go cancel_vault_deletion_request_response.go change_key_compartment_details.go change_key_compartment_request_response.go change_vault_compartment_details.go change_vault_compartment_request_response.go create_key_details.go create_key_request_response.go create_key_version_request_response.go create_vault_details.go create_vault_request_response.go decrypt_data_details.go decrypt_request_response.go decrypted_data.go disable_key_request_response.go enable_key_request_response.go encrypt_data_details.go encrypt_request_response.go encrypted_data.go export_key_details.go export_key_request_response.go exported_key_data.go generate_data_encryption_key_request_response.go generate_key_details.go generated_key.go get_key_request_response.go get_key_version_request_response.go get_vault_request_response.go get_vault_usage_request_response.go get_wrapping_key_request_response.go import_key_details.go import_key_request_response.go import_key_version_details.go import_key_version_request_response.go key.go key_shape.go key_summary.go key_version.go key_version_summary.go keymanagement_kmscrypto_client.go keymanagement_kmsmanagement_client.go keymanagement_kmsvault_client.go list_key_versions_request_response.go list_keys_request_response.go list_vaults_request_response.go restore_key_from_file_request_response.go restore_key_from_object_store_details.go restore_key_from_object_store_request_response.go restore_vault_from_file_request_response.go restore_vault_from_object_store_details.go restore_vault_from_object_store_request_response.go schedule_key_deletion_details.go schedule_key_deletion_request_response.go schedule_key_version_deletion_details.go schedule_key_version_deletion_request_response.go schedule_vault_deletion_details.go schedule_vault_deletion_request_response.go sign_data_details.go sign_request_response.go signed_data.go update_key_details.go update_key_request_response.go update_vault_details.go update_vault_request_response.go vault.go vault_summary.go vault_usage.go verified_data.go verify_data_details.go verify_request_response.go wrapped_import_key.go wrapping_key.go

type BackupKeyDetails

BackupKeyDetails The representation of BackupKeyDetails

type BackupKeyDetails struct {
    BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
}

func (BackupKeyDetails) String

func (m BackupKeyDetails) String() string

func (*BackupKeyDetails) UnmarshalJSON

func (m *BackupKeyDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type BackupKeyRequest

BackupKeyRequest wrapper for the BackupKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/BackupKey.go.html to see an example of how to use BackupKeyRequest.

type BackupKeyRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // BackupKeyDetails
    BackupKeyDetails `contributesTo:"body"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (BackupKeyRequest) HTTPRequest

func (request BackupKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BackupKeyRequest) RetryPolicy

func (request BackupKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (BackupKeyRequest) String

func (request BackupKeyRequest) String() string

type BackupKeyResponse

BackupKeyResponse wrapper for the BackupKey operation

type BackupKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // Unique Oracle-assigned identifier for the work request, used to track the progress of the
    // backup operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (BackupKeyResponse) HTTPResponse

func (response BackupKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (BackupKeyResponse) String

func (response BackupKeyResponse) String() string

type BackupLocation

BackupLocation Backup upload location

type BackupLocation interface {
}

type BackupLocationBucket

BackupLocationBucket Object storage bucket details to upload or download the backup

type BackupLocationBucket struct {
    Namespace *string `mandatory:"true" json:"namespace"`

    BucketName *string `mandatory:"true" json:"bucketName"`

    ObjectName *string `mandatory:"true" json:"objectName"`
}

func (BackupLocationBucket) MarshalJSON

func (m BackupLocationBucket) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (BackupLocationBucket) String

func (m BackupLocationBucket) String() string

type BackupLocationDestinationEnum

BackupLocationDestinationEnum Enum with underlying type: string

type BackupLocationDestinationEnum string

Set of constants representing the allowable values for BackupLocationDestinationEnum

const (
    BackupLocationDestinationBucket                     BackupLocationDestinationEnum = "BUCKET"
    BackupLocationDestinationPreAuthenticatedRequestUri BackupLocationDestinationEnum = "PRE_AUTHENTICATED_REQUEST_URI"
)

func GetBackupLocationDestinationEnumValues

func GetBackupLocationDestinationEnumValues() []BackupLocationDestinationEnum

GetBackupLocationDestinationEnumValues Enumerates the set of values for BackupLocationDestinationEnum

type BackupLocationUri

BackupLocationUri PreAuthenticated object storage URI to upload or download the backup

type BackupLocationUri struct {
    Uri *string `mandatory:"true" json:"uri"`
}

func (BackupLocationUri) MarshalJSON

func (m BackupLocationUri) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (BackupLocationUri) String

func (m BackupLocationUri) String() string

type BackupVaultDetails

BackupVaultDetails The representation of BackupVaultDetails

type BackupVaultDetails struct {
    BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`

    IsIncludeKeys *bool `mandatory:"false" json:"isIncludeKeys"`
}

func (BackupVaultDetails) String

func (m BackupVaultDetails) String() string

func (*BackupVaultDetails) UnmarshalJSON

func (m *BackupVaultDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type BackupVaultRequest

BackupVaultRequest wrapper for the BackupVault operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/BackupVault.go.html to see an example of how to use BackupVaultRequest.

type BackupVaultRequest struct {

    // The OCID of the vault.
    VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // BackupVaultDetails
    BackupVaultDetails `contributesTo:"body"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (BackupVaultRequest) HTTPRequest

func (request BackupVaultRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BackupVaultRequest) RetryPolicy

func (request BackupVaultRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (BackupVaultRequest) String

func (request BackupVaultRequest) String() string

type BackupVaultResponse

BackupVaultResponse wrapper for the BackupVault operation

type BackupVaultResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Vault instance
    Vault `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // Unique Oracle-assigned identifier for the work request, used to track the progress of the
    // backup operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (BackupVaultResponse) HTTPResponse

func (response BackupVaultResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (BackupVaultResponse) String

func (response BackupVaultResponse) String() string

type CancelKeyDeletionRequest

CancelKeyDeletionRequest wrapper for the CancelKeyDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelKeyDeletion.go.html to see an example of how to use CancelKeyDeletionRequest.

type CancelKeyDeletionRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CancelKeyDeletionRequest) HTTPRequest

func (request CancelKeyDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelKeyDeletionRequest) RetryPolicy

func (request CancelKeyDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelKeyDeletionRequest) String

func (request CancelKeyDeletionRequest) String() string

type CancelKeyDeletionResponse

CancelKeyDeletionResponse wrapper for the CancelKeyDeletion operation

type CancelKeyDeletionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (CancelKeyDeletionResponse) HTTPResponse

func (response CancelKeyDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelKeyDeletionResponse) String

func (response CancelKeyDeletionResponse) String() string

type CancelKeyVersionDeletionRequest

CancelKeyVersionDeletionRequest wrapper for the CancelKeyVersionDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelKeyVersionDeletion.go.html to see an example of how to use CancelKeyVersionDeletionRequest.

type CancelKeyVersionDeletionRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // The OCID of the key version.
    KeyVersionId *string `mandatory:"true" contributesTo:"path" name:"keyVersionId"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CancelKeyVersionDeletionRequest) HTTPRequest

func (request CancelKeyVersionDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelKeyVersionDeletionRequest) RetryPolicy

func (request CancelKeyVersionDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelKeyVersionDeletionRequest) String

func (request CancelKeyVersionDeletionRequest) String() string

type CancelKeyVersionDeletionResponse

CancelKeyVersionDeletionResponse wrapper for the CancelKeyVersionDeletion operation

type CancelKeyVersionDeletionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The KeyVersion instance
    KeyVersion `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (CancelKeyVersionDeletionResponse) HTTPResponse

func (response CancelKeyVersionDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelKeyVersionDeletionResponse) String

func (response CancelKeyVersionDeletionResponse) String() string

type CancelVaultDeletionRequest

CancelVaultDeletionRequest wrapper for the CancelVaultDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelVaultDeletion.go.html to see an example of how to use CancelVaultDeletionRequest.

type CancelVaultDeletionRequest struct {

    // The OCID of the vault.
    VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CancelVaultDeletionRequest) HTTPRequest

func (request CancelVaultDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelVaultDeletionRequest) RetryPolicy

func (request CancelVaultDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelVaultDeletionRequest) String

func (request CancelVaultDeletionRequest) String() string

type CancelVaultDeletionResponse

CancelVaultDeletionResponse wrapper for the CancelVaultDeletion operation

type CancelVaultDeletionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Vault instance
    Vault `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (CancelVaultDeletionResponse) HTTPResponse

func (response CancelVaultDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelVaultDeletionResponse) String

func (response CancelVaultDeletionResponse) String() string

type ChangeKeyCompartmentDetails

ChangeKeyCompartmentDetails The representation of ChangeKeyCompartmentDetails

type ChangeKeyCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that you want to move the key to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeKeyCompartmentDetails) String

func (m ChangeKeyCompartmentDetails) String() string

type ChangeKeyCompartmentRequest

ChangeKeyCompartmentRequest wrapper for the ChangeKeyCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ChangeKeyCompartment.go.html to see an example of how to use ChangeKeyCompartmentRequest.

type ChangeKeyCompartmentRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    ChangeKeyCompartmentDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ChangeKeyCompartmentRequest) HTTPRequest

func (request ChangeKeyCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeKeyCompartmentRequest) RetryPolicy

func (request ChangeKeyCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeKeyCompartmentRequest) String

func (request ChangeKeyCompartmentRequest) String() string

type ChangeKeyCompartmentResponse

ChangeKeyCompartmentResponse wrapper for the ChangeKeyCompartment operation

type ChangeKeyCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ChangeKeyCompartmentResponse) HTTPResponse

func (response ChangeKeyCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeKeyCompartmentResponse) String

func (response ChangeKeyCompartmentResponse) String() string

type ChangeVaultCompartmentDetails

ChangeVaultCompartmentDetails The representation of ChangeVaultCompartmentDetails

type ChangeVaultCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment to move the vault to.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeVaultCompartmentDetails) String

func (m ChangeVaultCompartmentDetails) String() string

type ChangeVaultCompartmentRequest

ChangeVaultCompartmentRequest wrapper for the ChangeVaultCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ChangeVaultCompartment.go.html to see an example of how to use ChangeVaultCompartmentRequest.

type ChangeVaultCompartmentRequest struct {

    // The OCID of the vault.
    VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`

    ChangeVaultCompartmentDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ChangeVaultCompartmentRequest) HTTPRequest

func (request ChangeVaultCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeVaultCompartmentRequest) RetryPolicy

func (request ChangeVaultCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeVaultCompartmentRequest) String

func (request ChangeVaultCompartmentRequest) String() string

type ChangeVaultCompartmentResponse

ChangeVaultCompartmentResponse wrapper for the ChangeVaultCompartment operation

type ChangeVaultCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ChangeVaultCompartmentResponse) HTTPResponse

func (response ChangeVaultCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeVaultCompartmentResponse) String

func (response ChangeVaultCompartmentResponse) String() string

type CreateKeyDetails

CreateKeyDetails The representation of CreateKeyDetails

type CreateKeyDetails struct {

    // The OCID of the compartment where you want to create the master encryption key.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name for the key. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    KeyShape *KeyShape `mandatory:"true" json:"keyShape"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
    // A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
    // the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists
    // on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default,
    // a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported.
    ProtectionMode CreateKeyDetailsProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"`
}

func (CreateKeyDetails) String

func (m CreateKeyDetails) String() string

type CreateKeyDetailsProtectionModeEnum

CreateKeyDetailsProtectionModeEnum Enum with underlying type: string

type CreateKeyDetailsProtectionModeEnum string

Set of constants representing the allowable values for CreateKeyDetailsProtectionModeEnum

const (
    CreateKeyDetailsProtectionModeHsm      CreateKeyDetailsProtectionModeEnum = "HSM"
    CreateKeyDetailsProtectionModeSoftware CreateKeyDetailsProtectionModeEnum = "SOFTWARE"
)

func GetCreateKeyDetailsProtectionModeEnumValues

func GetCreateKeyDetailsProtectionModeEnumValues() []CreateKeyDetailsProtectionModeEnum

GetCreateKeyDetailsProtectionModeEnumValues Enumerates the set of values for CreateKeyDetailsProtectionModeEnum

type CreateKeyRequest

CreateKeyRequest wrapper for the CreateKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateKey.go.html to see an example of how to use CreateKeyRequest.

type CreateKeyRequest struct {

    // CreateKeyDetails
    CreateKeyDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CreateKeyRequest) HTTPRequest

func (request CreateKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateKeyRequest) RetryPolicy

func (request CreateKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateKeyRequest) String

func (request CreateKeyRequest) String() string

type CreateKeyResponse

CreateKeyResponse wrapper for the CreateKey operation

type CreateKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (CreateKeyResponse) HTTPResponse

func (response CreateKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateKeyResponse) String

func (response CreateKeyResponse) String() string

type CreateKeyVersionRequest

CreateKeyVersionRequest wrapper for the CreateKeyVersion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateKeyVersion.go.html to see an example of how to use CreateKeyVersionRequest.

type CreateKeyVersionRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CreateKeyVersionRequest) HTTPRequest

func (request CreateKeyVersionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateKeyVersionRequest) RetryPolicy

func (request CreateKeyVersionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateKeyVersionRequest) String

func (request CreateKeyVersionRequest) String() string

type CreateKeyVersionResponse

CreateKeyVersionResponse wrapper for the CreateKeyVersion operation

type CreateKeyVersionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The KeyVersion instance
    KeyVersion `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (CreateKeyVersionResponse) HTTPResponse

func (response CreateKeyVersionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateKeyVersionResponse) String

func (response CreateKeyVersionResponse) String() string

type CreateVaultDetails

CreateVaultDetails The representation of CreateVaultDetails

type CreateVaultDetails struct {

    // The OCID of the compartment where you want to create this vault.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name for the vault. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The type of vault to create. Each type of vault stores the key with different degrees of isolation and has different options and pricing.
    VaultType CreateVaultDetailsVaultTypeEnum `mandatory:"true" json:"vaultType"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

func (CreateVaultDetails) String

func (m CreateVaultDetails) String() string

type CreateVaultDetailsVaultTypeEnum

CreateVaultDetailsVaultTypeEnum Enum with underlying type: string

type CreateVaultDetailsVaultTypeEnum string

Set of constants representing the allowable values for CreateVaultDetailsVaultTypeEnum

const (
    CreateVaultDetailsVaultTypeVirtualPrivate CreateVaultDetailsVaultTypeEnum = "VIRTUAL_PRIVATE"
    CreateVaultDetailsVaultTypeDefault        CreateVaultDetailsVaultTypeEnum = "DEFAULT"
)

func GetCreateVaultDetailsVaultTypeEnumValues

func GetCreateVaultDetailsVaultTypeEnumValues() []CreateVaultDetailsVaultTypeEnum

GetCreateVaultDetailsVaultTypeEnumValues Enumerates the set of values for CreateVaultDetailsVaultTypeEnum

type CreateVaultRequest

CreateVaultRequest wrapper for the CreateVault operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateVault.go.html to see an example of how to use CreateVaultRequest.

type CreateVaultRequest struct {

    // CreateVaultDetails
    CreateVaultDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CreateVaultRequest) HTTPRequest

func (request CreateVaultRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVaultRequest) RetryPolicy

func (request CreateVaultRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateVaultRequest) String

func (request CreateVaultRequest) String() string

type CreateVaultResponse

CreateVaultResponse wrapper for the CreateVault operation

type CreateVaultResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Vault instance
    Vault `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (CreateVaultResponse) HTTPResponse

func (response CreateVaultResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateVaultResponse) String

func (response CreateVaultResponse) String() string

type DecryptDataDetails

DecryptDataDetails The representation of DecryptDataDetails

type DecryptDataDetails struct {

    // The encrypted data to decrypt.
    Ciphertext *string `mandatory:"true" json:"ciphertext"`

    // The OCID of the key used to encrypt the ciphertext.
    KeyId *string `mandatory:"true" json:"keyId"`

    // Information that can be used to provide an encryption context for the encrypted data.
    // The length of the string representation of the associated data must be fewer than 4096 characters.
    AssociatedData map[string]string `mandatory:"false" json:"associatedData"`

    // Information that provides context for audit logging. You can provide this additional
    // data as key-value pairs to include in audit logs when audit logging is enabled.
    LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`

    // The OCID of the keyVersion used to encrypt the ciphertext.
    KeyVersionId *string `mandatory:"false" json:"keyVersionId"`

    // Encryption algorithm to be used while encrypting/decrypting data using a customer key
    // AES_256_GCM is the supported value AES keys and uses GCM mode of operation
    // RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding.
    EncryptionAlgorithm DecryptDataDetailsEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
}

func (DecryptDataDetails) String

func (m DecryptDataDetails) String() string

type DecryptDataDetailsEncryptionAlgorithmEnum

DecryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string

type DecryptDataDetailsEncryptionAlgorithmEnum string

Set of constants representing the allowable values for DecryptDataDetailsEncryptionAlgorithmEnum

const (
    DecryptDataDetailsEncryptionAlgorithmAes256Gcm     DecryptDataDetailsEncryptionAlgorithmEnum = "AES_256_GCM"
    DecryptDataDetailsEncryptionAlgorithmRsaOaepSha1   DecryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1"
    DecryptDataDetailsEncryptionAlgorithmRsaOaepSha256 DecryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256"
)

func GetDecryptDataDetailsEncryptionAlgorithmEnumValues

func GetDecryptDataDetailsEncryptionAlgorithmEnumValues() []DecryptDataDetailsEncryptionAlgorithmEnum

GetDecryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptDataDetailsEncryptionAlgorithmEnum

type DecryptRequest

DecryptRequest wrapper for the Decrypt operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Decrypt.go.html to see an example of how to use DecryptRequest.

type DecryptRequest struct {

    // DecryptDataDetails
    DecryptDataDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (DecryptRequest) HTTPRequest

func (request DecryptRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DecryptRequest) RetryPolicy

func (request DecryptRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DecryptRequest) String

func (request DecryptRequest) String() string

type DecryptResponse

DecryptResponse wrapper for the Decrypt operation

type DecryptResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The DecryptedData instance
    DecryptedData `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (DecryptResponse) HTTPResponse

func (response DecryptResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DecryptResponse) String

func (response DecryptResponse) String() string

type DecryptedData

DecryptedData The representation of DecryptedData

type DecryptedData struct {

    // The decrypted data, expressed as a base64-encoded value.
    Plaintext *string `mandatory:"true" json:"plaintext"`

    // Checksum of the decrypted data.
    PlaintextChecksum *string `mandatory:"true" json:"plaintextChecksum"`

    // The OCID of the key used to encrypt the ciphertext.
    KeyId *string `mandatory:"false" json:"keyId"`

    // The OCID of the keyVersion used to encrypt the ciphertext.
    KeyVersionId *string `mandatory:"false" json:"keyVersionId"`

    // Encryption algorithm to be used while encrypting/decrypting data using a customer key
    // AES_256_GCM is the supported value AES keys and uses GCM mode of operation
    // RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding.
    EncryptionAlgorithm DecryptedDataEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
}

func (DecryptedData) String

func (m DecryptedData) String() string

type DecryptedDataEncryptionAlgorithmEnum

DecryptedDataEncryptionAlgorithmEnum Enum with underlying type: string

type DecryptedDataEncryptionAlgorithmEnum string

Set of constants representing the allowable values for DecryptedDataEncryptionAlgorithmEnum

const (
    DecryptedDataEncryptionAlgorithmAes256Gcm     DecryptedDataEncryptionAlgorithmEnum = "AES_256_GCM"
    DecryptedDataEncryptionAlgorithmRsaOaepSha1   DecryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1"
    DecryptedDataEncryptionAlgorithmRsaOaepSha256 DecryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256"
)

func GetDecryptedDataEncryptionAlgorithmEnumValues

func GetDecryptedDataEncryptionAlgorithmEnumValues() []DecryptedDataEncryptionAlgorithmEnum

GetDecryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptedDataEncryptionAlgorithmEnum

type DisableKeyRequest

DisableKeyRequest wrapper for the DisableKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/DisableKey.go.html to see an example of how to use DisableKeyRequest.

type DisableKeyRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (DisableKeyRequest) HTTPRequest

func (request DisableKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DisableKeyRequest) RetryPolicy

func (request DisableKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DisableKeyRequest) String

func (request DisableKeyRequest) String() string

type DisableKeyResponse

DisableKeyResponse wrapper for the DisableKey operation

type DisableKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (DisableKeyResponse) HTTPResponse

func (response DisableKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DisableKeyResponse) String

func (response DisableKeyResponse) String() string

type EnableKeyRequest

EnableKeyRequest wrapper for the EnableKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/EnableKey.go.html to see an example of how to use EnableKeyRequest.

type EnableKeyRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (EnableKeyRequest) HTTPRequest

func (request EnableKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (EnableKeyRequest) RetryPolicy

func (request EnableKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (EnableKeyRequest) String

func (request EnableKeyRequest) String() string

type EnableKeyResponse

EnableKeyResponse wrapper for the EnableKey operation

type EnableKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (EnableKeyResponse) HTTPResponse

func (response EnableKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (EnableKeyResponse) String

func (response EnableKeyResponse) String() string

type EncryptDataDetails

EncryptDataDetails The representation of EncryptDataDetails

type EncryptDataDetails struct {

    // The OCID of the key to encrypt with.
    KeyId *string `mandatory:"true" json:"keyId"`

    // The plaintext data to encrypt.
    Plaintext *string `mandatory:"true" json:"plaintext"`

    // Information that can be used to provide an encryption context for the
    // encrypted data. The length of the string representation of the associated data
    // must be fewer than 4096 characters.
    AssociatedData map[string]string `mandatory:"false" json:"associatedData"`

    // Information that provides context for audit logging. You can provide this additional
    // data as key-value pairs to include in the audit logs when audit logging is enabled.
    LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`

    // The OCID of the keyVersion used to encrypt the ciphertext.
    KeyVersionId *string `mandatory:"false" json:"keyVersionId"`

    // Encryption algorithm to be used while encrypting/decrypting data using a customer key
    // AES_256_GCM is the supported value AES keys and uses GCM mode of operation
    // RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding.
    EncryptionAlgorithm EncryptDataDetailsEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
}

func (EncryptDataDetails) String

func (m EncryptDataDetails) String() string

type EncryptDataDetailsEncryptionAlgorithmEnum

EncryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string

type EncryptDataDetailsEncryptionAlgorithmEnum string

Set of constants representing the allowable values for EncryptDataDetailsEncryptionAlgorithmEnum

const (
    EncryptDataDetailsEncryptionAlgorithmAes256Gcm     EncryptDataDetailsEncryptionAlgorithmEnum = "AES_256_GCM"
    EncryptDataDetailsEncryptionAlgorithmRsaOaepSha1   EncryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1"
    EncryptDataDetailsEncryptionAlgorithmRsaOaepSha256 EncryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256"
)

func GetEncryptDataDetailsEncryptionAlgorithmEnumValues

func GetEncryptDataDetailsEncryptionAlgorithmEnumValues() []EncryptDataDetailsEncryptionAlgorithmEnum

GetEncryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptDataDetailsEncryptionAlgorithmEnum

type EncryptRequest

EncryptRequest wrapper for the Encrypt operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Encrypt.go.html to see an example of how to use EncryptRequest.

type EncryptRequest struct {

    // EncryptDataDetails
    EncryptDataDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (EncryptRequest) HTTPRequest

func (request EncryptRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (EncryptRequest) RetryPolicy

func (request EncryptRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (EncryptRequest) String

func (request EncryptRequest) String() string

type EncryptResponse

EncryptResponse wrapper for the Encrypt operation

type EncryptResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The EncryptedData instance
    EncryptedData `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (EncryptResponse) HTTPResponse

func (response EncryptResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (EncryptResponse) String

func (response EncryptResponse) String() string

type EncryptedData

EncryptedData The representation of EncryptedData

type EncryptedData struct {

    // The encrypted data.
    Ciphertext *string `mandatory:"true" json:"ciphertext"`

    // The OCID of the key used to sign the message
    KeyId *string `mandatory:"false" json:"keyId"`

    // The OCID of the keyVersion used to encrypt the ciphertext.
    KeyVersionId *string `mandatory:"false" json:"keyVersionId"`

    // Encryption algorithm to be used while encrypting/decrypting data using a customer key
    // AES_256_GCM is the supported value AES keys and uses GCM mode of operation
    // RSA_OAEP_SHA_1 and RSA_OAEP_SHA_256 are supported for RSA keys and use OAEP padding.
    EncryptionAlgorithm EncryptedDataEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
}

func (EncryptedData) String

func (m EncryptedData) String() string

type EncryptedDataEncryptionAlgorithmEnum

EncryptedDataEncryptionAlgorithmEnum Enum with underlying type: string

type EncryptedDataEncryptionAlgorithmEnum string

Set of constants representing the allowable values for EncryptedDataEncryptionAlgorithmEnum

const (
    EncryptedDataEncryptionAlgorithmAes256Gcm     EncryptedDataEncryptionAlgorithmEnum = "AES_256_GCM"
    EncryptedDataEncryptionAlgorithmRsaOaepSha1   EncryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1"
    EncryptedDataEncryptionAlgorithmRsaOaepSha256 EncryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256"
)

func GetEncryptedDataEncryptionAlgorithmEnumValues

func GetEncryptedDataEncryptionAlgorithmEnumValues() []EncryptedDataEncryptionAlgorithmEnum

GetEncryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptedDataEncryptionAlgorithmEnum

type ExportKeyDetails

ExportKeyDetails The details of the key that you want to wrap and export.

type ExportKeyDetails struct {

    // The OCID of the master encryption key associated with the key version you want to export.
    KeyId *string `mandatory:"true" json:"keyId"`

    // The encryption algorithm to use to encrypt exportable key material from a software-backed key. Specifying `RSA_OAEP_AES_SHA256`
    // invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public
    // wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap
    // the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing
    // concatenated blob output that jointly represents them. Specifying `RSA_OAEP_SHA256` means that the software key is wrapped by
    // the RSA public wrapping key provided along with the request.
    Algorithm ExportKeyDetailsAlgorithmEnum `mandatory:"true" json:"algorithm"`

    // The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the key.
    PublicKey *string `mandatory:"true" json:"publicKey"`

    // The OCID of the specific key version to export. If not specified, the service exports the current key version.
    KeyVersionId *string `mandatory:"false" json:"keyVersionId"`

    // Information that provides context for audit logging. You can provide this additional
    // data as key-value pairs to include in the audit logs when audit logging is enabled.
    LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`
}

func (ExportKeyDetails) String

func (m ExportKeyDetails) String() string

type ExportKeyDetailsAlgorithmEnum

ExportKeyDetailsAlgorithmEnum Enum with underlying type: string

type ExportKeyDetailsAlgorithmEnum string

Set of constants representing the allowable values for ExportKeyDetailsAlgorithmEnum

const (
    ExportKeyDetailsAlgorithmAesSha256 ExportKeyDetailsAlgorithmEnum = "RSA_OAEP_AES_SHA256"
    ExportKeyDetailsAlgorithmSha256    ExportKeyDetailsAlgorithmEnum = "RSA_OAEP_SHA256"
)

func GetExportKeyDetailsAlgorithmEnumValues

func GetExportKeyDetailsAlgorithmEnumValues() []ExportKeyDetailsAlgorithmEnum

GetExportKeyDetailsAlgorithmEnumValues Enumerates the set of values for ExportKeyDetailsAlgorithmEnum

type ExportKeyRequest

ExportKeyRequest wrapper for the ExportKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ExportKey.go.html to see an example of how to use ExportKeyRequest.

type ExportKeyRequest struct {

    // ExportKeyDetails
    ExportKeyDetails `contributesTo:"body"`

    // Unique Oracle-assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ExportKeyRequest) HTTPRequest

func (request ExportKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ExportKeyRequest) RetryPolicy

func (request ExportKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ExportKeyRequest) String

func (request ExportKeyRequest) String() string

type ExportKeyResponse

ExportKeyResponse wrapper for the ExportKey operation

type ExportKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The ExportedKeyData instance
    ExportedKeyData `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ExportKeyResponse) HTTPResponse

func (response ExportKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ExportKeyResponse) String

func (response ExportKeyResponse) String() string

type ExportedKeyData

ExportedKeyData The response to a request to export key material.

type ExportedKeyData struct {

    // The OCID of the key version.
    KeyVersionId *string `mandatory:"true" json:"keyVersionId"`

    // The OCID of the master encryption key associated with this key version.
    KeyId *string `mandatory:"true" json:"keyId"`

    // The date and time this key version was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The OCID of the vault that contains this key version.
    VaultId *string `mandatory:"true" json:"vaultId"`

    // The base64-encoded exported key material, which is encrypted by using the public RSA wrapping key specified in the export request.
    EncryptedKey *string `mandatory:"true" json:"encryptedKey"`

    // The encryption algorithm to use to encrypt exportable key material from a key that persists on the server (as opposed to a key that
    // persists on a hardware security module and, therefore, cannot be exported). Specifying RSA_OAEP_AES_SHA256 invokes the RSA AES key
    // wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along
    // with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The
    // wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly
    // represents them. Specifying RSA_OAEP_SHA256 means that the exportable key material is wrapped by the RSA public wrapping key provided
    // along with the request.
    Algorithm ExportedKeyDataAlgorithmEnum `mandatory:"true" json:"algorithm"`
}

func (ExportedKeyData) String

func (m ExportedKeyData) String() string

type ExportedKeyDataAlgorithmEnum

ExportedKeyDataAlgorithmEnum Enum with underlying type: string

type ExportedKeyDataAlgorithmEnum string

Set of constants representing the allowable values for ExportedKeyDataAlgorithmEnum

const (
    ExportedKeyDataAlgorithmAesSha256 ExportedKeyDataAlgorithmEnum = "RSA_OAEP_AES_SHA256"
    ExportedKeyDataAlgorithmSha256    ExportedKeyDataAlgorithmEnum = "RSA_OAEP_SHA256"
)

func GetExportedKeyDataAlgorithmEnumValues

func GetExportedKeyDataAlgorithmEnumValues() []ExportedKeyDataAlgorithmEnum

GetExportedKeyDataAlgorithmEnumValues Enumerates the set of values for ExportedKeyDataAlgorithmEnum

type GenerateDataEncryptionKeyRequest

GenerateDataEncryptionKeyRequest wrapper for the GenerateDataEncryptionKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GenerateDataEncryptionKey.go.html to see an example of how to use GenerateDataEncryptionKeyRequest.

type GenerateDataEncryptionKeyRequest struct {

    // GenerateKeyDetails
    GenerateKeyDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GenerateDataEncryptionKeyRequest) HTTPRequest

func (request GenerateDataEncryptionKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GenerateDataEncryptionKeyRequest) RetryPolicy

func (request GenerateDataEncryptionKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GenerateDataEncryptionKeyRequest) String

func (request GenerateDataEncryptionKeyRequest) String() string

type GenerateDataEncryptionKeyResponse

GenerateDataEncryptionKeyResponse wrapper for the GenerateDataEncryptionKey operation

type GenerateDataEncryptionKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The GeneratedKey instance
    GeneratedKey `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GenerateDataEncryptionKeyResponse) HTTPResponse

func (response GenerateDataEncryptionKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GenerateDataEncryptionKeyResponse) String

func (response GenerateDataEncryptionKeyResponse) String() string

type GenerateKeyDetails

GenerateKeyDetails The representation of GenerateKeyDetails

type GenerateKeyDetails struct {

    // If true, the generated key is also returned unencrypted.
    IncludePlaintextKey *bool `mandatory:"true" json:"includePlaintextKey"`

    // The OCID of the master encryption key to encrypt the generated data encryption key with.
    KeyId *string `mandatory:"true" json:"keyId"`

    KeyShape *KeyShape `mandatory:"true" json:"keyShape"`

    // Information that can be used to provide an encryption context for the encrypted data.
    // The length of the string representation of the associated data must be fewer than 4096
    // characters.
    AssociatedData map[string]string `mandatory:"false" json:"associatedData"`

    // Information that provides context for audit logging. You can provide this additional
    // data by formatting it as key-value pairs to include in audit logs when audit logging is enabled.
    LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`
}

func (GenerateKeyDetails) String

func (m GenerateKeyDetails) String() string

type GeneratedKey

GeneratedKey The representation of GeneratedKey

type GeneratedKey struct {

    // The encrypted data encryption key generated from a master encryption key.
    Ciphertext *string `mandatory:"true" json:"ciphertext"`

    // The plaintext data encryption key, a base64-encoded sequence of random bytes, which is
    // included if the GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey)
    // request includes the `includePlaintextKey` parameter and sets its value to "true".
    Plaintext *string `mandatory:"false" json:"plaintext"`

    // The checksum of the plaintext data encryption key, which is included if the
    // GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey)
    // request includes the `includePlaintextKey` parameter and sets its value to "true".
    PlaintextChecksum *string `mandatory:"false" json:"plaintextChecksum"`
}

func (GeneratedKey) String

func (m GeneratedKey) String() string

type GetKeyRequest

GetKeyRequest wrapper for the GetKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetKey.go.html to see an example of how to use GetKeyRequest.

type GetKeyRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetKeyRequest) HTTPRequest

func (request GetKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetKeyRequest) RetryPolicy

func (request GetKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetKeyRequest) String

func (request GetKeyRequest) String() string

type GetKeyResponse

GetKeyResponse wrapper for the GetKey operation

type GetKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetKeyResponse) HTTPResponse

func (response GetKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetKeyResponse) String

func (response GetKeyResponse) String() string

type GetKeyVersionRequest

GetKeyVersionRequest wrapper for the GetKeyVersion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetKeyVersion.go.html to see an example of how to use GetKeyVersionRequest.

type GetKeyVersionRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // The OCID of the key version.
    KeyVersionId *string `mandatory:"true" contributesTo:"path" name:"keyVersionId"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetKeyVersionRequest) HTTPRequest

func (request GetKeyVersionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetKeyVersionRequest) RetryPolicy

func (request GetKeyVersionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetKeyVersionRequest) String

func (request GetKeyVersionRequest) String() string

type GetKeyVersionResponse

GetKeyVersionResponse wrapper for the GetKeyVersion operation

type GetKeyVersionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The KeyVersion instance
    KeyVersion `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetKeyVersionResponse) HTTPResponse

func (response GetKeyVersionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetKeyVersionResponse) String

func (response GetKeyVersionResponse) String() string

type GetVaultRequest

GetVaultRequest wrapper for the GetVault operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetVault.go.html to see an example of how to use GetVaultRequest.

type GetVaultRequest struct {

    // The OCID of the vault.
    VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetVaultRequest) HTTPRequest

func (request GetVaultRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVaultRequest) RetryPolicy

func (request GetVaultRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVaultRequest) String

func (request GetVaultRequest) String() string

type GetVaultResponse

GetVaultResponse wrapper for the GetVault operation

type GetVaultResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Vault instance
    Vault `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetVaultResponse) HTTPResponse

func (response GetVaultResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVaultResponse) String

func (response GetVaultResponse) String() string

type GetVaultUsageRequest

GetVaultUsageRequest wrapper for the GetVaultUsage operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetVaultUsage.go.html to see an example of how to use GetVaultUsageRequest.

type GetVaultUsageRequest struct {

    // The OCID of the vault.
    VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetVaultUsageRequest) HTTPRequest

func (request GetVaultUsageRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVaultUsageRequest) RetryPolicy

func (request GetVaultUsageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVaultUsageRequest) String

func (request GetVaultUsageRequest) String() string

type GetVaultUsageResponse

GetVaultUsageResponse wrapper for the GetVaultUsage operation

type GetVaultUsageResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The VaultUsage instance
    VaultUsage `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetVaultUsageResponse) HTTPResponse

func (response GetVaultUsageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVaultUsageResponse) String

func (response GetVaultUsageResponse) String() string

type GetWrappingKeyRequest

GetWrappingKeyRequest wrapper for the GetWrappingKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetWrappingKey.go.html to see an example of how to use GetWrappingKeyRequest.

type GetWrappingKeyRequest struct {

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetWrappingKeyRequest) HTTPRequest

func (request GetWrappingKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWrappingKeyRequest) RetryPolicy

func (request GetWrappingKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWrappingKeyRequest) String

func (request GetWrappingKeyRequest) String() string

type GetWrappingKeyResponse

GetWrappingKeyResponse wrapper for the GetWrappingKey operation

type GetWrappingKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The WrappingKey instance
    WrappingKey `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetWrappingKeyResponse) HTTPResponse

func (response GetWrappingKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWrappingKeyResponse) String

func (response GetWrappingKeyResponse) String() string

type ImportKeyDetails

ImportKeyDetails The representation of ImportKeyDetails

type ImportKeyDetails struct {

    // The OCID of the compartment that contains this key.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name for the key. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    KeyShape *KeyShape `mandatory:"true" json:"keyShape"`

    WrappedImportKey *WrappedImportKey `mandatory:"true" json:"wrappedImportKey"`

    // Usage of predefined tag keys. These predefined keys are scoped to namespaces.
    // Example: `{"foo-namespace": {"bar-key": "foo-value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Simple key-value pair that is applied without any predefined name, type, or scope.
    // Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
    // A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
    // the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists
    // on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default,
    // a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported.
    ProtectionMode ImportKeyDetailsProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"`
}

func (ImportKeyDetails) String

func (m ImportKeyDetails) String() string

type ImportKeyDetailsProtectionModeEnum

ImportKeyDetailsProtectionModeEnum Enum with underlying type: string

type ImportKeyDetailsProtectionModeEnum string

Set of constants representing the allowable values for ImportKeyDetailsProtectionModeEnum

const (
    ImportKeyDetailsProtectionModeHsm      ImportKeyDetailsProtectionModeEnum = "HSM"
    ImportKeyDetailsProtectionModeSoftware ImportKeyDetailsProtectionModeEnum = "SOFTWARE"
)

func GetImportKeyDetailsProtectionModeEnumValues

func GetImportKeyDetailsProtectionModeEnumValues() []ImportKeyDetailsProtectionModeEnum

GetImportKeyDetailsProtectionModeEnumValues Enumerates the set of values for ImportKeyDetailsProtectionModeEnum

type ImportKeyRequest

ImportKeyRequest wrapper for the ImportKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ImportKey.go.html to see an example of how to use ImportKeyRequest.

type ImportKeyRequest struct {

    // ImportKeyDetails
    ImportKeyDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ImportKeyRequest) HTTPRequest

func (request ImportKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ImportKeyRequest) RetryPolicy

func (request ImportKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ImportKeyRequest) String

func (request ImportKeyRequest) String() string

type ImportKeyResponse

ImportKeyResponse wrapper for the ImportKey operation

type ImportKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ImportKeyResponse) HTTPResponse

func (response ImportKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ImportKeyResponse) String

func (response ImportKeyResponse) String() string

type ImportKeyVersionDetails

ImportKeyVersionDetails The representation of ImportKeyVersionDetails

type ImportKeyVersionDetails struct {
    WrappedImportKey *WrappedImportKey `mandatory:"true" json:"wrappedImportKey"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

func (ImportKeyVersionDetails) String

func (m ImportKeyVersionDetails) String() string

type ImportKeyVersionRequest

ImportKeyVersionRequest wrapper for the ImportKeyVersion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ImportKeyVersion.go.html to see an example of how to use ImportKeyVersionRequest.

type ImportKeyVersionRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // ImportKeyVersionDetails
    ImportKeyVersionDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ImportKeyVersionRequest) HTTPRequest

func (request ImportKeyVersionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ImportKeyVersionRequest) RetryPolicy

func (request ImportKeyVersionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ImportKeyVersionRequest) String

func (request ImportKeyVersionRequest) String() string

type ImportKeyVersionResponse

ImportKeyVersionResponse wrapper for the ImportKeyVersion operation

type ImportKeyVersionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The KeyVersion instance
    KeyVersion `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ImportKeyVersionResponse) HTTPResponse

func (response ImportKeyVersionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ImportKeyVersionResponse) String

func (response ImportKeyVersionResponse) String() string

type Key

Key The representation of Key

type Key struct {

    // The OCID of the compartment that contains this master encryption key.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The OCID of the key version used in cryptographic operations. During key rotation, the service might be
    // in a transitional state where this or a newer key version are used intermittently. The `currentKeyVersion`
    // property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
    CurrentKeyVersion *string `mandatory:"true" json:"currentKeyVersion"`

    // A user-friendly name for the key. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID of the key.
    Id *string `mandatory:"true" json:"id"`

    KeyShape *KeyShape `mandatory:"true" json:"keyShape"`

    // The key's current lifecycle state.
    // Example: `ENABLED`
    LifecycleState KeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The date and time the key was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The OCID of the vault that contains this key.
    VaultId *string `mandatory:"true" json:"vaultId"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
    // A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
    // the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists
    // on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default,
    // a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported.
    ProtectionMode KeyProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"`

    // An optional property indicating when to delete the key, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2019-04-03T21:10:29.600Z`
    TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`

    // The OCID of the key from which this key was restored.
    RestoredFromKeyId *string `mandatory:"false" json:"restoredFromKeyId"`
}

func (Key) String

func (m Key) String() string

type KeyLifecycleStateEnum

KeyLifecycleStateEnum Enum with underlying type: string

type KeyLifecycleStateEnum string

Set of constants representing the allowable values for KeyLifecycleStateEnum

const (
    KeyLifecycleStateCreating           KeyLifecycleStateEnum = "CREATING"
    KeyLifecycleStateEnabling           KeyLifecycleStateEnum = "ENABLING"
    KeyLifecycleStateEnabled            KeyLifecycleStateEnum = "ENABLED"
    KeyLifecycleStateDisabling          KeyLifecycleStateEnum = "DISABLING"
    KeyLifecycleStateDisabled           KeyLifecycleStateEnum = "DISABLED"
    KeyLifecycleStateDeleting           KeyLifecycleStateEnum = "DELETING"
    KeyLifecycleStateDeleted            KeyLifecycleStateEnum = "DELETED"
    KeyLifecycleStatePendingDeletion    KeyLifecycleStateEnum = "PENDING_DELETION"
    KeyLifecycleStateSchedulingDeletion KeyLifecycleStateEnum = "SCHEDULING_DELETION"
    KeyLifecycleStateCancellingDeletion KeyLifecycleStateEnum = "CANCELLING_DELETION"
    KeyLifecycleStateUpdating           KeyLifecycleStateEnum = "UPDATING"
    KeyLifecycleStateBackupInProgress   KeyLifecycleStateEnum = "BACKUP_IN_PROGRESS"
    KeyLifecycleStateRestoring          KeyLifecycleStateEnum = "RESTORING"
)

func GetKeyLifecycleStateEnumValues

func GetKeyLifecycleStateEnumValues() []KeyLifecycleStateEnum

GetKeyLifecycleStateEnumValues Enumerates the set of values for KeyLifecycleStateEnum

type KeyProtectionModeEnum

KeyProtectionModeEnum Enum with underlying type: string

type KeyProtectionModeEnum string

Set of constants representing the allowable values for KeyProtectionModeEnum

const (
    KeyProtectionModeHsm      KeyProtectionModeEnum = "HSM"
    KeyProtectionModeSoftware KeyProtectionModeEnum = "SOFTWARE"
)

func GetKeyProtectionModeEnumValues

func GetKeyProtectionModeEnumValues() []KeyProtectionModeEnum

GetKeyProtectionModeEnumValues Enumerates the set of values for KeyProtectionModeEnum

type KeyShape

KeyShape The cryptographic properties of a key.

type KeyShape struct {

    // The algorithm used by a key's key versions to encrypt or decrypt.
    Algorithm KeyShapeAlgorithmEnum `mandatory:"true" json:"algorithm"`

    // The length of the key in bytes, expressed as an integer. Values supported:
    //   - AES: 16, 24 or 32
    //   - RSA: 256, 384 or 512
    //   - ECDSA: 32, 48, 66
    Length *int `mandatory:"true" json:"length"`

    // Supported curve Ids for ECDSA keys
    CurveId KeyShapeCurveIdEnum `mandatory:"false" json:"curveId,omitempty"`
}

func (KeyShape) String

func (m KeyShape) String() string

type KeyShapeAlgorithmEnum

KeyShapeAlgorithmEnum Enum with underlying type: string

type KeyShapeAlgorithmEnum string

Set of constants representing the allowable values for KeyShapeAlgorithmEnum

const (
    KeyShapeAlgorithmAes   KeyShapeAlgorithmEnum = "AES"
    KeyShapeAlgorithmRsa   KeyShapeAlgorithmEnum = "RSA"
    KeyShapeAlgorithmEcdsa KeyShapeAlgorithmEnum = "ECDSA"
)

func GetKeyShapeAlgorithmEnumValues

func GetKeyShapeAlgorithmEnumValues() []KeyShapeAlgorithmEnum

GetKeyShapeAlgorithmEnumValues Enumerates the set of values for KeyShapeAlgorithmEnum

type KeyShapeCurveIdEnum

KeyShapeCurveIdEnum Enum with underlying type: string

type KeyShapeCurveIdEnum string

Set of constants representing the allowable values for KeyShapeCurveIdEnum

const (
    KeyShapeCurveIdP256 KeyShapeCurveIdEnum = "NIST_P256"
    KeyShapeCurveIdP384 KeyShapeCurveIdEnum = "NIST_P384"
    KeyShapeCurveIdP521 KeyShapeCurveIdEnum = "NIST_P521"
)

func GetKeyShapeCurveIdEnumValues

func GetKeyShapeCurveIdEnumValues() []KeyShapeCurveIdEnum

GetKeyShapeCurveIdEnumValues Enumerates the set of values for KeyShapeCurveIdEnum

type KeySummary

KeySummary The representation of KeySummary

type KeySummary struct {

    // The OCID of the compartment that contains the key.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name for the key. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID of the key.
    Id *string `mandatory:"true" json:"id"`

    // The key's current lifecycle state.
    // Example: `ENABLED`
    LifecycleState KeySummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The date and time the key was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The OCID of the vault that contains the key.
    VaultId *string `mandatory:"true" json:"vaultId"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
    // A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
    // the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists
    // on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default,
    // a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported.
    ProtectionMode KeySummaryProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"`

    // The algorithm used by a key's key versions to encrypt or decrypt.
    Algorithm KeySummaryAlgorithmEnum `mandatory:"false" json:"algorithm,omitempty"`
}

func (KeySummary) String

func (m KeySummary) String() string

type KeySummaryAlgorithmEnum

KeySummaryAlgorithmEnum Enum with underlying type: string

type KeySummaryAlgorithmEnum string

Set of constants representing the allowable values for KeySummaryAlgorithmEnum

const (
    KeySummaryAlgorithmAes   KeySummaryAlgorithmEnum = "AES"
    KeySummaryAlgorithmRsa   KeySummaryAlgorithmEnum = "RSA"
    KeySummaryAlgorithmEcdsa KeySummaryAlgorithmEnum = "ECDSA"
)

func GetKeySummaryAlgorithmEnumValues

func GetKeySummaryAlgorithmEnumValues() []KeySummaryAlgorithmEnum

GetKeySummaryAlgorithmEnumValues Enumerates the set of values for KeySummaryAlgorithmEnum

type KeySummaryLifecycleStateEnum

KeySummaryLifecycleStateEnum Enum with underlying type: string

type KeySummaryLifecycleStateEnum string

Set of constants representing the allowable values for KeySummaryLifecycleStateEnum

const (
    KeySummaryLifecycleStateCreating           KeySummaryLifecycleStateEnum = "CREATING"
    KeySummaryLifecycleStateEnabling           KeySummaryLifecycleStateEnum = "ENABLING"
    KeySummaryLifecycleStateEnabled            KeySummaryLifecycleStateEnum = "ENABLED"
    KeySummaryLifecycleStateDisabling          KeySummaryLifecycleStateEnum = "DISABLING"
    KeySummaryLifecycleStateDisabled           KeySummaryLifecycleStateEnum = "DISABLED"
    KeySummaryLifecycleStateDeleting           KeySummaryLifecycleStateEnum = "DELETING"
    KeySummaryLifecycleStateDeleted            KeySummaryLifecycleStateEnum = "DELETED"
    KeySummaryLifecycleStatePendingDeletion    KeySummaryLifecycleStateEnum = "PENDING_DELETION"
    KeySummaryLifecycleStateSchedulingDeletion KeySummaryLifecycleStateEnum = "SCHEDULING_DELETION"
    KeySummaryLifecycleStateCancellingDeletion KeySummaryLifecycleStateEnum = "CANCELLING_DELETION"
    KeySummaryLifecycleStateUpdating           KeySummaryLifecycleStateEnum = "UPDATING"
    KeySummaryLifecycleStateBackupInProgress   KeySummaryLifecycleStateEnum = "BACKUP_IN_PROGRESS"
    KeySummaryLifecycleStateRestoring          KeySummaryLifecycleStateEnum = "RESTORING"
)

func GetKeySummaryLifecycleStateEnumValues

func GetKeySummaryLifecycleStateEnumValues() []KeySummaryLifecycleStateEnum

GetKeySummaryLifecycleStateEnumValues Enumerates the set of values for KeySummaryLifecycleStateEnum

type KeySummaryProtectionModeEnum

KeySummaryProtectionModeEnum Enum with underlying type: string

type KeySummaryProtectionModeEnum string

Set of constants representing the allowable values for KeySummaryProtectionModeEnum

const (
    KeySummaryProtectionModeHsm      KeySummaryProtectionModeEnum = "HSM"
    KeySummaryProtectionModeSoftware KeySummaryProtectionModeEnum = "SOFTWARE"
)

func GetKeySummaryProtectionModeEnumValues

func GetKeySummaryProtectionModeEnumValues() []KeySummaryProtectionModeEnum

GetKeySummaryProtectionModeEnumValues Enumerates the set of values for KeySummaryProtectionModeEnum

type KeyVersion

KeyVersion The representation of KeyVersion

type KeyVersion struct {

    // The OCID of the compartment that contains this key version.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The OCID of the key version.
    Id *string `mandatory:"true" json:"id"`

    // The OCID of the key associated with this key version.
    KeyId *string `mandatory:"true" json:"keyId"`

    // The date and time this key version was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: "2018-04-03T21:10:29.600Z"
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The OCID of the vault that contains this key version.
    VaultId *string `mandatory:"true" json:"vaultId"`

    // The public key in PEM format which will be populated only in case of RSA and ECDSA keys.
    PublicKey *string `mandatory:"false" json:"publicKey"`

    // The key version's current lifecycle state.
    // Example: `ENABLED`
    LifecycleState KeyVersionLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // The source of the key material. When this value is `INTERNAL`, Key Management
    // created the key material. When this value is `EXTERNAL`, the key material
    // was imported from an external source.
    Origin KeyVersionOriginEnum `mandatory:"false" json:"origin,omitempty"`

    // An optional property indicating when to delete the key version, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2019-04-03T21:10:29.600Z`
    TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`

    // The OCID of the key version from which this key version was restored.
    RestoredFromKeyVersionId *string `mandatory:"false" json:"restoredFromKeyVersionId"`
}

func (KeyVersion) String

func (m KeyVersion) String() string

type KeyVersionLifecycleStateEnum

KeyVersionLifecycleStateEnum Enum with underlying type: string

type KeyVersionLifecycleStateEnum string

Set of constants representing the allowable values for KeyVersionLifecycleStateEnum

const (
    KeyVersionLifecycleStateCreating           KeyVersionLifecycleStateEnum = "CREATING"
    KeyVersionLifecycleStateEnabling           KeyVersionLifecycleStateEnum = "ENABLING"
    KeyVersionLifecycleStateEnabled            KeyVersionLifecycleStateEnum = "ENABLED"
    KeyVersionLifecycleStateDisabling          KeyVersionLifecycleStateEnum = "DISABLING"
    KeyVersionLifecycleStateDisabled           KeyVersionLifecycleStateEnum = "DISABLED"
    KeyVersionLifecycleStateDeleting           KeyVersionLifecycleStateEnum = "DELETING"
    KeyVersionLifecycleStateDeleted            KeyVersionLifecycleStateEnum = "DELETED"
    KeyVersionLifecycleStatePendingDeletion    KeyVersionLifecycleStateEnum = "PENDING_DELETION"
    KeyVersionLifecycleStateSchedulingDeletion KeyVersionLifecycleStateEnum = "SCHEDULING_DELETION"
    KeyVersionLifecycleStateCancellingDeletion KeyVersionLifecycleStateEnum = "CANCELLING_DELETION"
)

func GetKeyVersionLifecycleStateEnumValues

func GetKeyVersionLifecycleStateEnumValues() []KeyVersionLifecycleStateEnum

GetKeyVersionLifecycleStateEnumValues Enumerates the set of values for KeyVersionLifecycleStateEnum

type KeyVersionOriginEnum

KeyVersionOriginEnum Enum with underlying type: string

type KeyVersionOriginEnum string

Set of constants representing the allowable values for KeyVersionOriginEnum

const (
    KeyVersionOriginInternal KeyVersionOriginEnum = "INTERNAL"
    KeyVersionOriginExternal KeyVersionOriginEnum = "EXTERNAL"
)

func GetKeyVersionOriginEnumValues

func GetKeyVersionOriginEnumValues() []KeyVersionOriginEnum

GetKeyVersionOriginEnumValues Enumerates the set of values for KeyVersionOriginEnum

type KeyVersionSummary

KeyVersionSummary The representation of KeyVersionSummary

type KeyVersionSummary struct {

    // The OCID of the compartment that contains this key version.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The OCID of the key version.
    Id *string `mandatory:"true" json:"id"`

    // The OCID of the master encryption key associated with this key version.
    KeyId *string `mandatory:"true" json:"keyId"`

    // The source of the key material. When this value is INTERNAL, Key Management created the key material. When this value is EXTERNAL, the key material was imported from an external source.
    Origin KeyVersionSummaryOriginEnum `mandatory:"true" json:"origin"`

    // The date and time this key version was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The OCID of the vault that contains this key version.
    VaultId *string `mandatory:"true" json:"vaultId"`

    // The key version's current lifecycle state.
    // Example: `ENABLED`
    LifecycleState KeyVersionSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // An optional property to indicate when to delete the key version, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2019-04-03T21:10:29.600Z`
    TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}

func (KeyVersionSummary) String

func (m KeyVersionSummary) String() string

type KeyVersionSummaryLifecycleStateEnum

KeyVersionSummaryLifecycleStateEnum Enum with underlying type: string

type KeyVersionSummaryLifecycleStateEnum string

Set of constants representing the allowable values for KeyVersionSummaryLifecycleStateEnum

const (
    KeyVersionSummaryLifecycleStateCreating           KeyVersionSummaryLifecycleStateEnum = "CREATING"
    KeyVersionSummaryLifecycleStateEnabling           KeyVersionSummaryLifecycleStateEnum = "ENABLING"
    KeyVersionSummaryLifecycleStateEnabled            KeyVersionSummaryLifecycleStateEnum = "ENABLED"
    KeyVersionSummaryLifecycleStateDisabling          KeyVersionSummaryLifecycleStateEnum = "DISABLING"
    KeyVersionSummaryLifecycleStateDisabled           KeyVersionSummaryLifecycleStateEnum = "DISABLED"
    KeyVersionSummaryLifecycleStateDeleting           KeyVersionSummaryLifecycleStateEnum = "DELETING"
    KeyVersionSummaryLifecycleStateDeleted            KeyVersionSummaryLifecycleStateEnum = "DELETED"
    KeyVersionSummaryLifecycleStatePendingDeletion    KeyVersionSummaryLifecycleStateEnum = "PENDING_DELETION"
    KeyVersionSummaryLifecycleStateSchedulingDeletion KeyVersionSummaryLifecycleStateEnum = "SCHEDULING_DELETION"
    KeyVersionSummaryLifecycleStateCancellingDeletion KeyVersionSummaryLifecycleStateEnum = "CANCELLING_DELETION"
)

func GetKeyVersionSummaryLifecycleStateEnumValues

func GetKeyVersionSummaryLifecycleStateEnumValues() []KeyVersionSummaryLifecycleStateEnum

GetKeyVersionSummaryLifecycleStateEnumValues Enumerates the set of values for KeyVersionSummaryLifecycleStateEnum

type KeyVersionSummaryOriginEnum

KeyVersionSummaryOriginEnum Enum with underlying type: string

type KeyVersionSummaryOriginEnum string

Set of constants representing the allowable values for KeyVersionSummaryOriginEnum

const (
    KeyVersionSummaryOriginInternal KeyVersionSummaryOriginEnum = "INTERNAL"
    KeyVersionSummaryOriginExternal KeyVersionSummaryOriginEnum = "EXTERNAL"
)

func GetKeyVersionSummaryOriginEnumValues

func GetKeyVersionSummaryOriginEnumValues() []KeyVersionSummaryOriginEnum

GetKeyVersionSummaryOriginEnumValues Enumerates the set of values for KeyVersionSummaryOriginEnum

type KmsCryptoClient

KmsCryptoClient a client for KmsCrypto

type KmsCryptoClient struct {
    common.BaseClient
    // contains filtered or unexported fields
}

func NewKmsCryptoClientWithConfigurationProvider

func NewKmsCryptoClientWithConfigurationProvider(configProvider common.ConfigurationProvider, endpoint string) (client KmsCryptoClient, err error)

NewKmsCryptoClientWithConfigurationProvider Creates a new default KmsCrypto client with the given configuration provider. the configuration provider will be used for the default signer

func NewKmsCryptoClientWithOboToken

func NewKmsCryptoClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string, endpoint string) (client KmsCryptoClient, err error)

NewKmsCryptoClientWithOboToken Creates a new default KmsCrypto client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

func (*KmsCryptoClient) ConfigurationProvider

func (client *KmsCryptoClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (KmsCryptoClient) Decrypt

func (client KmsCryptoClient) Decrypt(ctx context.Context, request DecryptRequest) (response DecryptResponse, err error)

Decrypt Decrypts data using the given DecryptDataDetails (https://docs.cloud.oracle.com/api/#/en/key/latest/datatypes/DecryptDataDetails) resource.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Decrypt.go.html to see an example of how to use Decrypt API.

func (KmsCryptoClient) Encrypt

func (client KmsCryptoClient) Encrypt(ctx context.Context, request EncryptRequest) (response EncryptResponse, err error)

Encrypt Encrypts data using the given EncryptDataDetails (https://docs.cloud.oracle.com/api/#/en/key/latest/datatypes/EncryptDataDetails) resource. Plaintext included in the example request is a base64-encoded value of a UTF-8 string.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Encrypt.go.html to see an example of how to use Encrypt API.

func (KmsCryptoClient) ExportKey

func (client KmsCryptoClient) ExportKey(ctx context.Context, request ExportKeyRequest) (response ExportKeyResponse, err error)

ExportKey Exports a specific version of a master encryption key according to the details of the request. For their protection, keys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys stored on the server. For export, the key version is encrypted by an RSA public key that you provide.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ExportKey.go.html to see an example of how to use ExportKey API.

func (KmsCryptoClient) GenerateDataEncryptionKey

func (client KmsCryptoClient) GenerateDataEncryptionKey(ctx context.Context, request GenerateDataEncryptionKeyRequest) (response GenerateDataEncryptionKeyResponse, err error)

GenerateDataEncryptionKey Generates a key that you can use to encrypt or decrypt data.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GenerateDataEncryptionKey.go.html to see an example of how to use GenerateDataEncryptionKey API.

func (KmsCryptoClient) Sign

func (client KmsCryptoClient) Sign(ctx context.Context, request SignRequest) (response SignResponse, err error)

Sign Creates a digital signature for a message or message digest by using the private key in an asymmetric key. To verify the generated signature, you can use the Verify operation or use the public key in the same asymmetric key outside of KMS

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Sign.go.html to see an example of how to use Sign API.

func (KmsCryptoClient) Verify

func (client KmsCryptoClient) Verify(ctx context.Context, request VerifyRequest) (response VerifyResponse, err error)

Verify Verifies a digital signature that was generated by the Sign operation using the public key in the same asymmetric key. You can also verify the digital signature by using the public key in the asymmetric key outside of KMS

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Verify.go.html to see an example of how to use Verify API.

type KmsManagementClient

KmsManagementClient a client for KmsManagement

type KmsManagementClient struct {
    common.BaseClient
    // contains filtered or unexported fields
}

func NewKmsManagementClientWithConfigurationProvider

func NewKmsManagementClientWithConfigurationProvider(configProvider common.ConfigurationProvider, endpoint string) (client KmsManagementClient, err error)

NewKmsManagementClientWithConfigurationProvider Creates a new default KmsManagement client with the given configuration provider. the configuration provider will be used for the default signer

func NewKmsManagementClientWithOboToken

func NewKmsManagementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string, endpoint string) (client KmsManagementClient, err error)

NewKmsManagementClientWithOboToken Creates a new default KmsManagement client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

func (KmsManagementClient) BackupKey

func (client KmsManagementClient) BackupKey(ctx context.Context, request BackupKeyRequest) (response BackupKeyResponse, err error)

BackupKey Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore the key later. The file also contains the metadata of the vault that the key belonged to.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/BackupKey.go.html to see an example of how to use BackupKey API.

func (KmsManagementClient) CancelKeyDeletion

func (client KmsManagementClient) CancelKeyDeletion(ctx context.Context, request CancelKeyDeletionRequest) (response CancelKeyDeletionResponse, err error)

CancelKeyDeletion Cancels the scheduled deletion of the specified key. Canceling a scheduled deletion restores the key's lifecycle state to what it was before its scheduled deletion. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelKeyDeletion.go.html to see an example of how to use CancelKeyDeletion API.

func (KmsManagementClient) CancelKeyVersionDeletion

func (client KmsManagementClient) CancelKeyVersionDeletion(ctx context.Context, request CancelKeyVersionDeletionRequest) (response CancelKeyVersionDeletionResponse, err error)

CancelKeyVersionDeletion Cancels the scheduled deletion of the specified key version. Canceling a scheduled deletion restores the key version to its lifecycle state from before its scheduled deletion. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelKeyVersionDeletion.go.html to see an example of how to use CancelKeyVersionDeletion API.

func (KmsManagementClient) ChangeKeyCompartment

func (client KmsManagementClient) ChangeKeyCompartment(ctx context.Context, request ChangeKeyCompartmentRequest) (response ChangeKeyCompartmentResponse, err error)

ChangeKeyCompartment Moves a key into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When provided, if-match is checked against the ETag values of the key. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ChangeKeyCompartment.go.html to see an example of how to use ChangeKeyCompartment API.

func (*KmsManagementClient) ConfigurationProvider

func (client *KmsManagementClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (KmsManagementClient) CreateKey

func (client KmsManagementClient) CreateKey(ctx context.Context, request CreateKeyRequest) (response CreateKeyResponse, err error)

CreateKey Creates a new master encryption key. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateKey.go.html to see an example of how to use CreateKey API.

func (KmsManagementClient) CreateKeyVersion

func (client KmsManagementClient) CreateKeyVersion(ctx context.Context, request CreateKeyVersionRequest) (response CreateKeyVersionResponse, err error)

CreateKeyVersion Generates a new KeyVersion (https://docs.cloud.oracle.com/api/#/en/key/latest/KeyVersion/) resource that provides new cryptographic material for a master encryption key. The key must be in an `ENABLED` state to be rotated. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateKeyVersion.go.html to see an example of how to use CreateKeyVersion API.

func (KmsManagementClient) DisableKey

func (client KmsManagementClient) DisableKey(ctx context.Context, request DisableKeyRequest) (response DisableKeyResponse, err error)

DisableKey Disables a master encryption key so it can no longer be used for encryption, decryption, or generating new data encryption keys. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/DisableKey.go.html to see an example of how to use DisableKey API.

func (KmsManagementClient) EnableKey

func (client KmsManagementClient) EnableKey(ctx context.Context, request EnableKeyRequest) (response EnableKeyResponse, err error)

EnableKey Enables a master encryption key so it can be used for encryption, decryption, or generating new data encryption keys. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/EnableKey.go.html to see an example of how to use EnableKey API.

func (KmsManagementClient) GetKey

func (client KmsManagementClient) GetKey(ctx context.Context, request GetKeyRequest) (response GetKeyResponse, err error)

GetKey Gets information about the specified master encryption key. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetKey.go.html to see an example of how to use GetKey API.

func (KmsManagementClient) GetKeyVersion

func (client KmsManagementClient) GetKeyVersion(ctx context.Context, request GetKeyVersionRequest) (response GetKeyVersionResponse, err error)

GetKeyVersion Gets information about the specified key version. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetKeyVersion.go.html to see an example of how to use GetKeyVersion API.

func (KmsManagementClient) GetWrappingKey

func (client KmsManagementClient) GetWrappingKey(ctx context.Context, request GetWrappingKeyRequest) (response GetWrappingKeyResponse, err error)

GetWrappingKey Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and unwraps AES key material for import into Key Management.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetWrappingKey.go.html to see an example of how to use GetWrappingKey API.

func (KmsManagementClient) ImportKey

func (client KmsManagementClient) ImportKey(ctx context.Context, request ImportKeyRequest) (response ImportKeyResponse, err error)

ImportKey Imports AES key material to create a new key with. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match what you specify at the time of import.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ImportKey.go.html to see an example of how to use ImportKey API.

func (KmsManagementClient) ImportKeyVersion

func (client KmsManagementClient) ImportKeyVersion(ctx context.Context, request ImportKeyVersionRequest) (response ImportKeyVersionResponse, err error)

ImportKeyVersion Imports AES key material to create a new key version with, and then rotates the key to begin using the new key version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key before you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes. Furthermore, the key length must match the length of the specified key and what you specify as the length at the time of import.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ImportKeyVersion.go.html to see an example of how to use ImportKeyVersion API.

func (KmsManagementClient) ListKeyVersions

func (client KmsManagementClient) ListKeyVersions(ctx context.Context, request ListKeyVersionsRequest) (response ListKeyVersionsResponse, err error)

ListKeyVersions Lists all KeyVersion (https://docs.cloud.oracle.com/api/#/en/key/latest/KeyVersion/) resources for the specified master encryption key. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListKeyVersions.go.html to see an example of how to use ListKeyVersions API.

func (KmsManagementClient) ListKeys

func (client KmsManagementClient) ListKeys(ctx context.Context, request ListKeysRequest) (response ListKeysResponse, err error)

ListKeys Lists the master encryption keys in the specified vault and compartment. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListKeys.go.html to see an example of how to use ListKeys API.

func (KmsManagementClient) RestoreKeyFromFile

func (client KmsManagementClient) RestoreKeyFromFile(ctx context.Context, request RestoreKeyFromFileRequest) (response RestoreKeyFromFileResponse, err error)

RestoreKeyFromFile Restores the specified key to the specified vault, based on information in the backup file provided. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreKeyFromFile.go.html to see an example of how to use RestoreKeyFromFile API.

func (KmsManagementClient) RestoreKeyFromObjectStore

func (client KmsManagementClient) RestoreKeyFromObjectStore(ctx context.Context, request RestoreKeyFromObjectStoreRequest) (response RestoreKeyFromObjectStoreResponse, err error)

RestoreKeyFromObjectStore Restores the specified key to the specified vault from an Oracle Cloud Infrastructure Object Storage location. If the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You need to first restore the vault associated with the key.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreKeyFromObjectStore.go.html to see an example of how to use RestoreKeyFromObjectStore API.

func (KmsManagementClient) ScheduleKeyDeletion

func (client KmsManagementClient) ScheduleKeyDeletion(ctx context.Context, request ScheduleKeyDeletionRequest) (response ScheduleKeyDeletionResponse, err error)

ScheduleKeyDeletion Schedules the deletion of the specified key. This sets the lifecycle state of the key to `PENDING_DELETION` and then deletes it after the specified retention period ends. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleKeyDeletion.go.html to see an example of how to use ScheduleKeyDeletion API.

func (KmsManagementClient) ScheduleKeyVersionDeletion

func (client KmsManagementClient) ScheduleKeyVersionDeletion(ctx context.Context, request ScheduleKeyVersionDeletionRequest) (response ScheduleKeyVersionDeletionResponse, err error)

ScheduleKeyVersionDeletion Schedules the deletion of the specified key version. This sets the lifecycle state of the key version to `PENDING_DELETION` and then deletes it after the specified retention period ends. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleKeyVersionDeletion.go.html to see an example of how to use ScheduleKeyVersionDeletion API.

func (KmsManagementClient) UpdateKey

func (client KmsManagementClient) UpdateKey(ctx context.Context, request UpdateKeyRequest) (response UpdateKeyResponse, err error)

UpdateKey Updates the properties of a master encryption key. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, the key must in an ENABLED or CREATING state to be updated. As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/UpdateKey.go.html to see an example of how to use UpdateKey API.

type KmsVaultClient

KmsVaultClient a client for KmsVault

type KmsVaultClient struct {
    common.BaseClient
    // contains filtered or unexported fields
}

func NewKmsVaultClientWithConfigurationProvider

func NewKmsVaultClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client KmsVaultClient, err error)

NewKmsVaultClientWithConfigurationProvider Creates a new default KmsVault client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewKmsVaultClientWithOboToken

func NewKmsVaultClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client KmsVaultClient, err error)

NewKmsVaultClientWithOboToken Creates a new default KmsVault client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (KmsVaultClient) BackupVault

func (client KmsVaultClient) BackupVault(ctx context.Context, request BackupVaultRequest) (response BackupVaultResponse, err error)

BackupVault Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later. You can backup a vault whether or not it contains keys. This operation only backs up the metadata of the vault, and does not include key metadata.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/BackupVault.go.html to see an example of how to use BackupVault API.

func (KmsVaultClient) CancelVaultDeletion

func (client KmsVaultClient) CancelVaultDeletion(ctx context.Context, request CancelVaultDeletionRequest) (response CancelVaultDeletionResponse, err error)

CancelVaultDeletion Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion restores the vault and all keys in it to their respective states from before their scheduled deletion. All keys that were scheduled for deletion prior to vault deletion retain their lifecycle state and time of deletion. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CancelVaultDeletion.go.html to see an example of how to use CancelVaultDeletion API.

func (KmsVaultClient) ChangeVaultCompartment

func (client KmsVaultClient) ChangeVaultCompartment(ctx context.Context, request ChangeVaultCompartmentRequest) (response ChangeVaultCompartmentResponse, err error)

ChangeVaultCompartment Moves a vault into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). When provided, if-match is checked against the ETag values of the resource. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ChangeVaultCompartment.go.html to see an example of how to use ChangeVaultCompartment API.

func (*KmsVaultClient) ConfigurationProvider

func (client *KmsVaultClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (KmsVaultClient) CreateVault

func (client KmsVaultClient) CreateVault(ctx context.Context, request CreateVaultRequest) (response CreateVaultResponse, err error)

CreateVault Creates a new vault. The type of vault you create determines key placement, pricing, and available options. Options include storage isolation, a dedicated service endpoint instead of a shared service endpoint for API calls, and either a dedicated hardware security module (HSM) or a multitenant HSM. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/CreateVault.go.html to see an example of how to use CreateVault API.

func (KmsVaultClient) GetVault

func (client KmsVaultClient) GetVault(ctx context.Context, request GetVaultRequest) (response GetVaultResponse, err error)

GetVault Gets the specified vault's configuration information. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetVault.go.html to see an example of how to use GetVault API.

func (KmsVaultClient) GetVaultUsage

func (client KmsVaultClient) GetVaultUsage(ctx context.Context, request GetVaultUsageRequest) (response GetVaultUsageResponse, err error)

GetVaultUsage Gets the count of keys and key versions in the specified vault to calculate usage against service limits.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/GetVaultUsage.go.html to see an example of how to use GetVaultUsage API.

func (KmsVaultClient) ListVaults

func (client KmsVaultClient) ListVaults(ctx context.Context, request ListVaultsRequest) (response ListVaultsResponse, err error)

ListVaults Lists the vaults in the specified compartment. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning read operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListVaults.go.html to see an example of how to use ListVaults API.

func (KmsVaultClient) RestoreVaultFromFile

func (client KmsVaultClient) RestoreVaultFromFile(ctx context.Context, request RestoreVaultFromFileRequest) (response RestoreVaultFromFileResponse, err error)

RestoreVaultFromFile Restores a vault from an encrypted backup file. If a vault with the same OCID already exists, this operation returns a response with a 409 HTTP status error code.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreVaultFromFile.go.html to see an example of how to use RestoreVaultFromFile API.

func (KmsVaultClient) RestoreVaultFromObjectStore

func (client KmsVaultClient) RestoreVaultFromObjectStore(ctx context.Context, request RestoreVaultFromObjectStoreRequest) (response RestoreVaultFromObjectStoreResponse, err error)

RestoreVaultFromObjectStore Restores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object Storage. If a vault with the same OCID already exists, this operation returns a response with a 409 HTTP status error code.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreVaultFromObjectStore.go.html to see an example of how to use RestoreVaultFromObjectStore API.

func (KmsVaultClient) ScheduleVaultDeletion

func (client KmsVaultClient) ScheduleVaultDeletion(ctx context.Context, request ScheduleVaultDeletionRequest) (response ScheduleVaultDeletionResponse, err error)

ScheduleVaultDeletion Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it that are not already scheduled for deletion to `PENDING_DELETION` and then deletes them after the retention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won't change. If any keys in the vault are scheduled to be deleted after the specified time of deletion for the vault, the call is rejected with the error code 409. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleVaultDeletion.go.html to see an example of how to use ScheduleVaultDeletion API.

func (*KmsVaultClient) SetRegion

func (client *KmsVaultClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (KmsVaultClient) UpdateVault

func (client KmsVaultClient) UpdateVault(ctx context.Context, request UpdateVaultRequest) (response UpdateVaultResponse, err error)

UpdateVault Updates the properties of a vault. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, the vault must be in an ACTIVE or CREATING state to be updated. As a provisioning operation, this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/UpdateVault.go.html to see an example of how to use UpdateVault API.

type ListKeyVersionsRequest

ListKeyVersionsRequest wrapper for the ListKeyVersions operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListKeyVersions.go.html to see an example of how to use ListKeyVersionsRequest.

type ListKeyVersionsRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // The maximum number of items to return in a paginated "List" call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` response header
    // from the previous "List" call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The field to sort by. You can specify only one sort order. The default
    // order for `TIMECREATED` is descending. The default order for `DISPLAYNAME`
    // is ascending.
    SortBy ListKeyVersionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListKeyVersionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListKeyVersionsRequest) HTTPRequest

func (request ListKeyVersionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListKeyVersionsRequest) RetryPolicy

func (request ListKeyVersionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListKeyVersionsRequest) String

func (request ListKeyVersionsRequest) String() string

type ListKeyVersionsResponse

ListKeyVersionsResponse wrapper for the ListKeyVersions operation

type ListKeyVersionsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []KeyVersionSummary instances
    Items []KeyVersionSummary `presentIn:"body"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then there are additional items still to get. Include this value as the `page` parameter for the
    // subsequent GET request. For information about pagination, see
    // List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#List_Pagination).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListKeyVersionsResponse) HTTPResponse

func (response ListKeyVersionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListKeyVersionsResponse) String

func (response ListKeyVersionsResponse) String() string

type ListKeyVersionsSortByEnum

ListKeyVersionsSortByEnum Enum with underlying type: string

type ListKeyVersionsSortByEnum string

Set of constants representing the allowable values for ListKeyVersionsSortByEnum

const (
    ListKeyVersionsSortByTimecreated ListKeyVersionsSortByEnum = "TIMECREATED"
    ListKeyVersionsSortByDisplayname ListKeyVersionsSortByEnum = "DISPLAYNAME"
)

func GetListKeyVersionsSortByEnumValues

func GetListKeyVersionsSortByEnumValues() []ListKeyVersionsSortByEnum

GetListKeyVersionsSortByEnumValues Enumerates the set of values for ListKeyVersionsSortByEnum

type ListKeyVersionsSortOrderEnum

ListKeyVersionsSortOrderEnum Enum with underlying type: string

type ListKeyVersionsSortOrderEnum string

Set of constants representing the allowable values for ListKeyVersionsSortOrderEnum

const (
    ListKeyVersionsSortOrderAsc  ListKeyVersionsSortOrderEnum = "ASC"
    ListKeyVersionsSortOrderDesc ListKeyVersionsSortOrderEnum = "DESC"
)

func GetListKeyVersionsSortOrderEnumValues

func GetListKeyVersionsSortOrderEnumValues() []ListKeyVersionsSortOrderEnum

GetListKeyVersionsSortOrderEnumValues Enumerates the set of values for ListKeyVersionsSortOrderEnum

type ListKeysAlgorithmEnum

ListKeysAlgorithmEnum Enum with underlying type: string

type ListKeysAlgorithmEnum string

Set of constants representing the allowable values for ListKeysAlgorithmEnum

const (
    ListKeysAlgorithmAes   ListKeysAlgorithmEnum = "AES"
    ListKeysAlgorithmRsa   ListKeysAlgorithmEnum = "RSA"
    ListKeysAlgorithmEcdsa ListKeysAlgorithmEnum = "ECDSA"
)

func GetListKeysAlgorithmEnumValues

func GetListKeysAlgorithmEnumValues() []ListKeysAlgorithmEnum

GetListKeysAlgorithmEnumValues Enumerates the set of values for ListKeysAlgorithmEnum

type ListKeysCurveIdEnum

ListKeysCurveIdEnum Enum with underlying type: string

type ListKeysCurveIdEnum string

Set of constants representing the allowable values for ListKeysCurveIdEnum

const (
    ListKeysCurveIdP256 ListKeysCurveIdEnum = "NIST_P256"
    ListKeysCurveIdP384 ListKeysCurveIdEnum = "NIST_P384"
    ListKeysCurveIdP521 ListKeysCurveIdEnum = "NIST_P521"
)

func GetListKeysCurveIdEnumValues

func GetListKeysCurveIdEnumValues() []ListKeysCurveIdEnum

GetListKeysCurveIdEnumValues Enumerates the set of values for ListKeysCurveIdEnum

type ListKeysProtectionModeEnum

ListKeysProtectionModeEnum Enum with underlying type: string

type ListKeysProtectionModeEnum string

Set of constants representing the allowable values for ListKeysProtectionModeEnum

const (
    ListKeysProtectionModeHsm      ListKeysProtectionModeEnum = "HSM"
    ListKeysProtectionModeSoftware ListKeysProtectionModeEnum = "SOFTWARE"
)

func GetListKeysProtectionModeEnumValues

func GetListKeysProtectionModeEnumValues() []ListKeysProtectionModeEnum

GetListKeysProtectionModeEnumValues Enumerates the set of values for ListKeysProtectionModeEnum

type ListKeysRequest

ListKeysRequest wrapper for the ListKeys operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListKeys.go.html to see an example of how to use ListKeysRequest.

type ListKeysRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The maximum number of items to return in a paginated "List" call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` response header
    // from the previous "List" call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The field to sort by. You can specify only one sort order. The default
    // order for `TIMECREATED` is descending. The default order for `DISPLAYNAME`
    // is ascending.
    SortBy ListKeysSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListKeysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // A key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A
    // protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are
    // performed inside the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's
    // RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of
    // `SOFTWARE` are performed on the server.
    ProtectionMode ListKeysProtectionModeEnum `mandatory:"false" contributesTo:"query" name:"protectionMode" omitEmpty:"true"`

    // The algorithm used by a key's key versions to encrypt or decrypt. Currently, only AES, RSA and ECDSA are supported.
    Algorithm ListKeysAlgorithmEnum `mandatory:"false" contributesTo:"query" name:"algorithm" omitEmpty:"true"`

    // The length of the key in bytes, expressed as an integer. Values of 16, 24, 32 are supported.
    Length *int `mandatory:"false" contributesTo:"query" name:"length"`

    // The curve Id of the keys in case of ECDSA keys
    CurveId ListKeysCurveIdEnum `mandatory:"false" contributesTo:"query" name:"curveId" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListKeysRequest) HTTPRequest

func (request ListKeysRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListKeysRequest) RetryPolicy

func (request ListKeysRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListKeysRequest) String

func (request ListKeysRequest) String() string

type ListKeysResponse

ListKeysResponse wrapper for the ListKeys operation

type ListKeysResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []KeySummary instances
    Items []KeySummary `presentIn:"body"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then there are additional items still to get. Include this value as the `page` parameter for the
    // subsequent GET request. For information about pagination, see
    // List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#List_Pagination).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListKeysResponse) HTTPResponse

func (response ListKeysResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListKeysResponse) String

func (response ListKeysResponse) String() string

type ListKeysSortByEnum

ListKeysSortByEnum Enum with underlying type: string

type ListKeysSortByEnum string

Set of constants representing the allowable values for ListKeysSortByEnum

const (
    ListKeysSortByTimecreated ListKeysSortByEnum = "TIMECREATED"
    ListKeysSortByDisplayname ListKeysSortByEnum = "DISPLAYNAME"
)

func GetListKeysSortByEnumValues

func GetListKeysSortByEnumValues() []ListKeysSortByEnum

GetListKeysSortByEnumValues Enumerates the set of values for ListKeysSortByEnum

type ListKeysSortOrderEnum

ListKeysSortOrderEnum Enum with underlying type: string

type ListKeysSortOrderEnum string

Set of constants representing the allowable values for ListKeysSortOrderEnum

const (
    ListKeysSortOrderAsc  ListKeysSortOrderEnum = "ASC"
    ListKeysSortOrderDesc ListKeysSortOrderEnum = "DESC"
)

func GetListKeysSortOrderEnumValues

func GetListKeysSortOrderEnumValues() []ListKeysSortOrderEnum

GetListKeysSortOrderEnumValues Enumerates the set of values for ListKeysSortOrderEnum

type ListVaultsRequest

ListVaultsRequest wrapper for the ListVaults operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ListVaults.go.html to see an example of how to use ListVaultsRequest.

type ListVaultsRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The maximum number of items to return in a paginated "List" call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` response header
    // from the previous "List" call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The field to sort by. You can specify only one sort order. The default
    // order for `TIMECREATED` is descending. The default order for `DISPLAYNAME`
    // is ascending.
    SortBy ListVaultsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListVaultsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListVaultsRequest) HTTPRequest

func (request ListVaultsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVaultsRequest) RetryPolicy

func (request ListVaultsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVaultsRequest) String

func (request ListVaultsRequest) String() string

type ListVaultsResponse

ListVaultsResponse wrapper for the ListVaults operation

type ListVaultsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []VaultSummary instances
    Items []VaultSummary `presentIn:"body"`

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then there are additional items still to get. Include this value as the `page` parameter for the
    // subsequent GET request. For information about pagination, see
    // List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#List_Pagination).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListVaultsResponse) HTTPResponse

func (response ListVaultsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVaultsResponse) String

func (response ListVaultsResponse) String() string

type ListVaultsSortByEnum

ListVaultsSortByEnum Enum with underlying type: string

type ListVaultsSortByEnum string

Set of constants representing the allowable values for ListVaultsSortByEnum

const (
    ListVaultsSortByTimecreated ListVaultsSortByEnum = "TIMECREATED"
    ListVaultsSortByDisplayname ListVaultsSortByEnum = "DISPLAYNAME"
)

func GetListVaultsSortByEnumValues

func GetListVaultsSortByEnumValues() []ListVaultsSortByEnum

GetListVaultsSortByEnumValues Enumerates the set of values for ListVaultsSortByEnum

type ListVaultsSortOrderEnum

ListVaultsSortOrderEnum Enum with underlying type: string

type ListVaultsSortOrderEnum string

Set of constants representing the allowable values for ListVaultsSortOrderEnum

const (
    ListVaultsSortOrderAsc  ListVaultsSortOrderEnum = "ASC"
    ListVaultsSortOrderDesc ListVaultsSortOrderEnum = "DESC"
)

func GetListVaultsSortOrderEnumValues

func GetListVaultsSortOrderEnumValues() []ListVaultsSortOrderEnum

GetListVaultsSortOrderEnumValues Enumerates the set of values for ListVaultsSortOrderEnum

type RestoreKeyFromFileRequest

RestoreKeyFromFileRequest wrapper for the RestoreKeyFromFile operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreKeyFromFile.go.html to see an example of how to use RestoreKeyFromFileRequest.

type RestoreKeyFromFileRequest struct {

    // The content length of the body.
    ContentLength *int64 `mandatory:"false" contributesTo:"header" name:"content-length"`

    // The encrypted backup file to upload to restore the key.
    RestoreKeyFromFileDetails io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The base64-encoded MD5 hash value of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.15.
    // If the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5
    // hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and
    // a response with 400 Unmatched Content MD5 error is returned, along with the message: "The computed MD5 of the request body (ACTUAL_MD5)
    // does not match the Content-MD5 header (HEADER_MD5)."
    ContentMd5 *string `mandatory:"false" contributesTo:"header" name:"content-md5"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (RestoreKeyFromFileRequest) HTTPRequest

func (request RestoreKeyFromFileRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreKeyFromFileRequest) RetryPolicy

func (request RestoreKeyFromFileRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RestoreKeyFromFileRequest) String

func (request RestoreKeyFromFileRequest) String() string

type RestoreKeyFromFileResponse

RestoreKeyFromFileResponse wrapper for the RestoreKeyFromFile operation

type RestoreKeyFromFileResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // The base64-encoded MD5 hash value of the request body, as computed
    // by the server.
    OpcContentMd5 *string `presentIn:"header" name:"opc-content-md5"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // Unique Oracle-assigned identifier for the work request, used to track the progress of the
    // restore operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (RestoreKeyFromFileResponse) HTTPResponse

func (response RestoreKeyFromFileResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RestoreKeyFromFileResponse) String

func (response RestoreKeyFromFileResponse) String() string

type RestoreKeyFromObjectStoreDetails

RestoreKeyFromObjectStoreDetails The representation of RestoreKeyFromObjectStoreDetails

type RestoreKeyFromObjectStoreDetails struct {
    BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
}

func (RestoreKeyFromObjectStoreDetails) String

func (m RestoreKeyFromObjectStoreDetails) String() string

func (*RestoreKeyFromObjectStoreDetails) UnmarshalJSON

func (m *RestoreKeyFromObjectStoreDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type RestoreKeyFromObjectStoreRequest

RestoreKeyFromObjectStoreRequest wrapper for the RestoreKeyFromObjectStore operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreKeyFromObjectStore.go.html to see an example of how to use RestoreKeyFromObjectStoreRequest.

type RestoreKeyFromObjectStoreRequest struct {

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Location to restore the backup from
    RestoreKeyFromObjectStoreDetails `contributesTo:"body"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (RestoreKeyFromObjectStoreRequest) HTTPRequest

func (request RestoreKeyFromObjectStoreRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreKeyFromObjectStoreRequest) RetryPolicy

func (request RestoreKeyFromObjectStoreRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RestoreKeyFromObjectStoreRequest) String

func (request RestoreKeyFromObjectStoreRequest) String() string

type RestoreKeyFromObjectStoreResponse

RestoreKeyFromObjectStoreResponse wrapper for the RestoreKeyFromObjectStore operation

type RestoreKeyFromObjectStoreResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // Unique Oracle-assigned identifier for the work request, used to track the progress of the
    // restore operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (RestoreKeyFromObjectStoreResponse) HTTPResponse

func (response RestoreKeyFromObjectStoreResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RestoreKeyFromObjectStoreResponse) String

func (response RestoreKeyFromObjectStoreResponse) String() string

type RestoreVaultFromFileRequest

RestoreVaultFromFileRequest wrapper for the RestoreVaultFromFile operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreVaultFromFile.go.html to see an example of how to use RestoreVaultFromFileRequest.

type RestoreVaultFromFileRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The content length of the body.
    ContentLength *int64 `mandatory:"false" contributesTo:"header" name:"content-length"`

    // The encrypted backup file to upload to restore the vault.
    RestoreVaultFromFileDetails io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The base64-encoded MD5 hash value of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.15.
    // If the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5
    // hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and
    // a response with 400 Unmatched Content MD5 error is returned, along with the message: "The computed MD5 of the request body (ACTUAL_MD5)
    // does not match the Content-MD5 header (HEADER_MD5)."
    ContentMd5 *string `mandatory:"false" contributesTo:"header" name:"content-md5"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (RestoreVaultFromFileRequest) HTTPRequest

func (request RestoreVaultFromFileRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreVaultFromFileRequest) RetryPolicy

func (request RestoreVaultFromFileRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RestoreVaultFromFileRequest) String

func (request RestoreVaultFromFileRequest) String() string

type RestoreVaultFromFileResponse

RestoreVaultFromFileResponse wrapper for the RestoreVaultFromFile operation

type RestoreVaultFromFileResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Vault instance
    Vault `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // The base64-encoded MD5 hash value of the request body, as computed
    // by the server.
    OpcContentMd5 *string `presentIn:"header" name:"opc-content-md5"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // Unique Oracle-assigned identifier for the work request, used to track the progress of the
    // restore operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (RestoreVaultFromFileResponse) HTTPResponse

func (response RestoreVaultFromFileResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RestoreVaultFromFileResponse) String

func (response RestoreVaultFromFileResponse) String() string

type RestoreVaultFromObjectStoreDetails

RestoreVaultFromObjectStoreDetails The representation of RestoreVaultFromObjectStoreDetails

type RestoreVaultFromObjectStoreDetails struct {
    BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
}

func (RestoreVaultFromObjectStoreDetails) String

func (m RestoreVaultFromObjectStoreDetails) String() string

func (*RestoreVaultFromObjectStoreDetails) UnmarshalJSON

func (m *RestoreVaultFromObjectStoreDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type RestoreVaultFromObjectStoreRequest

RestoreVaultFromObjectStoreRequest wrapper for the RestoreVaultFromObjectStore operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/RestoreVaultFromObjectStore.go.html to see an example of how to use RestoreVaultFromObjectStoreRequest.

type RestoreVaultFromObjectStoreRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // RestoreVaultFromObjectStoreDetails
    RestoreVaultFromObjectStoreDetails `contributesTo:"body"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (RestoreVaultFromObjectStoreRequest) HTTPRequest

func (request RestoreVaultFromObjectStoreRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreVaultFromObjectStoreRequest) RetryPolicy

func (request RestoreVaultFromObjectStoreRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RestoreVaultFromObjectStoreRequest) String

func (request RestoreVaultFromObjectStoreRequest) String() string

type RestoreVaultFromObjectStoreResponse

RestoreVaultFromObjectStoreResponse wrapper for the RestoreVaultFromObjectStore operation

type RestoreVaultFromObjectStoreResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Vault instance
    Vault `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // Unique Oracle-assigned identifier for the work request, used to track the progress of the
    // restore operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (RestoreVaultFromObjectStoreResponse) HTTPResponse

func (response RestoreVaultFromObjectStoreResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RestoreVaultFromObjectStoreResponse) String

func (response RestoreVaultFromObjectStoreResponse) String() string

type ScheduleKeyDeletionDetails

ScheduleKeyDeletionDetails Details for scheduling key deletion.

type ScheduleKeyDeletionDetails struct {

    // An optional property to indicate when to delete the vault, expressed in
    // RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. The specified
    // time must be between 7 and 30 days from when the request is received.
    // If this property is missing, it will be set to 30 days from the time of the request
    // by default.
    TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}

func (ScheduleKeyDeletionDetails) String

func (m ScheduleKeyDeletionDetails) String() string

type ScheduleKeyDeletionRequest

ScheduleKeyDeletionRequest wrapper for the ScheduleKeyDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleKeyDeletion.go.html to see an example of how to use ScheduleKeyDeletionRequest.

type ScheduleKeyDeletionRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // ScheduleKeyDeletionDetails
    ScheduleKeyDeletionDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ScheduleKeyDeletionRequest) HTTPRequest

func (request ScheduleKeyDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScheduleKeyDeletionRequest) RetryPolicy

func (request ScheduleKeyDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ScheduleKeyDeletionRequest) String

func (request ScheduleKeyDeletionRequest) String() string

type ScheduleKeyDeletionResponse

ScheduleKeyDeletionResponse wrapper for the ScheduleKeyDeletion operation

type ScheduleKeyDeletionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ScheduleKeyDeletionResponse) HTTPResponse

func (response ScheduleKeyDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ScheduleKeyDeletionResponse) String

func (response ScheduleKeyDeletionResponse) String() string

type ScheduleKeyVersionDeletionDetails

ScheduleKeyVersionDeletionDetails Details for scheduling key version deletion.

type ScheduleKeyVersionDeletionDetails struct {

    // An optional property to indicate when to delete the key version, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
    // timestamp format. The specified time must be between 7 and 30 days from the time
    // when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default.
    TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}

func (ScheduleKeyVersionDeletionDetails) String

func (m ScheduleKeyVersionDeletionDetails) String() string

type ScheduleKeyVersionDeletionRequest

ScheduleKeyVersionDeletionRequest wrapper for the ScheduleKeyVersionDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleKeyVersionDeletion.go.html to see an example of how to use ScheduleKeyVersionDeletionRequest.

type ScheduleKeyVersionDeletionRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // The OCID of the key version.
    KeyVersionId *string `mandatory:"true" contributesTo:"path" name:"keyVersionId"`

    // ScheduleKeyVersionDeletionDetails
    ScheduleKeyVersionDeletionDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ScheduleKeyVersionDeletionRequest) HTTPRequest

func (request ScheduleKeyVersionDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScheduleKeyVersionDeletionRequest) RetryPolicy

func (request ScheduleKeyVersionDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ScheduleKeyVersionDeletionRequest) String

func (request ScheduleKeyVersionDeletionRequest) String() string

type ScheduleKeyVersionDeletionResponse

ScheduleKeyVersionDeletionResponse wrapper for the ScheduleKeyVersionDeletion operation

type ScheduleKeyVersionDeletionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The KeyVersion instance
    KeyVersion `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ScheduleKeyVersionDeletionResponse) HTTPResponse

func (response ScheduleKeyVersionDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ScheduleKeyVersionDeletionResponse) String

func (response ScheduleKeyVersionDeletionResponse) String() string

type ScheduleVaultDeletionDetails

ScheduleVaultDeletionDetails Details for scheduling vault deletion.

type ScheduleVaultDeletionDetails struct {

    // An optional property indicating when to delete the vault, expressed in
    // RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. The specified
    // time must be between 7 and 30 days from the time when the request is received.
    // If this property is missing, it will be set to 30 days from the time of the request
    // by default.
    TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}

func (ScheduleVaultDeletionDetails) String

func (m ScheduleVaultDeletionDetails) String() string

type ScheduleVaultDeletionRequest

ScheduleVaultDeletionRequest wrapper for the ScheduleVaultDeletion operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/ScheduleVaultDeletion.go.html to see an example of how to use ScheduleVaultDeletionRequest.

type ScheduleVaultDeletionRequest struct {

    // The OCID of the vault.
    VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`

    // ScheduleVaultDeletionDetails
    ScheduleVaultDeletionDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // A token that uniquely identifies a request so it can be retried in case
    // of a timeout or server error without risk of executing that same action
    // again. Retry tokens expire after 24 hours, but can be invalidated
    // before then due to conflicting operations (e.g., if a resource has been
    // deleted and purged from the system, then a retry of the original
    // creation request may be rejected).
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ScheduleVaultDeletionRequest) HTTPRequest

func (request ScheduleVaultDeletionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScheduleVaultDeletionRequest) RetryPolicy

func (request ScheduleVaultDeletionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ScheduleVaultDeletionRequest) String

func (request ScheduleVaultDeletionRequest) String() string

type ScheduleVaultDeletionResponse

ScheduleVaultDeletionResponse wrapper for the ScheduleVaultDeletion operation

type ScheduleVaultDeletionResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Vault instance
    Vault `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ScheduleVaultDeletionResponse) HTTPResponse

func (response ScheduleVaultDeletionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ScheduleVaultDeletionResponse) String

func (response ScheduleVaultDeletionResponse) String() string

type SignDataDetails

SignDataDetails The representation of SignDataDetails

type SignDataDetails struct {

    // The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest.
    Message *string `mandatory:"true" json:"message"`

    // The OCID of the key used to sign the message
    KeyId *string `mandatory:"true" json:"keyId"`

    // The algorithm to be used for signing the message or message digest
    // For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with
    // different Hashing algorithms.
    // For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms.
    // In case of passing digest for signing, make sure the same hashing algorithm is
    // specified as used for created for digest.
    SigningAlgorithm SignDataDetailsSigningAlgorithmEnum `mandatory:"true" json:"signingAlgorithm"`

    // The OCID of the keyVersion used to sign the message.
    KeyVersionId *string `mandatory:"false" json:"keyVersionId"`

    // Denotes whether the value of the message parameter is a raw message or a message digest.
    // The default value, RAW, indicates a message. To indicate a message digest, use DIGEST.
    MessageType SignDataDetailsMessageTypeEnum `mandatory:"false" json:"messageType,omitempty"`
}

func (SignDataDetails) String

func (m SignDataDetails) String() string

type SignDataDetailsMessageTypeEnum

SignDataDetailsMessageTypeEnum Enum with underlying type: string

type SignDataDetailsMessageTypeEnum string

Set of constants representing the allowable values for SignDataDetailsMessageTypeEnum

const (
    SignDataDetailsMessageTypeRaw    SignDataDetailsMessageTypeEnum = "RAW"
    SignDataDetailsMessageTypeDigest SignDataDetailsMessageTypeEnum = "DIGEST"
)

func GetSignDataDetailsMessageTypeEnumValues

func GetSignDataDetailsMessageTypeEnumValues() []SignDataDetailsMessageTypeEnum

GetSignDataDetailsMessageTypeEnumValues Enumerates the set of values for SignDataDetailsMessageTypeEnum

type SignDataDetailsSigningAlgorithmEnum

SignDataDetailsSigningAlgorithmEnum Enum with underlying type: string

type SignDataDetailsSigningAlgorithmEnum string

Set of constants representing the allowable values for SignDataDetailsSigningAlgorithmEnum

const (
    SignDataDetailsSigningAlgorithmSha224RsaPkcsPss  SignDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS_PSS"
    SignDataDetailsSigningAlgorithmSha256RsaPkcsPss  SignDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS_PSS"
    SignDataDetailsSigningAlgorithmSha384RsaPkcsPss  SignDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS_PSS"
    SignDataDetailsSigningAlgorithmSha512RsaPkcsPss  SignDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS_PSS"
    SignDataDetailsSigningAlgorithmSha224RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS1_V1_5"
    SignDataDetailsSigningAlgorithmSha256RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS1_V1_5"
    SignDataDetailsSigningAlgorithmSha384RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS1_V1_5"
    SignDataDetailsSigningAlgorithmSha512RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS1_V1_5"
    SignDataDetailsSigningAlgorithmEcdsaSha256       SignDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_256"
    SignDataDetailsSigningAlgorithmEcdsaSha384       SignDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_384"
    SignDataDetailsSigningAlgorithmEcdsaSha512       SignDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_512"
)

func GetSignDataDetailsSigningAlgorithmEnumValues

func GetSignDataDetailsSigningAlgorithmEnumValues() []SignDataDetailsSigningAlgorithmEnum

GetSignDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for SignDataDetailsSigningAlgorithmEnum

type SignRequest

SignRequest wrapper for the Sign operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Sign.go.html to see an example of how to use SignRequest.

type SignRequest struct {

    // SignDataDetails
    SignDataDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (SignRequest) HTTPRequest

func (request SignRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (SignRequest) RetryPolicy

func (request SignRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (SignRequest) String

func (request SignRequest) String() string

type SignResponse

SignResponse wrapper for the Sign operation

type SignResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The SignedData instance
    SignedData `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (SignResponse) HTTPResponse

func (response SignResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (SignResponse) String

func (response SignResponse) String() string

type SignedData

SignedData The representation of SignedData

type SignedData struct {

    // The OCID of the key used to sign the message
    KeyId *string `mandatory:"true" json:"keyId"`

    // The OCID of the keyVersion used to sign the message
    KeyVersionId *string `mandatory:"true" json:"keyVersionId"`

    // The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message or message digest.
    Signature *string `mandatory:"true" json:"signature"`

    // The algorithm to be used for signing the message or message digest
    // For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with
    // different Hashing algorithms.
    // For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms.
    // In case of passing digest for signing, make sure the same hashing algorithm is
    // specified as used for created for digest.
    SigningAlgorithm SignedDataSigningAlgorithmEnum `mandatory:"true" json:"signingAlgorithm"`
}

func (SignedData) String

func (m SignedData) String() string

type SignedDataSigningAlgorithmEnum

SignedDataSigningAlgorithmEnum Enum with underlying type: string

type SignedDataSigningAlgorithmEnum string

Set of constants representing the allowable values for SignedDataSigningAlgorithmEnum

const (
    SignedDataSigningAlgorithmSha224RsaPkcsPss  SignedDataSigningAlgorithmEnum = "SHA_224_RSA_PKCS_PSS"
    SignedDataSigningAlgorithmSha256RsaPkcsPss  SignedDataSigningAlgorithmEnum = "SHA_256_RSA_PKCS_PSS"
    SignedDataSigningAlgorithmSha384RsaPkcsPss  SignedDataSigningAlgorithmEnum = "SHA_384_RSA_PKCS_PSS"
    SignedDataSigningAlgorithmSha512RsaPkcsPss  SignedDataSigningAlgorithmEnum = "SHA_512_RSA_PKCS_PSS"
    SignedDataSigningAlgorithmSha224RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_224_RSA_PKCS1_V1_5"
    SignedDataSigningAlgorithmSha256RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_256_RSA_PKCS1_V1_5"
    SignedDataSigningAlgorithmSha384RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_384_RSA_PKCS1_V1_5"
    SignedDataSigningAlgorithmSha512RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_512_RSA_PKCS1_V1_5"
    SignedDataSigningAlgorithmEcdsaSha256       SignedDataSigningAlgorithmEnum = "ECDSA_SHA_256"
    SignedDataSigningAlgorithmEcdsaSha384       SignedDataSigningAlgorithmEnum = "ECDSA_SHA_384"
    SignedDataSigningAlgorithmEcdsaSha512       SignedDataSigningAlgorithmEnum = "ECDSA_SHA_512"
)

func GetSignedDataSigningAlgorithmEnumValues

func GetSignedDataSigningAlgorithmEnumValues() []SignedDataSigningAlgorithmEnum

GetSignedDataSigningAlgorithmEnumValues Enumerates the set of values for SignedDataSigningAlgorithmEnum

type UpdateKeyDetails

UpdateKeyDetails The representation of UpdateKeyDetails

type UpdateKeyDetails struct {

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // A user-friendly name for the key. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

func (UpdateKeyDetails) String

func (m UpdateKeyDetails) String() string

type UpdateKeyRequest

UpdateKeyRequest wrapper for the UpdateKey operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/UpdateKey.go.html to see an example of how to use UpdateKeyRequest.

type UpdateKeyRequest struct {

    // The OCID of the key.
    KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`

    // UpdateKeyDetails
    UpdateKeyDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (UpdateKeyRequest) HTTPRequest

func (request UpdateKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateKeyRequest) RetryPolicy

func (request UpdateKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateKeyRequest) String

func (request UpdateKeyRequest) String() string

type UpdateKeyResponse

UpdateKeyResponse wrapper for the UpdateKey operation

type UpdateKeyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Key instance
    Key `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (UpdateKeyResponse) HTTPResponse

func (response UpdateKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateKeyResponse) String

func (response UpdateKeyResponse) String() string

type UpdateVaultDetails

UpdateVaultDetails The representation of UpdateVaultDetails

type UpdateVaultDetails struct {

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // A user-friendly name for the vault. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

func (UpdateVaultDetails) String

func (m UpdateVaultDetails) String() string

type UpdateVaultRequest

UpdateVaultRequest wrapper for the UpdateVault operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/UpdateVault.go.html to see an example of how to use UpdateVaultRequest.

type UpdateVaultRequest struct {

    // The OCID of the vault.
    VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`

    // UpdateVaultDetails
    UpdateVaultDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call for a
    // resource, set the `if-match` parameter to the value of the etag from a
    // previous GET or POST response for that resource. The resource will be
    // updated or deleted only if the etag you provide matches the resource's
    // current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (UpdateVaultRequest) HTTPRequest

func (request UpdateVaultRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVaultRequest) RetryPolicy

func (request UpdateVaultRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVaultRequest) String

func (request UpdateVaultRequest) String() string

type UpdateVaultResponse

UpdateVaultResponse wrapper for the UpdateVault operation

type UpdateVaultResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Vault instance
    Vault `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (UpdateVaultResponse) HTTPResponse

func (response UpdateVaultResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVaultResponse) String

func (response UpdateVaultResponse) String() string

type Vault

Vault The representation of Vault

type Vault struct {

    // The OCID of the compartment that contains this vault.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The service endpoint to perform cryptographic operations against. Cryptographic operations include
    // Encrypt (https://docs.cloud.oracle.com/api/#/en/key/latest/EncryptedData/Encrypt), Decrypt (https://docs.cloud.oracle.com/api/#/en/key/latest/DecryptedData/Decrypt),
    // and GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations.
    CryptoEndpoint *string `mandatory:"true" json:"cryptoEndpoint"`

    // A user-friendly name for the vault. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID of the vault.
    Id *string `mandatory:"true" json:"id"`

    // The vault's current lifecycle state.
    // Example: `DELETED`
    LifecycleState VaultLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.
    ManagementEndpoint *string `mandatory:"true" json:"managementEndpoint"`

    // The date and time this vault was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The type of vault. Each type of vault stores the key with different
    // degrees of isolation and has different options and pricing.
    VaultType VaultVaultTypeEnum `mandatory:"true" json:"vaultType"`

    // The OCID of the vault's wrapping key.
    WrappingkeyId *string `mandatory:"true" json:"wrappingkeyId"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // An optional property to indicate when to delete the vault, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`

    // The OCID of the vault from which this vault was restored, if it was restored from a backup file.
    // If you restore a vault to the same region, the vault retains the same OCID that it had when you
    // backed up the vault.
    RestoredFromVaultId *string `mandatory:"false" json:"restoredFromVaultId"`
}

func (Vault) String

func (m Vault) String() string

type VaultLifecycleStateEnum

VaultLifecycleStateEnum Enum with underlying type: string

type VaultLifecycleStateEnum string

Set of constants representing the allowable values for VaultLifecycleStateEnum

const (
    VaultLifecycleStateCreating           VaultLifecycleStateEnum = "CREATING"
    VaultLifecycleStateActive             VaultLifecycleStateEnum = "ACTIVE"
    VaultLifecycleStateDeleting           VaultLifecycleStateEnum = "DELETING"
    VaultLifecycleStateDeleted            VaultLifecycleStateEnum = "DELETED"
    VaultLifecycleStatePendingDeletion    VaultLifecycleStateEnum = "PENDING_DELETION"
    VaultLifecycleStateSchedulingDeletion VaultLifecycleStateEnum = "SCHEDULING_DELETION"
    VaultLifecycleStateCancellingDeletion VaultLifecycleStateEnum = "CANCELLING_DELETION"
    VaultLifecycleStateUpdating           VaultLifecycleStateEnum = "UPDATING"
    VaultLifecycleStateBackupInProgress   VaultLifecycleStateEnum = "BACKUP_IN_PROGRESS"
    VaultLifecycleStateRestoring          VaultLifecycleStateEnum = "RESTORING"
)

func GetVaultLifecycleStateEnumValues

func GetVaultLifecycleStateEnumValues() []VaultLifecycleStateEnum

GetVaultLifecycleStateEnumValues Enumerates the set of values for VaultLifecycleStateEnum

type VaultSummary

VaultSummary The representation of VaultSummary

type VaultSummary struct {

    // The OCID of the compartment that contains a particular vault.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The service endpoint to perform cryptographic operations against. Cryptographic operations include
    // Encrypt (https://docs.cloud.oracle.com/api/#/en/key/latest/EncryptedData/Encrypt), Decrypt (https://docs.cloud.oracle.com/api/#/en/key/latest/DecryptedData/Decrypt),
    // and GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations.
    CryptoEndpoint *string `mandatory:"true" json:"cryptoEndpoint"`

    // A user-friendly name for a vault. It does not have to be unique, and it is changeable.
    // Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The OCID of a vault.
    Id *string `mandatory:"true" json:"id"`

    // A vault's current lifecycle state.
    // Example: `ACTIVE`
    LifecycleState VaultSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.
    ManagementEndpoint *string `mandatory:"true" json:"managementEndpoint"`

    // The date and time a vault was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The type of vault. Each type of vault stores keys with different
    // degrees of isolation and has different options and pricing.
    VaultType VaultSummaryVaultTypeEnum `mandatory:"true" json:"vaultType"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

func (VaultSummary) String

func (m VaultSummary) String() string

type VaultSummaryLifecycleStateEnum

VaultSummaryLifecycleStateEnum Enum with underlying type: string

type VaultSummaryLifecycleStateEnum string

Set of constants representing the allowable values for VaultSummaryLifecycleStateEnum

const (
    VaultSummaryLifecycleStateCreating           VaultSummaryLifecycleStateEnum = "CREATING"
    VaultSummaryLifecycleStateActive             VaultSummaryLifecycleStateEnum = "ACTIVE"
    VaultSummaryLifecycleStateDeleting           VaultSummaryLifecycleStateEnum = "DELETING"
    VaultSummaryLifecycleStateDeleted            VaultSummaryLifecycleStateEnum = "DELETED"
    VaultSummaryLifecycleStatePendingDeletion    VaultSummaryLifecycleStateEnum = "PENDING_DELETION"
    VaultSummaryLifecycleStateSchedulingDeletion VaultSummaryLifecycleStateEnum = "SCHEDULING_DELETION"
    VaultSummaryLifecycleStateCancellingDeletion VaultSummaryLifecycleStateEnum = "CANCELLING_DELETION"
    VaultSummaryLifecycleStateUpdating           VaultSummaryLifecycleStateEnum = "UPDATING"
    VaultSummaryLifecycleStateBackupInProgress   VaultSummaryLifecycleStateEnum = "BACKUP_IN_PROGRESS"
    VaultSummaryLifecycleStateRestoring          VaultSummaryLifecycleStateEnum = "RESTORING"
)

func GetVaultSummaryLifecycleStateEnumValues

func GetVaultSummaryLifecycleStateEnumValues() []VaultSummaryLifecycleStateEnum

GetVaultSummaryLifecycleStateEnumValues Enumerates the set of values for VaultSummaryLifecycleStateEnum

type VaultSummaryVaultTypeEnum

VaultSummaryVaultTypeEnum Enum with underlying type: string

type VaultSummaryVaultTypeEnum string

Set of constants representing the allowable values for VaultSummaryVaultTypeEnum

const (
    VaultSummaryVaultTypeVirtualPrivate VaultSummaryVaultTypeEnum = "VIRTUAL_PRIVATE"
    VaultSummaryVaultTypeDefault        VaultSummaryVaultTypeEnum = "DEFAULT"
)

func GetVaultSummaryVaultTypeEnumValues

func GetVaultSummaryVaultTypeEnumValues() []VaultSummaryVaultTypeEnum

GetVaultSummaryVaultTypeEnumValues Enumerates the set of values for VaultSummaryVaultTypeEnum

type VaultUsage

VaultUsage The representation of VaultUsage

type VaultUsage struct {

    // The number of keys in this vault that persist on a hardware security module (HSM), across all compartments, excluding keys in a `DELETED` state.
    KeyCount *int `mandatory:"true" json:"keyCount"`

    // The number of key versions in this vault that persist on a hardware security module (HSM), across all compartments, excluding key versions in a `DELETED` state.
    KeyVersionCount *int `mandatory:"true" json:"keyVersionCount"`

    // The number of keys in this vault that persist on the server, across all compartments, excluding keys in a `DELETED` state.
    SoftwareKeyCount *int `mandatory:"false" json:"softwareKeyCount"`

    // The number of key versions in this vault that persist on the server, across all compartments, excluding key versions in a `DELETED` state.
    SoftwareKeyVersionCount *int `mandatory:"false" json:"softwareKeyVersionCount"`
}

func (VaultUsage) String

func (m VaultUsage) String() string

type VaultVaultTypeEnum

VaultVaultTypeEnum Enum with underlying type: string

type VaultVaultTypeEnum string

Set of constants representing the allowable values for VaultVaultTypeEnum

const (
    VaultVaultTypeVirtualPrivate VaultVaultTypeEnum = "VIRTUAL_PRIVATE"
    VaultVaultTypeDefault        VaultVaultTypeEnum = "DEFAULT"
)

func GetVaultVaultTypeEnumValues

func GetVaultVaultTypeEnumValues() []VaultVaultTypeEnum

GetVaultVaultTypeEnumValues Enumerates the set of values for VaultVaultTypeEnum

type VerifiedData

VerifiedData The representation of VerifiedData

type VerifiedData struct {

    // A Boolean value that indicates whether the signature was verified.
    IsSignatureValid *bool `mandatory:"true" json:"isSignatureValid"`
}

func (VerifiedData) String

func (m VerifiedData) String() string

type VerifyDataDetails

VerifyDataDetails The representation of VerifyDataDetails

type VerifyDataDetails struct {

    // The OCID of the key used to sign the message
    KeyId *string `mandatory:"true" json:"keyId"`

    // The OCID of the keyVersion used to sign the message
    KeyVersionId *string `mandatory:"true" json:"keyVersionId"`

    // The Base64-encoded binary data object denoting the cryptographic signature that was generated for the message.
    Signature *string `mandatory:"true" json:"signature"`

    // The Base64-encoded binary data object denoting the message or message digest to be signed. Message can be upto 4096 size in bytes. To sign a larger message, provide the message digest.
    Message *string `mandatory:"true" json:"message"`

    // The algorithm to be used for signing the message or message digest
    // For RSA keys, there are two supported Signature Schemes: PKCS1 and PSS along with
    // different Hashing algorithms.
    // For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms.
    // In case of passing digest for signing, make sure the same hashing algorithm is
    // specified as used for created for digest.
    SigningAlgorithm VerifyDataDetailsSigningAlgorithmEnum `mandatory:"true" json:"signingAlgorithm"`

    // Denotes whether the value of the message parameter is a raw message or a message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
    MessageType VerifyDataDetailsMessageTypeEnum `mandatory:"false" json:"messageType,omitempty"`
}

func (VerifyDataDetails) String

func (m VerifyDataDetails) String() string

type VerifyDataDetailsMessageTypeEnum

VerifyDataDetailsMessageTypeEnum Enum with underlying type: string

type VerifyDataDetailsMessageTypeEnum string

Set of constants representing the allowable values for VerifyDataDetailsMessageTypeEnum

const (
    VerifyDataDetailsMessageTypeRaw    VerifyDataDetailsMessageTypeEnum = "RAW"
    VerifyDataDetailsMessageTypeDigest VerifyDataDetailsMessageTypeEnum = "DIGEST"
)

func GetVerifyDataDetailsMessageTypeEnumValues

func GetVerifyDataDetailsMessageTypeEnumValues() []VerifyDataDetailsMessageTypeEnum

GetVerifyDataDetailsMessageTypeEnumValues Enumerates the set of values for VerifyDataDetailsMessageTypeEnum

type VerifyDataDetailsSigningAlgorithmEnum

VerifyDataDetailsSigningAlgorithmEnum Enum with underlying type: string

type VerifyDataDetailsSigningAlgorithmEnum string

Set of constants representing the allowable values for VerifyDataDetailsSigningAlgorithmEnum

const (
    VerifyDataDetailsSigningAlgorithmSha224RsaPkcsPss  VerifyDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS_PSS"
    VerifyDataDetailsSigningAlgorithmSha256RsaPkcsPss  VerifyDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS_PSS"
    VerifyDataDetailsSigningAlgorithmSha384RsaPkcsPss  VerifyDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS_PSS"
    VerifyDataDetailsSigningAlgorithmSha512RsaPkcsPss  VerifyDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS_PSS"
    VerifyDataDetailsSigningAlgorithmSha224RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS1_V1_5"
    VerifyDataDetailsSigningAlgorithmSha256RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS1_V1_5"
    VerifyDataDetailsSigningAlgorithmSha384RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS1_V1_5"
    VerifyDataDetailsSigningAlgorithmSha512RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS1_V1_5"
    VerifyDataDetailsSigningAlgorithmEcdsaSha256       VerifyDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_256"
    VerifyDataDetailsSigningAlgorithmEcdsaSha384       VerifyDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_384"
    VerifyDataDetailsSigningAlgorithmEcdsaSha512       VerifyDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_512"
)

func GetVerifyDataDetailsSigningAlgorithmEnumValues

func GetVerifyDataDetailsSigningAlgorithmEnumValues() []VerifyDataDetailsSigningAlgorithmEnum

GetVerifyDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for VerifyDataDetailsSigningAlgorithmEnum

type VerifyRequest

VerifyRequest wrapper for the Verify operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/keymanagement/Verify.go.html to see an example of how to use VerifyRequest.

type VerifyRequest struct {

    // VerifyDataDetails
    VerifyDataDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID
    // will include this value. Otherwise, a random request ID will be
    // generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (VerifyRequest) HTTPRequest

func (request VerifyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (VerifyRequest) RetryPolicy

func (request VerifyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (VerifyRequest) String

func (request VerifyRequest) String() string

type VerifyResponse

VerifyResponse wrapper for the Verify operation

type VerifyResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The VerifiedData instance
    VerifiedData `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
    // a particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (VerifyResponse) HTTPResponse

func (response VerifyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (VerifyResponse) String

func (response VerifyResponse) String() string

type WrappedImportKey

WrappedImportKey The representation of WrappedImportKey

type WrappedImportKey struct {

    // The key material to import, wrapped by the vault's public RSA wrapping key and base64-encoded.
    KeyMaterial *string `mandatory:"true" json:"keyMaterial"`

    // The wrapping mechanism to use during key import.
    // RSA_OAEP_AES_SHA256 invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped
    // by the Vault RSA public wrapping key, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the private key material.
    // The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them.
    // RSA_OAEP_SHA256 means that the exportable key material is wrapped by the Vault RSA public wrapping key.
    WrappingAlgorithm WrappedImportKeyWrappingAlgorithmEnum `mandatory:"true" json:"wrappingAlgorithm"`
}

func (WrappedImportKey) String

func (m WrappedImportKey) String() string

type WrappedImportKeyWrappingAlgorithmEnum

WrappedImportKeyWrappingAlgorithmEnum Enum with underlying type: string

type WrappedImportKeyWrappingAlgorithmEnum string

Set of constants representing the allowable values for WrappedImportKeyWrappingAlgorithmEnum

const (
    WrappedImportKeyWrappingAlgorithmSha256    WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_SHA256"
    WrappedImportKeyWrappingAlgorithmAesSha256 WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_AES_SHA256"
)

func GetWrappedImportKeyWrappingAlgorithmEnumValues

func GetWrappedImportKeyWrappingAlgorithmEnumValues() []WrappedImportKeyWrappingAlgorithmEnum

GetWrappedImportKeyWrappingAlgorithmEnumValues Enumerates the set of values for WrappedImportKeyWrappingAlgorithmEnum

type WrappingKey

WrappingKey The representation of WrappingKey

type WrappingKey struct {

    // The OCID of the compartment that contains this key.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The OCID of the key.
    Id *string `mandatory:"true" json:"id"`

    // The key's current lifecycle state.
    // Example: `ENABLED`
    LifecycleState WrappingKeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The public key, in PEM format, to use to wrap the key material before importing it.
    PublicKey *string `mandatory:"true" json:"publicKey"`

    // The date and time the key was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The OCID of the vault that contains this key.
    VaultId *string `mandatory:"true" json:"vaultId"`
}

func (WrappingKey) String

func (m WrappingKey) String() string

type WrappingKeyLifecycleStateEnum

WrappingKeyLifecycleStateEnum Enum with underlying type: string

type WrappingKeyLifecycleStateEnum string

Set of constants representing the allowable values for WrappingKeyLifecycleStateEnum

const (
    WrappingKeyLifecycleStateCreating           WrappingKeyLifecycleStateEnum = "CREATING"
    WrappingKeyLifecycleStateEnabling           WrappingKeyLifecycleStateEnum = "ENABLING"
    WrappingKeyLifecycleStateEnabled            WrappingKeyLifecycleStateEnum = "ENABLED"
    WrappingKeyLifecycleStateDisabling          WrappingKeyLifecycleStateEnum = "DISABLING"
    WrappingKeyLifecycleStateDisabled           WrappingKeyLifecycleStateEnum = "DISABLED"
    WrappingKeyLifecycleStateDeleting           WrappingKeyLifecycleStateEnum = "DELETING"
    WrappingKeyLifecycleStateDeleted            WrappingKeyLifecycleStateEnum = "DELETED"
    WrappingKeyLifecycleStatePendingDeletion    WrappingKeyLifecycleStateEnum = "PENDING_DELETION"
    WrappingKeyLifecycleStateSchedulingDeletion WrappingKeyLifecycleStateEnum = "SCHEDULING_DELETION"
    WrappingKeyLifecycleStateCancellingDeletion WrappingKeyLifecycleStateEnum = "CANCELLING_DELETION"
    WrappingKeyLifecycleStateUpdating           WrappingKeyLifecycleStateEnum = "UPDATING"
    WrappingKeyLifecycleStateBackupInProgress   WrappingKeyLifecycleStateEnum = "BACKUP_IN_PROGRESS"
    WrappingKeyLifecycleStateRestoring          WrappingKeyLifecycleStateEnum = "RESTORING"
)

func GetWrappingKeyLifecycleStateEnumValues

func GetWrappingKeyLifecycleStateEnumValues() []WrappingKeyLifecycleStateEnum

GetWrappingKeyLifecycleStateEnumValues Enumerates the set of values for WrappingKeyLifecycleStateEnum