Documentation ¶
Index ¶
- type BackupKeyDetails
- type BackupKeyRequest
- type BackupKeyResponse
- type BackupLocation
- type BackupLocationBucket
- type BackupLocationDestinationEnum
- type BackupLocationUri
- type BackupVaultDetails
- type BackupVaultRequest
- type BackupVaultResponse
- type CancelKeyDeletionRequest
- type CancelKeyDeletionResponse
- type CancelKeyVersionDeletionRequest
- type CancelKeyVersionDeletionResponse
- type CancelVaultDeletionRequest
- type CancelVaultDeletionResponse
- type ChangeKeyCompartmentDetails
- type ChangeKeyCompartmentRequest
- type ChangeKeyCompartmentResponse
- type ChangeVaultCompartmentDetails
- type ChangeVaultCompartmentRequest
- type ChangeVaultCompartmentResponse
- type CreateKeyDetails
- type CreateKeyDetailsProtectionModeEnum
- type CreateKeyRequest
- type CreateKeyResponse
- type CreateKeyVersionRequest
- type CreateKeyVersionResponse
- type CreateVaultDetails
- type CreateVaultDetailsVaultTypeEnum
- type CreateVaultRequest
- type CreateVaultResponse
- type DecryptDataDetails
- type DecryptDataDetailsEncryptionAlgorithmEnum
- type DecryptRequest
- type DecryptResponse
- type DecryptedData
- type DecryptedDataEncryptionAlgorithmEnum
- type DisableKeyRequest
- type DisableKeyResponse
- type EnableKeyRequest
- type EnableKeyResponse
- type EncryptDataDetails
- type EncryptDataDetailsEncryptionAlgorithmEnum
- type EncryptRequest
- type EncryptResponse
- type EncryptedData
- type EncryptedDataEncryptionAlgorithmEnum
- type ExportKeyDetails
- type ExportKeyDetailsAlgorithmEnum
- type ExportKeyRequest
- type ExportKeyResponse
- type ExportedKeyData
- type ExportedKeyDataAlgorithmEnum
- type GenerateDataEncryptionKeyRequest
- type GenerateDataEncryptionKeyResponse
- type GenerateKeyDetails
- type GeneratedKey
- type GetKeyRequest
- type GetKeyResponse
- type GetKeyVersionRequest
- type GetKeyVersionResponse
- type GetVaultRequest
- type GetVaultResponse
- type GetVaultUsageRequest
- type GetVaultUsageResponse
- type GetWrappingKeyRequest
- type GetWrappingKeyResponse
- type ImportKeyDetails
- type ImportKeyDetailsProtectionModeEnum
- type ImportKeyRequest
- type ImportKeyResponse
- type ImportKeyVersionDetails
- type ImportKeyVersionRequest
- type ImportKeyVersionResponse
- type Key
- type KeyLifecycleStateEnum
- type KeyProtectionModeEnum
- type KeyShape
- type KeyShapeAlgorithmEnum
- type KeyShapeCurveIdEnum
- type KeySummary
- type KeySummaryAlgorithmEnum
- type KeySummaryLifecycleStateEnum
- type KeySummaryProtectionModeEnum
- type KeyVersion
- type KeyVersionLifecycleStateEnum
- type KeyVersionOriginEnum
- type KeyVersionSummary
- type KeyVersionSummaryLifecycleStateEnum
- type KeyVersionSummaryOriginEnum
- type KmsCryptoClient
- 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 (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
- type ListKeyVersionsResponse
- type ListKeyVersionsSortByEnum
- type ListKeyVersionsSortOrderEnum
- type ListKeysAlgorithmEnum
- type ListKeysCurveIdEnum
- type ListKeysProtectionModeEnum
- type ListKeysRequest
- type ListKeysResponse
- type ListKeysSortByEnum
- type ListKeysSortOrderEnum
- type ListVaultsRequest
- type ListVaultsResponse
- type ListVaultsSortByEnum
- type ListVaultsSortOrderEnum
- type RestoreKeyFromFileRequest
- type RestoreKeyFromFileResponse
- type RestoreKeyFromObjectStoreDetails
- type RestoreKeyFromObjectStoreRequest
- type RestoreKeyFromObjectStoreResponse
- type RestoreVaultFromFileRequest
- type RestoreVaultFromFileResponse
- type RestoreVaultFromObjectStoreDetails
- type RestoreVaultFromObjectStoreRequest
- type RestoreVaultFromObjectStoreResponse
- type ScheduleKeyDeletionDetails
- type ScheduleKeyDeletionRequest
- type ScheduleKeyDeletionResponse
- type ScheduleKeyVersionDeletionDetails
- type ScheduleKeyVersionDeletionRequest
- type ScheduleKeyVersionDeletionResponse
- type ScheduleVaultDeletionDetails
- type ScheduleVaultDeletionRequest
- type ScheduleVaultDeletionResponse
- type SignDataDetails
- type SignDataDetailsMessageTypeEnum
- type SignDataDetailsSigningAlgorithmEnum
- type SignRequest
- type SignResponse
- type SignedData
- type SignedDataSigningAlgorithmEnum
- type UpdateKeyDetails
- type UpdateKeyRequest
- type UpdateKeyResponse
- type UpdateVaultDetails
- type UpdateVaultRequest
- type UpdateVaultResponse
- type Vault
- type VaultLifecycleStateEnum
- type VaultSummary
- type VaultSummaryLifecycleStateEnum
- type VaultSummaryVaultTypeEnum
- type VaultUsage
- type VaultVaultTypeEnum
- type VerifiedData
- type VerifyDataDetails
- type VerifyDataDetailsMessageTypeEnum
- type VerifyDataDetailsSigningAlgorithmEnum
- type VerifyRequest
- type VerifyResponse
- type WrappedImportKey
- type WrappedImportKeyWrappingAlgorithmEnum
- type WrappingKey
- type WrappingKeyLifecycleStateEnum
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BackupKeyDetails ¶
type BackupKeyDetails struct {
BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
}
BackupKeyDetails The representation of BackupKeyDetails
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 ¶
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 }
BackupKeyRequest wrapper for the BackupKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/BackupKey.go.html to see an example of how to use BackupKeyRequest.
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 ¶
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"` }
BackupKeyResponse wrapper for the BackupKey operation
func (BackupKeyResponse) HTTPResponse ¶
func (response BackupKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (BackupKeyResponse) String ¶
func (response BackupKeyResponse) String() string
type BackupLocationBucket ¶
type BackupLocationBucket struct { Namespace *string `mandatory:"true" json:"namespace"` BucketName *string `mandatory:"true" json:"bucketName"` ObjectName *string `mandatory:"true" json:"objectName"` }
BackupLocationBucket Object storage bucket details to upload or download the backup
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 ¶
type BackupLocationDestinationEnum string
BackupLocationDestinationEnum Enum with underlying type: string
const ( BackupLocationDestinationBucket BackupLocationDestinationEnum = "BUCKET" BackupLocationDestinationPreAuthenticatedRequestUri BackupLocationDestinationEnum = "PRE_AUTHENTICATED_REQUEST_URI" )
Set of constants representing the allowable values for BackupLocationDestinationEnum
func GetBackupLocationDestinationEnumValues ¶
func GetBackupLocationDestinationEnumValues() []BackupLocationDestinationEnum
GetBackupLocationDestinationEnumValues Enumerates the set of values for BackupLocationDestinationEnum
type BackupLocationUri ¶
type BackupLocationUri struct {
Uri *string `mandatory:"true" json:"uri"`
}
BackupLocationUri PreAuthenticated object storage URI to upload or download the backup
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 ¶
type BackupVaultDetails struct { BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"` IsIncludeKeys *bool `mandatory:"false" json:"isIncludeKeys"` }
BackupVaultDetails The representation of BackupVaultDetails
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 ¶
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 }
BackupVaultRequest wrapper for the BackupVault operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/BackupVault.go.html to see an example of how to use BackupVaultRequest.
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 ¶
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"` }
BackupVaultResponse wrapper for the BackupVault operation
func (BackupVaultResponse) HTTPResponse ¶
func (response BackupVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (BackupVaultResponse) String ¶
func (response BackupVaultResponse) String() string
type 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 }
CancelKeyDeletionRequest wrapper for the CancelKeyDeletion operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CancelKeyDeletion.go.html to see an example of how to use CancelKeyDeletionRequest.
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 ¶
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"` }
CancelKeyDeletionResponse wrapper for the CancelKeyDeletion operation
func (CancelKeyDeletionResponse) HTTPResponse ¶
func (response CancelKeyDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CancelKeyDeletionResponse) String ¶
func (response CancelKeyDeletionResponse) String() string
type 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 }
CancelKeyVersionDeletionRequest wrapper for the CancelKeyVersionDeletion operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CancelKeyVersionDeletion.go.html to see an example of how to use CancelKeyVersionDeletionRequest.
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 ¶
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"` }
CancelKeyVersionDeletionResponse wrapper for the CancelKeyVersionDeletion operation
func (CancelKeyVersionDeletionResponse) HTTPResponse ¶
func (response CancelKeyVersionDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CancelKeyVersionDeletionResponse) String ¶
func (response CancelKeyVersionDeletionResponse) String() string
type 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 }
CancelVaultDeletionRequest wrapper for the CancelVaultDeletion operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CancelVaultDeletion.go.html to see an example of how to use CancelVaultDeletionRequest.
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 ¶
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"` }
CancelVaultDeletionResponse wrapper for the CancelVaultDeletion operation
func (CancelVaultDeletionResponse) HTTPResponse ¶
func (response CancelVaultDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CancelVaultDeletionResponse) String ¶
func (response CancelVaultDeletionResponse) String() string
type 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"` }
ChangeKeyCompartmentDetails The representation of ChangeKeyCompartmentDetails
func (ChangeKeyCompartmentDetails) String ¶
func (m ChangeKeyCompartmentDetails) String() string
type 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 }
ChangeKeyCompartmentRequest wrapper for the ChangeKeyCompartment operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ChangeKeyCompartment.go.html to see an example of how to use ChangeKeyCompartmentRequest.
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 ¶
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"` }
ChangeKeyCompartmentResponse wrapper for the ChangeKeyCompartment operation
func (ChangeKeyCompartmentResponse) HTTPResponse ¶
func (response ChangeKeyCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ChangeKeyCompartmentResponse) String ¶
func (response ChangeKeyCompartmentResponse) String() string
type 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"` }
ChangeVaultCompartmentDetails The representation of ChangeVaultCompartmentDetails
func (ChangeVaultCompartmentDetails) String ¶
func (m ChangeVaultCompartmentDetails) String() string
type 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 }
ChangeVaultCompartmentRequest wrapper for the ChangeVaultCompartment operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ChangeVaultCompartment.go.html to see an example of how to use ChangeVaultCompartmentRequest.
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 ¶
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"` }
ChangeVaultCompartmentResponse wrapper for the ChangeVaultCompartment operation
func (ChangeVaultCompartmentResponse) HTTPResponse ¶
func (response ChangeVaultCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ChangeVaultCompartmentResponse) String ¶
func (response ChangeVaultCompartmentResponse) String() string
type 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"` }
CreateKeyDetails The representation of CreateKeyDetails
func (CreateKeyDetails) String ¶
func (m CreateKeyDetails) String() string
type CreateKeyDetailsProtectionModeEnum ¶
type CreateKeyDetailsProtectionModeEnum string
CreateKeyDetailsProtectionModeEnum Enum with underlying type: string
const ( CreateKeyDetailsProtectionModeHsm CreateKeyDetailsProtectionModeEnum = "HSM" CreateKeyDetailsProtectionModeSoftware CreateKeyDetailsProtectionModeEnum = "SOFTWARE" )
Set of constants representing the allowable values for CreateKeyDetailsProtectionModeEnum
func GetCreateKeyDetailsProtectionModeEnumValues ¶
func GetCreateKeyDetailsProtectionModeEnumValues() []CreateKeyDetailsProtectionModeEnum
GetCreateKeyDetailsProtectionModeEnumValues Enumerates the set of values for CreateKeyDetailsProtectionModeEnum
type 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 }
CreateKeyRequest wrapper for the CreateKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateKey.go.html to see an example of how to use CreateKeyRequest.
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 ¶
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"` }
CreateKeyResponse wrapper for the CreateKey operation
func (CreateKeyResponse) HTTPResponse ¶
func (response CreateKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateKeyResponse) String ¶
func (response CreateKeyResponse) String() string
type 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 }
CreateKeyVersionRequest wrapper for the CreateKeyVersion operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateKeyVersion.go.html to see an example of how to use CreateKeyVersionRequest.
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 ¶
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"` }
CreateKeyVersionResponse wrapper for the CreateKeyVersion operation
func (CreateKeyVersionResponse) HTTPResponse ¶
func (response CreateKeyVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateKeyVersionResponse) String ¶
func (response CreateKeyVersionResponse) String() string
type 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"` }
CreateVaultDetails The representation of CreateVaultDetails
func (CreateVaultDetails) String ¶
func (m CreateVaultDetails) String() string
type CreateVaultDetailsVaultTypeEnum ¶
type CreateVaultDetailsVaultTypeEnum string
CreateVaultDetailsVaultTypeEnum Enum with underlying type: string
const ( CreateVaultDetailsVaultTypeVirtualPrivate CreateVaultDetailsVaultTypeEnum = "VIRTUAL_PRIVATE" CreateVaultDetailsVaultTypeDefault CreateVaultDetailsVaultTypeEnum = "DEFAULT" )
Set of constants representing the allowable values for CreateVaultDetailsVaultTypeEnum
func GetCreateVaultDetailsVaultTypeEnumValues ¶
func GetCreateVaultDetailsVaultTypeEnumValues() []CreateVaultDetailsVaultTypeEnum
GetCreateVaultDetailsVaultTypeEnumValues Enumerates the set of values for CreateVaultDetailsVaultTypeEnum
type 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 }
CreateVaultRequest wrapper for the CreateVault operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateVault.go.html to see an example of how to use CreateVaultRequest.
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 ¶
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"` }
CreateVaultResponse wrapper for the CreateVault operation
func (CreateVaultResponse) HTTPResponse ¶
func (response CreateVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateVaultResponse) String ¶
func (response CreateVaultResponse) String() string
type 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"` }
DecryptDataDetails The representation of DecryptDataDetails
func (DecryptDataDetails) String ¶
func (m DecryptDataDetails) String() string
type DecryptDataDetailsEncryptionAlgorithmEnum ¶
type DecryptDataDetailsEncryptionAlgorithmEnum string
DecryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string
const ( DecryptDataDetailsEncryptionAlgorithmAes256Gcm DecryptDataDetailsEncryptionAlgorithmEnum = "AES_256_GCM" DecryptDataDetailsEncryptionAlgorithmRsaOaepSha1 DecryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1" DecryptDataDetailsEncryptionAlgorithmRsaOaepSha256 DecryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256" )
Set of constants representing the allowable values for DecryptDataDetailsEncryptionAlgorithmEnum
func GetDecryptDataDetailsEncryptionAlgorithmEnumValues ¶
func GetDecryptDataDetailsEncryptionAlgorithmEnumValues() []DecryptDataDetailsEncryptionAlgorithmEnum
GetDecryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptDataDetailsEncryptionAlgorithmEnum
type 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 }
DecryptRequest wrapper for the Decrypt operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/Decrypt.go.html to see an example of how to use DecryptRequest.
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 ¶
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"` }
DecryptResponse wrapper for the Decrypt operation
func (DecryptResponse) HTTPResponse ¶
func (response DecryptResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DecryptResponse) String ¶
func (response DecryptResponse) String() string
type 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"` }
DecryptedData The representation of DecryptedData
func (DecryptedData) String ¶
func (m DecryptedData) String() string
type DecryptedDataEncryptionAlgorithmEnum ¶
type DecryptedDataEncryptionAlgorithmEnum string
DecryptedDataEncryptionAlgorithmEnum Enum with underlying type: string
const ( DecryptedDataEncryptionAlgorithmAes256Gcm DecryptedDataEncryptionAlgorithmEnum = "AES_256_GCM" DecryptedDataEncryptionAlgorithmRsaOaepSha1 DecryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1" DecryptedDataEncryptionAlgorithmRsaOaepSha256 DecryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256" )
Set of constants representing the allowable values for DecryptedDataEncryptionAlgorithmEnum
func GetDecryptedDataEncryptionAlgorithmEnumValues ¶
func GetDecryptedDataEncryptionAlgorithmEnumValues() []DecryptedDataEncryptionAlgorithmEnum
GetDecryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptedDataEncryptionAlgorithmEnum
type 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 }
DisableKeyRequest wrapper for the DisableKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/DisableKey.go.html to see an example of how to use DisableKeyRequest.
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 ¶
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"` }
DisableKeyResponse wrapper for the DisableKey operation
func (DisableKeyResponse) HTTPResponse ¶
func (response DisableKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DisableKeyResponse) String ¶
func (response DisableKeyResponse) String() string
type 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 }
EnableKeyRequest wrapper for the EnableKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/EnableKey.go.html to see an example of how to use EnableKeyRequest.
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 ¶
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"` }
EnableKeyResponse wrapper for the EnableKey operation
func (EnableKeyResponse) HTTPResponse ¶
func (response EnableKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (EnableKeyResponse) String ¶
func (response EnableKeyResponse) String() string
type 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"` }
EncryptDataDetails The representation of EncryptDataDetails
func (EncryptDataDetails) String ¶
func (m EncryptDataDetails) String() string
type EncryptDataDetailsEncryptionAlgorithmEnum ¶
type EncryptDataDetailsEncryptionAlgorithmEnum string
EncryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string
const ( EncryptDataDetailsEncryptionAlgorithmAes256Gcm EncryptDataDetailsEncryptionAlgorithmEnum = "AES_256_GCM" EncryptDataDetailsEncryptionAlgorithmRsaOaepSha1 EncryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1" EncryptDataDetailsEncryptionAlgorithmRsaOaepSha256 EncryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256" )
Set of constants representing the allowable values for EncryptDataDetailsEncryptionAlgorithmEnum
func GetEncryptDataDetailsEncryptionAlgorithmEnumValues ¶
func GetEncryptDataDetailsEncryptionAlgorithmEnumValues() []EncryptDataDetailsEncryptionAlgorithmEnum
GetEncryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptDataDetailsEncryptionAlgorithmEnum
type 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 }
EncryptRequest wrapper for the Encrypt operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/Encrypt.go.html to see an example of how to use EncryptRequest.
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 ¶
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"` }
EncryptResponse wrapper for the Encrypt operation
func (EncryptResponse) HTTPResponse ¶
func (response EncryptResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (EncryptResponse) String ¶
func (response EncryptResponse) String() string
type 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"` }
EncryptedData The representation of EncryptedData
func (EncryptedData) String ¶
func (m EncryptedData) String() string
type EncryptedDataEncryptionAlgorithmEnum ¶
type EncryptedDataEncryptionAlgorithmEnum string
EncryptedDataEncryptionAlgorithmEnum Enum with underlying type: string
const ( EncryptedDataEncryptionAlgorithmAes256Gcm EncryptedDataEncryptionAlgorithmEnum = "AES_256_GCM" EncryptedDataEncryptionAlgorithmRsaOaepSha1 EncryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1" EncryptedDataEncryptionAlgorithmRsaOaepSha256 EncryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256" )
Set of constants representing the allowable values for EncryptedDataEncryptionAlgorithmEnum
func GetEncryptedDataEncryptionAlgorithmEnumValues ¶
func GetEncryptedDataEncryptionAlgorithmEnumValues() []EncryptedDataEncryptionAlgorithmEnum
GetEncryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptedDataEncryptionAlgorithmEnum
type ExportKeyDetails ¶
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"` }
ExportKeyDetails The details of the key that you want to wrap and export.
func (ExportKeyDetails) String ¶
func (m ExportKeyDetails) String() string
type ExportKeyDetailsAlgorithmEnum ¶
type ExportKeyDetailsAlgorithmEnum string
ExportKeyDetailsAlgorithmEnum Enum with underlying type: string
const ( ExportKeyDetailsAlgorithmAesSha256 ExportKeyDetailsAlgorithmEnum = "RSA_OAEP_AES_SHA256" ExportKeyDetailsAlgorithmSha256 ExportKeyDetailsAlgorithmEnum = "RSA_OAEP_SHA256" )
Set of constants representing the allowable values for ExportKeyDetailsAlgorithmEnum
func GetExportKeyDetailsAlgorithmEnumValues ¶
func GetExportKeyDetailsAlgorithmEnumValues() []ExportKeyDetailsAlgorithmEnum
GetExportKeyDetailsAlgorithmEnumValues Enumerates the set of values for ExportKeyDetailsAlgorithmEnum
type 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 }
ExportKeyRequest wrapper for the ExportKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ExportKey.go.html to see an example of how to use ExportKeyRequest.
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 ¶
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"` }
ExportKeyResponse wrapper for the ExportKey operation
func (ExportKeyResponse) HTTPResponse ¶
func (response ExportKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ExportKeyResponse) String ¶
func (response ExportKeyResponse) String() string
type ExportedKeyData ¶
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"` }
ExportedKeyData The response to a request to export key material.
func (ExportedKeyData) String ¶
func (m ExportedKeyData) String() string
type ExportedKeyDataAlgorithmEnum ¶
type ExportedKeyDataAlgorithmEnum string
ExportedKeyDataAlgorithmEnum Enum with underlying type: string
const ( ExportedKeyDataAlgorithmAesSha256 ExportedKeyDataAlgorithmEnum = "RSA_OAEP_AES_SHA256" ExportedKeyDataAlgorithmSha256 ExportedKeyDataAlgorithmEnum = "RSA_OAEP_SHA256" )
Set of constants representing the allowable values for ExportedKeyDataAlgorithmEnum
func GetExportedKeyDataAlgorithmEnumValues ¶
func GetExportedKeyDataAlgorithmEnumValues() []ExportedKeyDataAlgorithmEnum
GetExportedKeyDataAlgorithmEnumValues Enumerates the set of values for ExportedKeyDataAlgorithmEnum
type 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 }
GenerateDataEncryptionKeyRequest wrapper for the GenerateDataEncryptionKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GenerateDataEncryptionKey.go.html to see an example of how to use GenerateDataEncryptionKeyRequest.
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 ¶
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"` }
GenerateDataEncryptionKeyResponse wrapper for the GenerateDataEncryptionKey operation
func (GenerateDataEncryptionKeyResponse) HTTPResponse ¶
func (response GenerateDataEncryptionKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GenerateDataEncryptionKeyResponse) String ¶
func (response GenerateDataEncryptionKeyResponse) String() string
type 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"` }
GenerateKeyDetails The representation of GenerateKeyDetails
func (GenerateKeyDetails) String ¶
func (m GenerateKeyDetails) String() string
type 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"` }
GeneratedKey The representation of GeneratedKey
func (GeneratedKey) String ¶
func (m GeneratedKey) String() string
type 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 }
GetKeyRequest wrapper for the GetKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetKey.go.html to see an example of how to use GetKeyRequest.
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 ¶
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"` }
GetKeyResponse wrapper for the GetKey operation
func (GetKeyResponse) HTTPResponse ¶
func (response GetKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetKeyResponse) String ¶
func (response GetKeyResponse) String() string
type 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 }
GetKeyVersionRequest wrapper for the GetKeyVersion operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetKeyVersion.go.html to see an example of how to use GetKeyVersionRequest.
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 ¶
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"` }
GetKeyVersionResponse wrapper for the GetKeyVersion operation
func (GetKeyVersionResponse) HTTPResponse ¶
func (response GetKeyVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetKeyVersionResponse) String ¶
func (response GetKeyVersionResponse) String() string
type 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 }
GetVaultRequest wrapper for the GetVault operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetVault.go.html to see an example of how to use GetVaultRequest.
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 ¶
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"` }
GetVaultResponse wrapper for the GetVault operation
func (GetVaultResponse) HTTPResponse ¶
func (response GetVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetVaultResponse) String ¶
func (response GetVaultResponse) String() string
type 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 }
GetVaultUsageRequest wrapper for the GetVaultUsage operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetVaultUsage.go.html to see an example of how to use GetVaultUsageRequest.
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 ¶
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"` }
GetVaultUsageResponse wrapper for the GetVaultUsage operation
func (GetVaultUsageResponse) HTTPResponse ¶
func (response GetVaultUsageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetVaultUsageResponse) String ¶
func (response GetVaultUsageResponse) String() string
type 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 }
GetWrappingKeyRequest wrapper for the GetWrappingKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetWrappingKey.go.html to see an example of how to use GetWrappingKeyRequest.
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 ¶
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"` }
GetWrappingKeyResponse wrapper for the GetWrappingKey operation
func (GetWrappingKeyResponse) HTTPResponse ¶
func (response GetWrappingKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetWrappingKeyResponse) String ¶
func (response GetWrappingKeyResponse) String() string
type 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"` }
ImportKeyDetails The representation of ImportKeyDetails
func (ImportKeyDetails) String ¶
func (m ImportKeyDetails) String() string
type ImportKeyDetailsProtectionModeEnum ¶
type ImportKeyDetailsProtectionModeEnum string
ImportKeyDetailsProtectionModeEnum Enum with underlying type: string
const ( ImportKeyDetailsProtectionModeHsm ImportKeyDetailsProtectionModeEnum = "HSM" ImportKeyDetailsProtectionModeSoftware ImportKeyDetailsProtectionModeEnum = "SOFTWARE" )
Set of constants representing the allowable values for ImportKeyDetailsProtectionModeEnum
func GetImportKeyDetailsProtectionModeEnumValues ¶
func GetImportKeyDetailsProtectionModeEnumValues() []ImportKeyDetailsProtectionModeEnum
GetImportKeyDetailsProtectionModeEnumValues Enumerates the set of values for ImportKeyDetailsProtectionModeEnum
type 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 }
ImportKeyRequest wrapper for the ImportKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ImportKey.go.html to see an example of how to use ImportKeyRequest.
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 ¶
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"` }
ImportKeyResponse wrapper for the ImportKey operation
func (ImportKeyResponse) HTTPResponse ¶
func (response ImportKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ImportKeyResponse) String ¶
func (response ImportKeyResponse) String() string
type 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"` }
ImportKeyVersionDetails The representation of ImportKeyVersionDetails
func (ImportKeyVersionDetails) String ¶
func (m ImportKeyVersionDetails) String() string
type 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 }
ImportKeyVersionRequest wrapper for the ImportKeyVersion operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ImportKeyVersion.go.html to see an example of how to use ImportKeyVersionRequest.
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 ¶
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"` }
ImportKeyVersionResponse wrapper for the ImportKeyVersion operation
func (ImportKeyVersionResponse) HTTPResponse ¶
func (response ImportKeyVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ImportKeyVersionResponse) String ¶
func (response ImportKeyVersionResponse) String() string
type 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"` }
Key The representation of Key
type KeyLifecycleStateEnum ¶
type KeyLifecycleStateEnum string
KeyLifecycleStateEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for KeyLifecycleStateEnum
func GetKeyLifecycleStateEnumValues ¶
func GetKeyLifecycleStateEnumValues() []KeyLifecycleStateEnum
GetKeyLifecycleStateEnumValues Enumerates the set of values for KeyLifecycleStateEnum
type KeyProtectionModeEnum ¶
type KeyProtectionModeEnum string
KeyProtectionModeEnum Enum with underlying type: string
const ( KeyProtectionModeHsm KeyProtectionModeEnum = "HSM" KeyProtectionModeSoftware KeyProtectionModeEnum = "SOFTWARE" )
Set of constants representing the allowable values for KeyProtectionModeEnum
func GetKeyProtectionModeEnumValues ¶
func GetKeyProtectionModeEnumValues() []KeyProtectionModeEnum
GetKeyProtectionModeEnumValues Enumerates the set of values for KeyProtectionModeEnum
type KeyShape ¶
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"` }
KeyShape The cryptographic properties of a key.
type KeyShapeAlgorithmEnum ¶
type KeyShapeAlgorithmEnum string
KeyShapeAlgorithmEnum Enum with underlying type: string
const ( KeyShapeAlgorithmAes KeyShapeAlgorithmEnum = "AES" KeyShapeAlgorithmRsa KeyShapeAlgorithmEnum = "RSA" KeyShapeAlgorithmEcdsa KeyShapeAlgorithmEnum = "ECDSA" )
Set of constants representing the allowable values for KeyShapeAlgorithmEnum
func GetKeyShapeAlgorithmEnumValues ¶
func GetKeyShapeAlgorithmEnumValues() []KeyShapeAlgorithmEnum
GetKeyShapeAlgorithmEnumValues Enumerates the set of values for KeyShapeAlgorithmEnum
type KeyShapeCurveIdEnum ¶
type KeyShapeCurveIdEnum string
KeyShapeCurveIdEnum Enum with underlying type: string
const ( KeyShapeCurveIdP256 KeyShapeCurveIdEnum = "NIST_P256" KeyShapeCurveIdP384 KeyShapeCurveIdEnum = "NIST_P384" KeyShapeCurveIdP521 KeyShapeCurveIdEnum = "NIST_P521" )
Set of constants representing the allowable values for KeyShapeCurveIdEnum
func GetKeyShapeCurveIdEnumValues ¶
func GetKeyShapeCurveIdEnumValues() []KeyShapeCurveIdEnum
GetKeyShapeCurveIdEnumValues Enumerates the set of values for KeyShapeCurveIdEnum
type 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"` }
KeySummary The representation of KeySummary
func (KeySummary) String ¶
func (m KeySummary) String() string
type KeySummaryAlgorithmEnum ¶
type KeySummaryAlgorithmEnum string
KeySummaryAlgorithmEnum Enum with underlying type: string
const ( KeySummaryAlgorithmAes KeySummaryAlgorithmEnum = "AES" KeySummaryAlgorithmRsa KeySummaryAlgorithmEnum = "RSA" KeySummaryAlgorithmEcdsa KeySummaryAlgorithmEnum = "ECDSA" )
Set of constants representing the allowable values for KeySummaryAlgorithmEnum
func GetKeySummaryAlgorithmEnumValues ¶
func GetKeySummaryAlgorithmEnumValues() []KeySummaryAlgorithmEnum
GetKeySummaryAlgorithmEnumValues Enumerates the set of values for KeySummaryAlgorithmEnum
type KeySummaryLifecycleStateEnum ¶
type KeySummaryLifecycleStateEnum string
KeySummaryLifecycleStateEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for KeySummaryLifecycleStateEnum
func GetKeySummaryLifecycleStateEnumValues ¶
func GetKeySummaryLifecycleStateEnumValues() []KeySummaryLifecycleStateEnum
GetKeySummaryLifecycleStateEnumValues Enumerates the set of values for KeySummaryLifecycleStateEnum
type KeySummaryProtectionModeEnum ¶
type KeySummaryProtectionModeEnum string
KeySummaryProtectionModeEnum Enum with underlying type: string
const ( KeySummaryProtectionModeHsm KeySummaryProtectionModeEnum = "HSM" KeySummaryProtectionModeSoftware KeySummaryProtectionModeEnum = "SOFTWARE" )
Set of constants representing the allowable values for KeySummaryProtectionModeEnum
func GetKeySummaryProtectionModeEnumValues ¶
func GetKeySummaryProtectionModeEnumValues() []KeySummaryProtectionModeEnum
GetKeySummaryProtectionModeEnumValues Enumerates the set of values for KeySummaryProtectionModeEnum
type 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"` }
KeyVersion The representation of KeyVersion
func (KeyVersion) String ¶
func (m KeyVersion) String() string
type KeyVersionLifecycleStateEnum ¶
type KeyVersionLifecycleStateEnum string
KeyVersionLifecycleStateEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for KeyVersionLifecycleStateEnum
func GetKeyVersionLifecycleStateEnumValues ¶
func GetKeyVersionLifecycleStateEnumValues() []KeyVersionLifecycleStateEnum
GetKeyVersionLifecycleStateEnumValues Enumerates the set of values for KeyVersionLifecycleStateEnum
type KeyVersionOriginEnum ¶
type KeyVersionOriginEnum string
KeyVersionOriginEnum Enum with underlying type: string
const ( KeyVersionOriginInternal KeyVersionOriginEnum = "INTERNAL" KeyVersionOriginExternal KeyVersionOriginEnum = "EXTERNAL" )
Set of constants representing the allowable values for KeyVersionOriginEnum
func GetKeyVersionOriginEnumValues ¶
func GetKeyVersionOriginEnumValues() []KeyVersionOriginEnum
GetKeyVersionOriginEnumValues Enumerates the set of values for KeyVersionOriginEnum
type 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"` }
KeyVersionSummary The representation of KeyVersionSummary
func (KeyVersionSummary) String ¶
func (m KeyVersionSummary) String() string
type KeyVersionSummaryLifecycleStateEnum ¶
type KeyVersionSummaryLifecycleStateEnum string
KeyVersionSummaryLifecycleStateEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for KeyVersionSummaryLifecycleStateEnum
func GetKeyVersionSummaryLifecycleStateEnumValues ¶
func GetKeyVersionSummaryLifecycleStateEnumValues() []KeyVersionSummaryLifecycleStateEnum
GetKeyVersionSummaryLifecycleStateEnumValues Enumerates the set of values for KeyVersionSummaryLifecycleStateEnum
type KeyVersionSummaryOriginEnum ¶
type KeyVersionSummaryOriginEnum string
KeyVersionSummaryOriginEnum Enum with underlying type: string
const ( KeyVersionSummaryOriginInternal KeyVersionSummaryOriginEnum = "INTERNAL" KeyVersionSummaryOriginExternal KeyVersionSummaryOriginEnum = "EXTERNAL" )
Set of constants representing the allowable values for KeyVersionSummaryOriginEnum
func GetKeyVersionSummaryOriginEnumValues ¶
func GetKeyVersionSummaryOriginEnumValues() []KeyVersionSummaryOriginEnum
GetKeyVersionSummaryOriginEnumValues Enumerates the set of values for KeyVersionSummaryOriginEnum
type KmsCryptoClient ¶
type KmsCryptoClient struct { common.BaseClient // contains filtered or unexported fields }
KmsCryptoClient a client for KmsCrypto
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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/keymanagement/Verify.go.html to see an example of how to use Verify API.
type KmsManagementClient ¶
type KmsManagementClient struct { common.BaseClient // contains filtered or unexported fields }
KmsManagementClient a client for KmsManagement
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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/keymanagement/UpdateKey.go.html to see an example of how to use UpdateKey API.
type KmsVaultClient ¶
type KmsVaultClient struct { common.BaseClient // contains filtered or unexported fields }
KmsVaultClient a client for KmsVault
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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/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/latest/keymanagement/UpdateVault.go.html to see an example of how to use UpdateVault API.
type 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 }
ListKeyVersionsRequest wrapper for the ListKeyVersions operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListKeyVersions.go.html to see an example of how to use ListKeyVersionsRequest.
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 ¶
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"` }
ListKeyVersionsResponse wrapper for the ListKeyVersions operation
func (ListKeyVersionsResponse) HTTPResponse ¶
func (response ListKeyVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListKeyVersionsResponse) String ¶
func (response ListKeyVersionsResponse) String() string
type ListKeyVersionsSortByEnum ¶
type ListKeyVersionsSortByEnum string
ListKeyVersionsSortByEnum Enum with underlying type: string
const ( ListKeyVersionsSortByTimecreated ListKeyVersionsSortByEnum = "TIMECREATED" ListKeyVersionsSortByDisplayname ListKeyVersionsSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListKeyVersionsSortByEnum
func GetListKeyVersionsSortByEnumValues ¶
func GetListKeyVersionsSortByEnumValues() []ListKeyVersionsSortByEnum
GetListKeyVersionsSortByEnumValues Enumerates the set of values for ListKeyVersionsSortByEnum
type ListKeyVersionsSortOrderEnum ¶
type ListKeyVersionsSortOrderEnum string
ListKeyVersionsSortOrderEnum Enum with underlying type: string
const ( ListKeyVersionsSortOrderAsc ListKeyVersionsSortOrderEnum = "ASC" ListKeyVersionsSortOrderDesc ListKeyVersionsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListKeyVersionsSortOrderEnum
func GetListKeyVersionsSortOrderEnumValues ¶
func GetListKeyVersionsSortOrderEnumValues() []ListKeyVersionsSortOrderEnum
GetListKeyVersionsSortOrderEnumValues Enumerates the set of values for ListKeyVersionsSortOrderEnum
type ListKeysAlgorithmEnum ¶
type ListKeysAlgorithmEnum string
ListKeysAlgorithmEnum Enum with underlying type: string
const ( ListKeysAlgorithmAes ListKeysAlgorithmEnum = "AES" ListKeysAlgorithmRsa ListKeysAlgorithmEnum = "RSA" ListKeysAlgorithmEcdsa ListKeysAlgorithmEnum = "ECDSA" )
Set of constants representing the allowable values for ListKeysAlgorithmEnum
func GetListKeysAlgorithmEnumValues ¶
func GetListKeysAlgorithmEnumValues() []ListKeysAlgorithmEnum
GetListKeysAlgorithmEnumValues Enumerates the set of values for ListKeysAlgorithmEnum
type ListKeysCurveIdEnum ¶
type ListKeysCurveIdEnum string
ListKeysCurveIdEnum Enum with underlying type: string
const ( ListKeysCurveIdP256 ListKeysCurveIdEnum = "NIST_P256" ListKeysCurveIdP384 ListKeysCurveIdEnum = "NIST_P384" ListKeysCurveIdP521 ListKeysCurveIdEnum = "NIST_P521" )
Set of constants representing the allowable values for ListKeysCurveIdEnum
func GetListKeysCurveIdEnumValues ¶
func GetListKeysCurveIdEnumValues() []ListKeysCurveIdEnum
GetListKeysCurveIdEnumValues Enumerates the set of values for ListKeysCurveIdEnum
type ListKeysProtectionModeEnum ¶
type ListKeysProtectionModeEnum string
ListKeysProtectionModeEnum Enum with underlying type: string
const ( ListKeysProtectionModeHsm ListKeysProtectionModeEnum = "HSM" ListKeysProtectionModeSoftware ListKeysProtectionModeEnum = "SOFTWARE" )
Set of constants representing the allowable values for ListKeysProtectionModeEnum
func GetListKeysProtectionModeEnumValues ¶
func GetListKeysProtectionModeEnumValues() []ListKeysProtectionModeEnum
GetListKeysProtectionModeEnumValues Enumerates the set of values for ListKeysProtectionModeEnum
type 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 }
ListKeysRequest wrapper for the ListKeys operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListKeys.go.html to see an example of how to use ListKeysRequest.
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 ¶
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"` }
ListKeysResponse wrapper for the ListKeys operation
func (ListKeysResponse) HTTPResponse ¶
func (response ListKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListKeysResponse) String ¶
func (response ListKeysResponse) String() string
type ListKeysSortByEnum ¶
type ListKeysSortByEnum string
ListKeysSortByEnum Enum with underlying type: string
const ( ListKeysSortByTimecreated ListKeysSortByEnum = "TIMECREATED" ListKeysSortByDisplayname ListKeysSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListKeysSortByEnum
func GetListKeysSortByEnumValues ¶
func GetListKeysSortByEnumValues() []ListKeysSortByEnum
GetListKeysSortByEnumValues Enumerates the set of values for ListKeysSortByEnum
type ListKeysSortOrderEnum ¶
type ListKeysSortOrderEnum string
ListKeysSortOrderEnum Enum with underlying type: string
const ( ListKeysSortOrderAsc ListKeysSortOrderEnum = "ASC" ListKeysSortOrderDesc ListKeysSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListKeysSortOrderEnum
func GetListKeysSortOrderEnumValues ¶
func GetListKeysSortOrderEnumValues() []ListKeysSortOrderEnum
GetListKeysSortOrderEnumValues Enumerates the set of values for ListKeysSortOrderEnum
type 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 }
ListVaultsRequest wrapper for the ListVaults operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListVaults.go.html to see an example of how to use ListVaultsRequest.
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 ¶
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"` }
ListVaultsResponse wrapper for the ListVaults operation
func (ListVaultsResponse) HTTPResponse ¶
func (response ListVaultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListVaultsResponse) String ¶
func (response ListVaultsResponse) String() string
type ListVaultsSortByEnum ¶
type ListVaultsSortByEnum string
ListVaultsSortByEnum Enum with underlying type: string
const ( ListVaultsSortByTimecreated ListVaultsSortByEnum = "TIMECREATED" ListVaultsSortByDisplayname ListVaultsSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListVaultsSortByEnum
func GetListVaultsSortByEnumValues ¶
func GetListVaultsSortByEnumValues() []ListVaultsSortByEnum
GetListVaultsSortByEnumValues Enumerates the set of values for ListVaultsSortByEnum
type ListVaultsSortOrderEnum ¶
type ListVaultsSortOrderEnum string
ListVaultsSortOrderEnum Enum with underlying type: string
const ( ListVaultsSortOrderAsc ListVaultsSortOrderEnum = "ASC" ListVaultsSortOrderDesc ListVaultsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListVaultsSortOrderEnum
func GetListVaultsSortOrderEnumValues ¶
func GetListVaultsSortOrderEnumValues() []ListVaultsSortOrderEnum
GetListVaultsSortOrderEnumValues Enumerates the set of values for ListVaultsSortOrderEnum
type 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 }
RestoreKeyFromFileRequest wrapper for the RestoreKeyFromFile operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/RestoreKeyFromFile.go.html to see an example of how to use RestoreKeyFromFileRequest.
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 ¶
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"` }
RestoreKeyFromFileResponse wrapper for the RestoreKeyFromFile operation
func (RestoreKeyFromFileResponse) HTTPResponse ¶
func (response RestoreKeyFromFileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (RestoreKeyFromFileResponse) String ¶
func (response RestoreKeyFromFileResponse) String() string
type RestoreKeyFromObjectStoreDetails ¶
type RestoreKeyFromObjectStoreDetails struct {
BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
}
RestoreKeyFromObjectStoreDetails The representation of RestoreKeyFromObjectStoreDetails
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 ¶
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 }
RestoreKeyFromObjectStoreRequest wrapper for the RestoreKeyFromObjectStore operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/RestoreKeyFromObjectStore.go.html to see an example of how to use RestoreKeyFromObjectStoreRequest.
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 ¶
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"` }
RestoreKeyFromObjectStoreResponse wrapper for the RestoreKeyFromObjectStore operation
func (RestoreKeyFromObjectStoreResponse) HTTPResponse ¶
func (response RestoreKeyFromObjectStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (RestoreKeyFromObjectStoreResponse) String ¶
func (response RestoreKeyFromObjectStoreResponse) String() string
type 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 }
RestoreVaultFromFileRequest wrapper for the RestoreVaultFromFile operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/RestoreVaultFromFile.go.html to see an example of how to use RestoreVaultFromFileRequest.
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 ¶
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"` }
RestoreVaultFromFileResponse wrapper for the RestoreVaultFromFile operation
func (RestoreVaultFromFileResponse) HTTPResponse ¶
func (response RestoreVaultFromFileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (RestoreVaultFromFileResponse) String ¶
func (response RestoreVaultFromFileResponse) String() string
type RestoreVaultFromObjectStoreDetails ¶
type RestoreVaultFromObjectStoreDetails struct {
BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
}
RestoreVaultFromObjectStoreDetails The representation of RestoreVaultFromObjectStoreDetails
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 ¶
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 }
RestoreVaultFromObjectStoreRequest wrapper for the RestoreVaultFromObjectStore operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/RestoreVaultFromObjectStore.go.html to see an example of how to use RestoreVaultFromObjectStoreRequest.
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 ¶
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"` }
RestoreVaultFromObjectStoreResponse wrapper for the RestoreVaultFromObjectStore operation
func (RestoreVaultFromObjectStoreResponse) HTTPResponse ¶
func (response RestoreVaultFromObjectStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (RestoreVaultFromObjectStoreResponse) String ¶
func (response RestoreVaultFromObjectStoreResponse) String() string
type ScheduleKeyDeletionDetails ¶
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"` }
ScheduleKeyDeletionDetails Details for scheduling key deletion.
func (ScheduleKeyDeletionDetails) String ¶
func (m ScheduleKeyDeletionDetails) String() string
type 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 }
ScheduleKeyDeletionRequest wrapper for the ScheduleKeyDeletion operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ScheduleKeyDeletion.go.html to see an example of how to use ScheduleKeyDeletionRequest.
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 ¶
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"` }
ScheduleKeyDeletionResponse wrapper for the ScheduleKeyDeletion operation
func (ScheduleKeyDeletionResponse) HTTPResponse ¶
func (response ScheduleKeyDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ScheduleKeyDeletionResponse) String ¶
func (response ScheduleKeyDeletionResponse) String() string
type ScheduleKeyVersionDeletionDetails ¶
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"` }
ScheduleKeyVersionDeletionDetails Details for scheduling key version deletion.
func (ScheduleKeyVersionDeletionDetails) String ¶
func (m ScheduleKeyVersionDeletionDetails) String() string
type 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 }
ScheduleKeyVersionDeletionRequest wrapper for the ScheduleKeyVersionDeletion operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ScheduleKeyVersionDeletion.go.html to see an example of how to use ScheduleKeyVersionDeletionRequest.
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 ¶
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"` }
ScheduleKeyVersionDeletionResponse wrapper for the ScheduleKeyVersionDeletion operation
func (ScheduleKeyVersionDeletionResponse) HTTPResponse ¶
func (response ScheduleKeyVersionDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ScheduleKeyVersionDeletionResponse) String ¶
func (response ScheduleKeyVersionDeletionResponse) String() string
type ScheduleVaultDeletionDetails ¶
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"` }
ScheduleVaultDeletionDetails Details for scheduling vault deletion.
func (ScheduleVaultDeletionDetails) String ¶
func (m ScheduleVaultDeletionDetails) String() string
type 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 }
ScheduleVaultDeletionRequest wrapper for the ScheduleVaultDeletion operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ScheduleVaultDeletion.go.html to see an example of how to use ScheduleVaultDeletionRequest.
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 ¶
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"` }
ScheduleVaultDeletionResponse wrapper for the ScheduleVaultDeletion operation
func (ScheduleVaultDeletionResponse) HTTPResponse ¶
func (response ScheduleVaultDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ScheduleVaultDeletionResponse) String ¶
func (response ScheduleVaultDeletionResponse) String() string
type 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"` }
SignDataDetails The representation of SignDataDetails
func (SignDataDetails) String ¶
func (m SignDataDetails) String() string
type SignDataDetailsMessageTypeEnum ¶
type SignDataDetailsMessageTypeEnum string
SignDataDetailsMessageTypeEnum Enum with underlying type: string
const ( SignDataDetailsMessageTypeRaw SignDataDetailsMessageTypeEnum = "RAW" SignDataDetailsMessageTypeDigest SignDataDetailsMessageTypeEnum = "DIGEST" )
Set of constants representing the allowable values for SignDataDetailsMessageTypeEnum
func GetSignDataDetailsMessageTypeEnumValues ¶
func GetSignDataDetailsMessageTypeEnumValues() []SignDataDetailsMessageTypeEnum
GetSignDataDetailsMessageTypeEnumValues Enumerates the set of values for SignDataDetailsMessageTypeEnum
type SignDataDetailsSigningAlgorithmEnum ¶
type SignDataDetailsSigningAlgorithmEnum string
SignDataDetailsSigningAlgorithmEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for SignDataDetailsSigningAlgorithmEnum
func GetSignDataDetailsSigningAlgorithmEnumValues ¶
func GetSignDataDetailsSigningAlgorithmEnumValues() []SignDataDetailsSigningAlgorithmEnum
GetSignDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for SignDataDetailsSigningAlgorithmEnum
type 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 }
SignRequest wrapper for the Sign operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/Sign.go.html to see an example of how to use SignRequest.
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 ¶
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"` }
SignResponse wrapper for the Sign operation
func (SignResponse) HTTPResponse ¶
func (response SignResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (SignResponse) String ¶
func (response SignResponse) String() string
type 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"` }
SignedData The representation of SignedData
func (SignedData) String ¶
func (m SignedData) String() string
type SignedDataSigningAlgorithmEnum ¶
type SignedDataSigningAlgorithmEnum string
SignedDataSigningAlgorithmEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for SignedDataSigningAlgorithmEnum
func GetSignedDataSigningAlgorithmEnumValues ¶
func GetSignedDataSigningAlgorithmEnumValues() []SignedDataSigningAlgorithmEnum
GetSignedDataSigningAlgorithmEnumValues Enumerates the set of values for SignedDataSigningAlgorithmEnum
type 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"` }
UpdateKeyDetails The representation of UpdateKeyDetails
func (UpdateKeyDetails) String ¶
func (m UpdateKeyDetails) String() string
type 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 }
UpdateKeyRequest wrapper for the UpdateKey operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateKey.go.html to see an example of how to use UpdateKeyRequest.
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 ¶
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"` }
UpdateKeyResponse wrapper for the UpdateKey operation
func (UpdateKeyResponse) HTTPResponse ¶
func (response UpdateKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdateKeyResponse) String ¶
func (response UpdateKeyResponse) String() string
type 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"` }
UpdateVaultDetails The representation of UpdateVaultDetails
func (UpdateVaultDetails) String ¶
func (m UpdateVaultDetails) String() string
type 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 }
UpdateVaultRequest wrapper for the UpdateVault operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateVault.go.html to see an example of how to use UpdateVaultRequest.
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 ¶
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"` }
UpdateVaultResponse wrapper for the UpdateVault operation
func (UpdateVaultResponse) HTTPResponse ¶
func (response UpdateVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdateVaultResponse) String ¶
func (response UpdateVaultResponse) String() string
type 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"` }
Vault The representation of Vault
type VaultLifecycleStateEnum ¶
type VaultLifecycleStateEnum string
VaultLifecycleStateEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for VaultLifecycleStateEnum
func GetVaultLifecycleStateEnumValues ¶
func GetVaultLifecycleStateEnumValues() []VaultLifecycleStateEnum
GetVaultLifecycleStateEnumValues Enumerates the set of values for VaultLifecycleStateEnum
type 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"` }
VaultSummary The representation of VaultSummary
func (VaultSummary) String ¶
func (m VaultSummary) String() string
type VaultSummaryLifecycleStateEnum ¶
type VaultSummaryLifecycleStateEnum string
VaultSummaryLifecycleStateEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for VaultSummaryLifecycleStateEnum
func GetVaultSummaryLifecycleStateEnumValues ¶
func GetVaultSummaryLifecycleStateEnumValues() []VaultSummaryLifecycleStateEnum
GetVaultSummaryLifecycleStateEnumValues Enumerates the set of values for VaultSummaryLifecycleStateEnum
type VaultSummaryVaultTypeEnum ¶
type VaultSummaryVaultTypeEnum string
VaultSummaryVaultTypeEnum Enum with underlying type: string
const ( VaultSummaryVaultTypeVirtualPrivate VaultSummaryVaultTypeEnum = "VIRTUAL_PRIVATE" VaultSummaryVaultTypeDefault VaultSummaryVaultTypeEnum = "DEFAULT" )
Set of constants representing the allowable values for VaultSummaryVaultTypeEnum
func GetVaultSummaryVaultTypeEnumValues ¶
func GetVaultSummaryVaultTypeEnumValues() []VaultSummaryVaultTypeEnum
GetVaultSummaryVaultTypeEnumValues Enumerates the set of values for VaultSummaryVaultTypeEnum
type 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"` }
VaultUsage The representation of VaultUsage
func (VaultUsage) String ¶
func (m VaultUsage) String() string
type VaultVaultTypeEnum ¶
type VaultVaultTypeEnum string
VaultVaultTypeEnum Enum with underlying type: string
const ( VaultVaultTypeVirtualPrivate VaultVaultTypeEnum = "VIRTUAL_PRIVATE" VaultVaultTypeDefault VaultVaultTypeEnum = "DEFAULT" )
Set of constants representing the allowable values for VaultVaultTypeEnum
func GetVaultVaultTypeEnumValues ¶
func GetVaultVaultTypeEnumValues() []VaultVaultTypeEnum
GetVaultVaultTypeEnumValues Enumerates the set of values for VaultVaultTypeEnum
type VerifiedData ¶
type VerifiedData struct { // A Boolean value that indicates whether the signature was verified. IsSignatureValid *bool `mandatory:"true" json:"isSignatureValid"` }
VerifiedData The representation of VerifiedData
func (VerifiedData) String ¶
func (m VerifiedData) String() string
type 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"` }
VerifyDataDetails The representation of VerifyDataDetails
func (VerifyDataDetails) String ¶
func (m VerifyDataDetails) String() string
type VerifyDataDetailsMessageTypeEnum ¶
type VerifyDataDetailsMessageTypeEnum string
VerifyDataDetailsMessageTypeEnum Enum with underlying type: string
const ( VerifyDataDetailsMessageTypeRaw VerifyDataDetailsMessageTypeEnum = "RAW" VerifyDataDetailsMessageTypeDigest VerifyDataDetailsMessageTypeEnum = "DIGEST" )
Set of constants representing the allowable values for VerifyDataDetailsMessageTypeEnum
func GetVerifyDataDetailsMessageTypeEnumValues ¶
func GetVerifyDataDetailsMessageTypeEnumValues() []VerifyDataDetailsMessageTypeEnum
GetVerifyDataDetailsMessageTypeEnumValues Enumerates the set of values for VerifyDataDetailsMessageTypeEnum
type VerifyDataDetailsSigningAlgorithmEnum ¶
type VerifyDataDetailsSigningAlgorithmEnum string
VerifyDataDetailsSigningAlgorithmEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for VerifyDataDetailsSigningAlgorithmEnum
func GetVerifyDataDetailsSigningAlgorithmEnumValues ¶
func GetVerifyDataDetailsSigningAlgorithmEnumValues() []VerifyDataDetailsSigningAlgorithmEnum
GetVerifyDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for VerifyDataDetailsSigningAlgorithmEnum
type 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 }
VerifyRequest wrapper for the Verify operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/Verify.go.html to see an example of how to use VerifyRequest.
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 ¶
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"` }
VerifyResponse wrapper for the Verify operation
func (VerifyResponse) HTTPResponse ¶
func (response VerifyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (VerifyResponse) String ¶
func (response VerifyResponse) String() string
type 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"` }
WrappedImportKey The representation of WrappedImportKey
func (WrappedImportKey) String ¶
func (m WrappedImportKey) String() string
type WrappedImportKeyWrappingAlgorithmEnum ¶
type WrappedImportKeyWrappingAlgorithmEnum string
WrappedImportKeyWrappingAlgorithmEnum Enum with underlying type: string
const ( WrappedImportKeyWrappingAlgorithmSha256 WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_SHA256" WrappedImportKeyWrappingAlgorithmAesSha256 WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_AES_SHA256" )
Set of constants representing the allowable values for WrappedImportKeyWrappingAlgorithmEnum
func GetWrappedImportKeyWrappingAlgorithmEnumValues ¶
func GetWrappedImportKeyWrappingAlgorithmEnumValues() []WrappedImportKeyWrappingAlgorithmEnum
GetWrappedImportKeyWrappingAlgorithmEnumValues Enumerates the set of values for WrappedImportKeyWrappingAlgorithmEnum
type 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"` }
WrappingKey The representation of WrappingKey
func (WrappingKey) String ¶
func (m WrappingKey) String() string
type WrappingKeyLifecycleStateEnum ¶
type WrappingKeyLifecycleStateEnum string
WrappingKeyLifecycleStateEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for WrappingKeyLifecycleStateEnum
func GetWrappingKeyLifecycleStateEnumValues ¶
func GetWrappingKeyLifecycleStateEnumValues() []WrappingKeyLifecycleStateEnum
GetWrappingKeyLifecycleStateEnumValues Enumerates the set of values for WrappingKeyLifecycleStateEnum
Source 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