func GetAutoKeyRotationDetailsLastRotationStatusEnumStringValues() []string
GetAutoKeyRotationDetailsLastRotationStatusEnumStringValues Enumerates the set of values in String for AutoKeyRotationDetailsLastRotationStatusEnum
func GetBackupLocationDestinationEnumStringValues() []string
GetBackupLocationDestinationEnumStringValues Enumerates the set of values in String for BackupLocationDestinationEnum
func GetCreateKeyDetailsProtectionModeEnumStringValues() []string
GetCreateKeyDetailsProtectionModeEnumStringValues Enumerates the set of values in String for CreateKeyDetailsProtectionModeEnum
func GetCreateVaultDetailsVaultTypeEnumStringValues() []string
GetCreateVaultDetailsVaultTypeEnumStringValues Enumerates the set of values in String for CreateVaultDetailsVaultTypeEnum
func GetDecryptDataDetailsEncryptionAlgorithmEnumStringValues() []string
GetDecryptDataDetailsEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for DecryptDataDetailsEncryptionAlgorithmEnum
func GetDecryptedDataEncryptionAlgorithmEnumStringValues() []string
GetDecryptedDataEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for DecryptedDataEncryptionAlgorithmEnum
func GetEkmsPrivateEndpointLifecycleStateEnumStringValues() []string
GetEkmsPrivateEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for EkmsPrivateEndpointLifecycleStateEnum
func GetEkmsPrivateEndpointSummaryLifecycleStateEnumStringValues() []string
GetEkmsPrivateEndpointSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for EkmsPrivateEndpointSummaryLifecycleStateEnum
func GetEncryptDataDetailsEncryptionAlgorithmEnumStringValues() []string
GetEncryptDataDetailsEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for EncryptDataDetailsEncryptionAlgorithmEnum
func GetEncryptedDataEncryptionAlgorithmEnumStringValues() []string
GetEncryptedDataEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for EncryptedDataEncryptionAlgorithmEnum
func GetExportKeyDetailsAlgorithmEnumStringValues() []string
GetExportKeyDetailsAlgorithmEnumStringValues Enumerates the set of values in String for ExportKeyDetailsAlgorithmEnum
func GetExportedKeyDataAlgorithmEnumStringValues() []string
GetExportedKeyDataAlgorithmEnumStringValues Enumerates the set of values in String for ExportedKeyDataAlgorithmEnum
func GetHsmClusterLifecycleStateEnumStringValues() []string
GetHsmClusterLifecycleStateEnumStringValues Enumerates the set of values in String for HsmClusterLifecycleStateEnum
func GetHsmPartitionLifecycleStateEnumStringValues() []string
GetHsmPartitionLifecycleStateEnumStringValues Enumerates the set of values in String for HsmPartitionLifecycleStateEnum
func GetImportKeyDetailsProtectionModeEnumStringValues() []string
GetImportKeyDetailsProtectionModeEnumStringValues Enumerates the set of values in String for ImportKeyDetailsProtectionModeEnum
func GetKeyLifecycleStateEnumStringValues() []string
GetKeyLifecycleStateEnumStringValues Enumerates the set of values in String for KeyLifecycleStateEnum
func GetKeyProtectionModeEnumStringValues() []string
GetKeyProtectionModeEnumStringValues Enumerates the set of values in String for KeyProtectionModeEnum
func GetKeyShapeAlgorithmEnumStringValues() []string
GetKeyShapeAlgorithmEnumStringValues Enumerates the set of values in String for KeyShapeAlgorithmEnum
func GetKeyShapeCurveIdEnumStringValues() []string
GetKeyShapeCurveIdEnumStringValues Enumerates the set of values in String for KeyShapeCurveIdEnum
func GetKeySummaryAlgorithmEnumStringValues() []string
GetKeySummaryAlgorithmEnumStringValues Enumerates the set of values in String for KeySummaryAlgorithmEnum
func GetKeySummaryLifecycleStateEnumStringValues() []string
GetKeySummaryLifecycleStateEnumStringValues Enumerates the set of values in String for KeySummaryLifecycleStateEnum
func GetKeySummaryProtectionModeEnumStringValues() []string
GetKeySummaryProtectionModeEnumStringValues Enumerates the set of values in String for KeySummaryProtectionModeEnum
func GetKeyVersionLifecycleStateEnumStringValues() []string
GetKeyVersionLifecycleStateEnumStringValues Enumerates the set of values in String for KeyVersionLifecycleStateEnum
func GetKeyVersionOriginEnumStringValues() []string
GetKeyVersionOriginEnumStringValues Enumerates the set of values in String for KeyVersionOriginEnum
func GetKeyVersionSummaryLifecycleStateEnumStringValues() []string
GetKeyVersionSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for KeyVersionSummaryLifecycleStateEnum
func GetKeyVersionSummaryOriginEnumStringValues() []string
GetKeyVersionSummaryOriginEnumStringValues Enumerates the set of values in String for KeyVersionSummaryOriginEnum
func GetListEkmsPrivateEndpointsSortByEnumStringValues() []string
GetListEkmsPrivateEndpointsSortByEnumStringValues Enumerates the set of values in String for ListEkmsPrivateEndpointsSortByEnum
func GetListEkmsPrivateEndpointsSortOrderEnumStringValues() []string
GetListEkmsPrivateEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListEkmsPrivateEndpointsSortOrderEnum
func GetListHsmClustersSortByEnumStringValues() []string
GetListHsmClustersSortByEnumStringValues Enumerates the set of values in String for ListHsmClustersSortByEnum
func GetListHsmClustersSortOrderEnumStringValues() []string
GetListHsmClustersSortOrderEnumStringValues Enumerates the set of values in String for ListHsmClustersSortOrderEnum
func GetListHsmPartitionsSortByEnumStringValues() []string
GetListHsmPartitionsSortByEnumStringValues Enumerates the set of values in String for ListHsmPartitionsSortByEnum
func GetListHsmPartitionsSortOrderEnumStringValues() []string
GetListHsmPartitionsSortOrderEnumStringValues Enumerates the set of values in String for ListHsmPartitionsSortOrderEnum
func GetListKeyVersionsSortByEnumStringValues() []string
GetListKeyVersionsSortByEnumStringValues Enumerates the set of values in String for ListKeyVersionsSortByEnum
func GetListKeyVersionsSortOrderEnumStringValues() []string
GetListKeyVersionsSortOrderEnumStringValues Enumerates the set of values in String for ListKeyVersionsSortOrderEnum
func GetListKeysAlgorithmEnumStringValues() []string
GetListKeysAlgorithmEnumStringValues Enumerates the set of values in String for ListKeysAlgorithmEnum
func GetListKeysCurveIdEnumStringValues() []string
GetListKeysCurveIdEnumStringValues Enumerates the set of values in String for ListKeysCurveIdEnum
func GetListKeysProtectionModeEnumStringValues() []string
GetListKeysProtectionModeEnumStringValues Enumerates the set of values in String for ListKeysProtectionModeEnum
func GetListKeysSortByEnumStringValues() []string
GetListKeysSortByEnumStringValues Enumerates the set of values in String for ListKeysSortByEnum
func GetListKeysSortOrderEnumStringValues() []string
GetListKeysSortOrderEnumStringValues Enumerates the set of values in String for ListKeysSortOrderEnum
func GetListVaultReplicasSortByEnumStringValues() []string
GetListVaultReplicasSortByEnumStringValues Enumerates the set of values in String for ListVaultReplicasSortByEnum
func GetListVaultReplicasSortOrderEnumStringValues() []string
GetListVaultReplicasSortOrderEnumStringValues Enumerates the set of values in String for ListVaultReplicasSortOrderEnum
func GetListVaultsSortByEnumStringValues() []string
GetListVaultsSortByEnumStringValues Enumerates the set of values in String for ListVaultsSortByEnum
func GetListVaultsSortOrderEnumStringValues() []string
GetListVaultsSortOrderEnumStringValues Enumerates the set of values in String for ListVaultsSortOrderEnum
func GetPortInformationPortTypeEnumStringValues() []string
GetPortInformationPortTypeEnumStringValues Enumerates the set of values in String for PortInformationPortTypeEnum
func GetReplicaDetailsStatusEnumStringValues() []string
GetReplicaDetailsStatusEnumStringValues Enumerates the set of values in String for ReplicaDetailsStatusEnum
func GetSignDataDetailsMessageTypeEnumStringValues() []string
GetSignDataDetailsMessageTypeEnumStringValues Enumerates the set of values in String for SignDataDetailsMessageTypeEnum
func GetSignDataDetailsSigningAlgorithmEnumStringValues() []string
GetSignDataDetailsSigningAlgorithmEnumStringValues Enumerates the set of values in String for SignDataDetailsSigningAlgorithmEnum
func GetSignedDataSigningAlgorithmEnumStringValues() []string
GetSignedDataSigningAlgorithmEnumStringValues Enumerates the set of values in String for SignedDataSigningAlgorithmEnum
func GetVaultLifecycleStateEnumStringValues() []string
GetVaultLifecycleStateEnumStringValues Enumerates the set of values in String for VaultLifecycleStateEnum
func GetVaultReplicaSummaryStatusEnumStringValues() []string
GetVaultReplicaSummaryStatusEnumStringValues Enumerates the set of values in String for VaultReplicaSummaryStatusEnum
func GetVaultSummaryLifecycleStateEnumStringValues() []string
GetVaultSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for VaultSummaryLifecycleStateEnum
func GetVaultSummaryVaultTypeEnumStringValues() []string
GetVaultSummaryVaultTypeEnumStringValues Enumerates the set of values in String for VaultSummaryVaultTypeEnum
func GetVaultVaultTypeEnumStringValues() []string
GetVaultVaultTypeEnumStringValues Enumerates the set of values in String for VaultVaultTypeEnum
func GetVerifyDataDetailsMessageTypeEnumStringValues() []string
GetVerifyDataDetailsMessageTypeEnumStringValues Enumerates the set of values in String for VerifyDataDetailsMessageTypeEnum
func GetVerifyDataDetailsSigningAlgorithmEnumStringValues() []string
GetVerifyDataDetailsSigningAlgorithmEnumStringValues Enumerates the set of values in String for VerifyDataDetailsSigningAlgorithmEnum
func GetWrappedImportKeyWrappingAlgorithmEnumStringValues() []string
GetWrappedImportKeyWrappingAlgorithmEnumStringValues Enumerates the set of values in String for WrappedImportKeyWrappingAlgorithmEnum
func GetWrappingKeyLifecycleStateEnumStringValues() []string
GetWrappingKeyLifecycleStateEnumStringValues Enumerates the set of values in String for WrappingKeyLifecycleStateEnum
AutoKeyRotationDetails The details of auto rotation schedule for the Key being create updated or imported.
type AutoKeyRotationDetails struct {
// The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule.
RotationIntervalInDays *int `mandatory:"false" json:"rotationIntervalInDays"`
// A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.
TimeOfScheduleStart *common.SDKTime `mandatory:"false" json:"timeOfScheduleStart"`
// A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z`. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z.
TimeOfNextRotation *common.SDKTime `mandatory:"false" json:"timeOfNextRotation"`
// A property indicating Last rotation Date. Example: `2023-04-04T00:00:00Z`.
TimeOfLastRotation *common.SDKTime `mandatory:"false" json:"timeOfLastRotation"`
// The status of last execution of auto key rotation.
LastRotationStatus AutoKeyRotationDetailsLastRotationStatusEnum `mandatory:"false" json:"lastRotationStatus,omitempty"`
// The last execution status message of auto key rotation.
LastRotationMessage *string `mandatory:"false" json:"lastRotationMessage"`
}
func (m AutoKeyRotationDetails) String() string
func (m AutoKeyRotationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AutoKeyRotationDetailsLastRotationStatusEnum Enum with underlying type: string
type AutoKeyRotationDetailsLastRotationStatusEnum string
Set of constants representing the allowable values for AutoKeyRotationDetailsLastRotationStatusEnum
const (
AutoKeyRotationDetailsLastRotationStatusSuccess AutoKeyRotationDetailsLastRotationStatusEnum = "SUCCESS"
AutoKeyRotationDetailsLastRotationStatusFailed AutoKeyRotationDetailsLastRotationStatusEnum = "FAILED"
AutoKeyRotationDetailsLastRotationStatusInProgress AutoKeyRotationDetailsLastRotationStatusEnum = "IN_PROGRESS"
)
func GetAutoKeyRotationDetailsLastRotationStatusEnumValues() []AutoKeyRotationDetailsLastRotationStatusEnum
GetAutoKeyRotationDetailsLastRotationStatusEnumValues Enumerates the set of values for AutoKeyRotationDetailsLastRotationStatusEnum
func GetMappingAutoKeyRotationDetailsLastRotationStatusEnum(val string) (AutoKeyRotationDetailsLastRotationStatusEnum, bool)
GetMappingAutoKeyRotationDetailsLastRotationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
BackupKeyDetails The details of the Key that you wish to backup.
type BackupKeyDetails struct {
BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
}
func (m BackupKeyDetails) String() string
func (m *BackupKeyDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m BackupKeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackupKeyRequest wrapper for the BackupKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/BackupKey.go.html to see an example of how to use BackupKeyRequest.
type BackupKeyRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// BackupKeyDetails
BackupKeyDetails `contributesTo:"body"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BackupKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BackupKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BackupKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BackupKeyRequest) String() string
func (request BackupKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackupKeyResponse wrapper for the BackupKey operation
type BackupKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the work request, used to track the progress of the
// backup operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response BackupKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BackupKeyResponse) String() string
BackupLocation Backup upload location
type BackupLocation interface {
}
BackupLocationBucket Object storage bucket details to upload or download the backup
type BackupLocationBucket struct {
Namespace *string `mandatory:"true" json:"namespace"`
BucketName *string `mandatory:"true" json:"bucketName"`
ObjectName *string `mandatory:"true" json:"objectName"`
}
func (m BackupLocationBucket) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BackupLocationBucket) String() string
func (m BackupLocationBucket) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackupLocationDestinationEnum Enum with underlying type: string
type BackupLocationDestinationEnum string
Set of constants representing the allowable values for BackupLocationDestinationEnum
const (
BackupLocationDestinationBucket BackupLocationDestinationEnum = "BUCKET"
BackupLocationDestinationPreAuthenticatedRequestUri BackupLocationDestinationEnum = "PRE_AUTHENTICATED_REQUEST_URI"
)
func GetBackupLocationDestinationEnumValues() []BackupLocationDestinationEnum
GetBackupLocationDestinationEnumValues Enumerates the set of values for BackupLocationDestinationEnum
func GetMappingBackupLocationDestinationEnum(val string) (BackupLocationDestinationEnum, bool)
GetMappingBackupLocationDestinationEnum performs case Insensitive comparison on enum value and return the desired enum
BackupLocationUri PreAuthenticated object storage URI to upload or download the backup
type BackupLocationUri struct {
Uri *string `mandatory:"true" json:"uri"`
}
func (m BackupLocationUri) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BackupLocationUri) String() string
func (m BackupLocationUri) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackupVaultDetails The details of the Vault that you wish to backup.
type BackupVaultDetails struct {
BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
// A Boolean value that indicates whether the Keys should be included during backing up the Vault.
IsIncludeKeys *bool `mandatory:"false" json:"isIncludeKeys"`
}
func (m BackupVaultDetails) String() string
func (m *BackupVaultDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m BackupVaultDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackupVaultRequest wrapper for the BackupVault operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/BackupVault.go.html to see an example of how to use BackupVaultRequest.
type BackupVaultRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// BackupVaultDetails
BackupVaultDetails `contributesTo:"body"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request BackupVaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BackupVaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BackupVaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BackupVaultRequest) String() string
func (request BackupVaultRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BackupVaultResponse wrapper for the BackupVault operation
type BackupVaultResponse struct {
// The underlying http response
RawResponse *http.Response
// The Vault instance
Vault `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the work request, used to track the progress of the
// backup operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response BackupVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BackupVaultResponse) String() string
CancelHsmClusterDeletionRequest wrapper for the CancelHsmClusterDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CancelHsmClusterDeletion.go.html to see an example of how to use CancelHsmClusterDeletionRequest.
type CancelHsmClusterDeletionRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelHsmClusterDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelHsmClusterDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelHsmClusterDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelHsmClusterDeletionRequest) String() string
func (request CancelHsmClusterDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelHsmClusterDeletionResponse wrapper for the CancelHsmClusterDeletion operation
type CancelHsmClusterDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// The HsmCluster instance
HsmCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelHsmClusterDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelHsmClusterDeletionResponse) String() string
CancelKeyDeletionRequest wrapper for the CancelKeyDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CancelKeyDeletion.go.html to see an example of how to use CancelKeyDeletionRequest.
type CancelKeyDeletionRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelKeyDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelKeyDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelKeyDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelKeyDeletionRequest) String() string
func (request CancelKeyDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelKeyDeletionResponse wrapper for the CancelKeyDeletion operation
type CancelKeyDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelKeyDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelKeyDeletionResponse) String() string
CancelKeyVersionDeletionRequest wrapper for the CancelKeyVersionDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CancelKeyVersionDeletion.go.html to see an example of how to use CancelKeyVersionDeletionRequest.
type CancelKeyVersionDeletionRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// The OCID of the key version.
KeyVersionId *string `mandatory:"true" contributesTo:"path" name:"keyVersionId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelKeyVersionDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelKeyVersionDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelKeyVersionDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelKeyVersionDeletionRequest) String() string
func (request CancelKeyVersionDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelKeyVersionDeletionResponse wrapper for the CancelKeyVersionDeletion operation
type CancelKeyVersionDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// The KeyVersion instance
KeyVersion `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelKeyVersionDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelKeyVersionDeletionResponse) String() string
CancelVaultDeletionRequest wrapper for the CancelVaultDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CancelVaultDeletion.go.html to see an example of how to use CancelVaultDeletionRequest.
type CancelVaultDeletionRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelVaultDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelVaultDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelVaultDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelVaultDeletionRequest) String() string
func (request CancelVaultDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelVaultDeletionResponse wrapper for the CancelVaultDeletion operation
type CancelVaultDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Vault instance
Vault `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelVaultDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelVaultDeletionResponse) String() string
ChangeHsmClusterCompartmentDetails The details of the compartment you wish to move the hsm cluster to.
type ChangeHsmClusterCompartmentDetails struct {
// The [OCID] of the compartment to move the hsm cluster to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeHsmClusterCompartmentDetails) String() string
func (m ChangeHsmClusterCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeHsmClusterCompartmentRequest wrapper for the ChangeHsmClusterCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ChangeHsmClusterCompartment.go.html to see an example of how to use ChangeHsmClusterCompartmentRequest.
type ChangeHsmClusterCompartmentRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// Details of change HSM Cluster compartment.
ChangeHsmClusterCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeHsmClusterCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeHsmClusterCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeHsmClusterCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeHsmClusterCompartmentRequest) String() string
func (request ChangeHsmClusterCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeHsmClusterCompartmentResponse wrapper for the ChangeHsmClusterCompartment operation
type ChangeHsmClusterCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeHsmClusterCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeHsmClusterCompartmentResponse) String() string
ChangeKeyCompartmentDetails The deatils of the compartment that you wish to move the Key.
type ChangeKeyCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that you want to move the key to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeKeyCompartmentDetails) String() string
func (m ChangeKeyCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeKeyCompartmentRequest wrapper for the ChangeKeyCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ChangeKeyCompartment.go.html to see an example of how to use ChangeKeyCompartmentRequest.
type ChangeKeyCompartmentRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// Details of change key compartment.
ChangeKeyCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeKeyCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeKeyCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeKeyCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeKeyCompartmentRequest) String() string
func (request ChangeKeyCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeKeyCompartmentResponse wrapper for the ChangeKeyCompartment operation
type ChangeKeyCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeKeyCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeKeyCompartmentResponse) String() string
ChangeVaultCompartmentDetails The details of the compartment you wish to move the Vault.
type ChangeVaultCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the vault to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeVaultCompartmentDetails) String() string
func (m ChangeVaultCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeVaultCompartmentRequest wrapper for the ChangeVaultCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ChangeVaultCompartment.go.html to see an example of how to use ChangeVaultCompartmentRequest.
type ChangeVaultCompartmentRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// ChangeVaultCompartmentDetails
ChangeVaultCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeVaultCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeVaultCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeVaultCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeVaultCompartmentRequest) String() string
func (request ChangeVaultCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeVaultCompartmentResponse wrapper for the ChangeVaultCompartment operation
type ChangeVaultCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeVaultCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeVaultCompartmentResponse) String() string
CreateEkmsPrivateEndpointDetails Information needed to create EKMS private endpoint resource
type CreateEkmsPrivateEndpointDetails struct {
// The OCID of subnet in which the EKMS private endpoint is to be created
SubnetId *string `mandatory:"true" json:"subnetId"`
// Compartment identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Display name of the EKMS private endpoint resource being created.
DisplayName *string `mandatory:"true" json:"displayName"`
// External private IP to connect to from this EKMS private endpoint
ExternalKeyManagerIp *string `mandatory:"true" json:"externalKeyManagerIp"`
// CABundle to validate TLS certificate of the external key manager system in PEM format
CaBundle *string `mandatory:"true" json:"caBundle"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The port of the external key manager system
Port *int `mandatory:"false" json:"port"`
}
func (m CreateEkmsPrivateEndpointDetails) String() string
func (m CreateEkmsPrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateEkmsPrivateEndpointRequest wrapper for the CreateEkmsPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateEkmsPrivateEndpoint.go.html to see an example of how to use CreateEkmsPrivateEndpointRequest.
type CreateEkmsPrivateEndpointRequest struct {
// The information used to create EKMS private endpoint.
CreateEkmsPrivateEndpointDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateEkmsPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateEkmsPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateEkmsPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateEkmsPrivateEndpointRequest) String() string
func (request CreateEkmsPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateEkmsPrivateEndpointResponse wrapper for the CreateEkmsPrivateEndpoint operation
type CreateEkmsPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The EkmsPrivateEndpoint instance
EkmsPrivateEndpoint `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"`
// Work request id to track progress of the create operation
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateEkmsPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateEkmsPrivateEndpointResponse) String() string
CreateHsmClusterDetails The details of the HSM cluster resource that you want to create.
type CreateHsmClusterDetails struct {
// The OCID of the compartment where you want to create this HSM cluster resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly display name for the HSM cluster resource. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m CreateHsmClusterDetails) String() string
func (m CreateHsmClusterDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateHsmClusterRequest wrapper for the CreateHsmCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateHsmCluster.go.html to see an example of how to use CreateHsmClusterRequest.
type CreateHsmClusterRequest struct {
// Details for the new HsmCluster resource
CreateHsmClusterDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateHsmClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateHsmClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateHsmClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateHsmClusterRequest) String() string
func (request CreateHsmClusterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateHsmClusterResponse wrapper for the CreateHsmCluster operation
type CreateHsmClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The HsmCluster instance
HsmCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateHsmClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateHsmClusterResponse) String() string
CreateKeyDetails The details of the key that you want to create.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// A parameter specifying whether the auto key rotation is enabled or not.
IsAutoRotationEnabled *bool `mandatory:"false" json:"isAutoRotationEnabled"`
AutoKeyRotationDetails *AutoKeyRotationDetails `mandatory:"false" json:"autoKeyRotationDetails"`
// 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.
// A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle.
// Oracle only hold a reference to that key.
// All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager.
ProtectionMode CreateKeyDetailsProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"`
ExternalKeyReference *ExternalKeyReference `mandatory:"false" json:"externalKeyReference"`
}
func (m CreateKeyDetails) String() string
func (m CreateKeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateKeyDetailsProtectionModeEnum Enum with underlying type: string
type CreateKeyDetailsProtectionModeEnum string
Set of constants representing the allowable values for CreateKeyDetailsProtectionModeEnum
const (
CreateKeyDetailsProtectionModeHsm CreateKeyDetailsProtectionModeEnum = "HSM"
CreateKeyDetailsProtectionModeSoftware CreateKeyDetailsProtectionModeEnum = "SOFTWARE"
CreateKeyDetailsProtectionModeExternal CreateKeyDetailsProtectionModeEnum = "EXTERNAL"
)
func GetCreateKeyDetailsProtectionModeEnumValues() []CreateKeyDetailsProtectionModeEnum
GetCreateKeyDetailsProtectionModeEnumValues Enumerates the set of values for CreateKeyDetailsProtectionModeEnum
func GetMappingCreateKeyDetailsProtectionModeEnum(val string) (CreateKeyDetailsProtectionModeEnum, bool)
GetMappingCreateKeyDetailsProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateKeyRequest wrapper for the CreateKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateKey.go.html to see an example of how to use CreateKeyRequest.
type CreateKeyRequest struct {
// CreateKeyDetails
CreateKeyDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateKeyRequest) String() string
func (request CreateKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateKeyResponse wrapper for the CreateKey operation
type CreateKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateKeyResponse) String() string
CreateKeyVersionRequest wrapper for the CreateKeyVersion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateKeyVersion.go.html to see an example of how to use CreateKeyVersionRequest.
type CreateKeyVersionRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// CreateKeyMetadataDetails
CreateKeyMetadataDetails ExternalKeyVersionReference `contributesTo:"body"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateKeyVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateKeyVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateKeyVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateKeyVersionRequest) String() string
func (request CreateKeyVersionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateKeyVersionResponse wrapper for the CreateKeyVersion operation
type CreateKeyVersionResponse struct {
// The underlying http response
RawResponse *http.Response
// The KeyVersion instance
KeyVersion `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateKeyVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateKeyVersionResponse) String() string
CreateVaultDetails The details of the vault that you want to create.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
ExternalKeyManagerMetadata *ExternalKeyManagerMetadata `mandatory:"false" json:"externalKeyManagerMetadata"`
}
func (m CreateVaultDetails) String() string
func (m CreateVaultDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateVaultDetailsVaultTypeEnum Enum with underlying type: string
type CreateVaultDetailsVaultTypeEnum string
Set of constants representing the allowable values for CreateVaultDetailsVaultTypeEnum
const (
CreateVaultDetailsVaultTypeVirtualPrivate CreateVaultDetailsVaultTypeEnum = "VIRTUAL_PRIVATE"
CreateVaultDetailsVaultTypeDefault CreateVaultDetailsVaultTypeEnum = "DEFAULT"
CreateVaultDetailsVaultTypeExternal CreateVaultDetailsVaultTypeEnum = "EXTERNAL"
)
func GetCreateVaultDetailsVaultTypeEnumValues() []CreateVaultDetailsVaultTypeEnum
GetCreateVaultDetailsVaultTypeEnumValues Enumerates the set of values for CreateVaultDetailsVaultTypeEnum
func GetMappingCreateVaultDetailsVaultTypeEnum(val string) (CreateVaultDetailsVaultTypeEnum, bool)
GetMappingCreateVaultDetailsVaultTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateVaultReplicaDetails Creates a vault replica.
type CreateVaultReplicaDetails struct {
// The region in the realm to which the vault need to be replicated to
ReplicaRegion *string `mandatory:"true" json:"replicaRegion"`
}
func (m CreateVaultReplicaDetails) String() string
func (m CreateVaultReplicaDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateVaultReplicaRequest wrapper for the CreateVaultReplica operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateVaultReplica.go.html to see an example of how to use CreateVaultReplicaRequest.
type CreateVaultReplicaRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// CreateVaultReplicaDetails
CreateVaultReplicaDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateVaultReplicaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateVaultReplicaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateVaultReplicaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateVaultReplicaRequest) String() string
func (request CreateVaultReplicaRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateVaultReplicaResponse wrapper for the CreateVaultReplica operation
type CreateVaultReplicaResponse struct {
// The underlying http response
RawResponse *http.Response
// 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
// create replica operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateVaultReplicaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateVaultReplicaResponse) String() string
CreateVaultRequest wrapper for the CreateVault operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateVault.go.html to see an example of how to use CreateVaultRequest.
type CreateVaultRequest struct {
// CreateVaultDetails
CreateVaultDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateVaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateVaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateVaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateVaultRequest) String() string
func (request CreateVaultRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateVaultResponse wrapper for the CreateVault operation
type CreateVaultResponse struct {
// The underlying http response
RawResponse *http.Response
// The Vault instance
Vault `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateVaultResponse) String() string
DecryptDataDetails The details of the encrypted data that you want to decrypt.
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 key version used to encrypt the ciphertext.
KeyVersionId *string `mandatory:"false" json:"keyVersionId"`
// The encryption algorithm to use to encrypt or decrypt data with a customer-managed key.
// `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
// that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the
// key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).
// `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
// and uses OAEP.
EncryptionAlgorithm DecryptDataDetailsEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
}
func (m DecryptDataDetails) String() string
func (m DecryptDataDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DecryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string
type DecryptDataDetailsEncryptionAlgorithmEnum string
Set of constants representing the allowable values for DecryptDataDetailsEncryptionAlgorithmEnum
const (
DecryptDataDetailsEncryptionAlgorithmAes256Gcm DecryptDataDetailsEncryptionAlgorithmEnum = "AES_256_GCM"
DecryptDataDetailsEncryptionAlgorithmRsaOaepSha1 DecryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1"
DecryptDataDetailsEncryptionAlgorithmRsaOaepSha256 DecryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256"
)
func GetDecryptDataDetailsEncryptionAlgorithmEnumValues() []DecryptDataDetailsEncryptionAlgorithmEnum
GetDecryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptDataDetailsEncryptionAlgorithmEnum
func GetMappingDecryptDataDetailsEncryptionAlgorithmEnum(val string) (DecryptDataDetailsEncryptionAlgorithmEnum, bool)
GetMappingDecryptDataDetailsEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
DecryptRequest wrapper for the Decrypt operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/Decrypt.go.html to see an example of how to use DecryptRequest.
type DecryptRequest struct {
// DecryptDataDetails
DecryptDataDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DecryptRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DecryptRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DecryptRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DecryptRequest) String() string
func (request DecryptRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DecryptResponse wrapper for the Decrypt operation
type DecryptResponse struct {
// The underlying http response
RawResponse *http.Response
// The DecryptedData instance
DecryptedData `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DecryptResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DecryptResponse) String() string
DecryptedData The response to a request to decrypt the encrypted data.
type DecryptedData struct {
// The decrypted data, expressed as a base64-encoded value.
Plaintext *string `mandatory:"true" json:"plaintext"`
// The 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 key version used to encrypt the ciphertext.
KeyVersionId *string `mandatory:"false" json:"keyVersionId"`
// The encryption algorithm to use to encrypt and decrypt data with a customer-managed key
// `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
// that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the
// key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).
// `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
// and uses OAEP.
EncryptionAlgorithm DecryptedDataEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
}
func (m DecryptedData) String() string
func (m DecryptedData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DecryptedDataEncryptionAlgorithmEnum Enum with underlying type: string
type DecryptedDataEncryptionAlgorithmEnum string
Set of constants representing the allowable values for DecryptedDataEncryptionAlgorithmEnum
const (
DecryptedDataEncryptionAlgorithmAes256Gcm DecryptedDataEncryptionAlgorithmEnum = "AES_256_GCM"
DecryptedDataEncryptionAlgorithmRsaOaepSha1 DecryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1"
DecryptedDataEncryptionAlgorithmRsaOaepSha256 DecryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256"
)
func GetDecryptedDataEncryptionAlgorithmEnumValues() []DecryptedDataEncryptionAlgorithmEnum
GetDecryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptedDataEncryptionAlgorithmEnum
func GetMappingDecryptedDataEncryptionAlgorithmEnum(val string) (DecryptedDataEncryptionAlgorithmEnum, bool)
GetMappingDecryptedDataEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteEkmsPrivateEndpointRequest wrapper for the DeleteEkmsPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/DeleteEkmsPrivateEndpoint.go.html to see an example of how to use DeleteEkmsPrivateEndpointRequest.
type DeleteEkmsPrivateEndpointRequest struct {
// Unique EKMS private endpoint identifier.
EkmsPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"ekmsPrivateEndpointId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteEkmsPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteEkmsPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteEkmsPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteEkmsPrivateEndpointRequest) String() string
func (request DeleteEkmsPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteEkmsPrivateEndpointResponse wrapper for the DeleteEkmsPrivateEndpoint operation
type DeleteEkmsPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the work request, used to track the progress of the
// operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteEkmsPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteEkmsPrivateEndpointResponse) String() string
DeleteVaultReplicaDetails Deletes a vault replica
type DeleteVaultReplicaDetails struct {
// The region in the realm on which the replica should be deleted
ReplicaRegion *string `mandatory:"true" json:"replicaRegion"`
}
func (m DeleteVaultReplicaDetails) String() string
func (m DeleteVaultReplicaDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteVaultReplicaRequest wrapper for the DeleteVaultReplica operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/DeleteVaultReplica.go.html to see an example of how to use DeleteVaultReplicaRequest.
type DeleteVaultReplicaRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// DeleteVaultReplicaDetails
DeleteVaultReplicaDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteVaultReplicaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteVaultReplicaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteVaultReplicaRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteVaultReplicaRequest) String() string
func (request DeleteVaultReplicaRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteVaultReplicaResponse wrapper for the DeleteVaultReplica operation
type DeleteVaultReplicaResponse struct {
// The underlying http response
RawResponse *http.Response
// 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
// delete replica operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteVaultReplicaResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteVaultReplicaResponse) String() string
DisableKeyRequest wrapper for the DisableKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/DisableKey.go.html to see an example of how to use DisableKeyRequest.
type DisableKeyRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DisableKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DisableKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DisableKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DisableKeyRequest) String() string
func (request DisableKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DisableKeyResponse wrapper for the DisableKey operation
type DisableKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DisableKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DisableKeyResponse) String() string
DownloadCertificateSigningRequestRequest wrapper for the DownloadCertificateSigningRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/DownloadCertificateSigningRequest.go.html to see an example of how to use DownloadCertificateSigningRequestRequest.
type DownloadCertificateSigningRequestRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// 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"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DownloadCertificateSigningRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DownloadCertificateSigningRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DownloadCertificateSigningRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DownloadCertificateSigningRequestRequest) String() string
func (request DownloadCertificateSigningRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DownloadCertificateSigningRequestResponse wrapper for the DownloadCertificateSigningRequest operation
type DownloadCertificateSigningRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The string instance
Value *string `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DownloadCertificateSigningRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DownloadCertificateSigningRequestResponse) String() string
EkmClient a client for Ekm
type EkmClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewEkmClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client EkmClient, err error)
NewEkmClientWithConfigurationProvider Creates a new default Ekm client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewEkmClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client EkmClient, err error)
NewEkmClientWithOboToken Creates a new default Ekm 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 (client *EkmClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client EkmClient) CreateEkmsPrivateEndpoint(ctx context.Context, request CreateEkmsPrivateEndpointRequest) (response CreateEkmsPrivateEndpointResponse, err error)
CreateEkmsPrivateEndpoint Create a new EKMS private endpoint used to connect to external key manager system
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateEkmsPrivateEndpoint.go.html to see an example of how to use CreateEkmsPrivateEndpoint API.
func (client EkmClient) DeleteEkmsPrivateEndpoint(ctx context.Context, request DeleteEkmsPrivateEndpointRequest) (response DeleteEkmsPrivateEndpointResponse, err error)
DeleteEkmsPrivateEndpoint Deletes EKMS private endpoint by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/DeleteEkmsPrivateEndpoint.go.html to see an example of how to use DeleteEkmsPrivateEndpoint API.
func (client EkmClient) GetEkmsPrivateEndpoint(ctx context.Context, request GetEkmsPrivateEndpointRequest) (response GetEkmsPrivateEndpointResponse, err error)
GetEkmsPrivateEndpoint Gets a specific EKMS private by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetEkmsPrivateEndpoint.go.html to see an example of how to use GetEkmsPrivateEndpoint API.
func (client EkmClient) ListEkmsPrivateEndpoints(ctx context.Context, request ListEkmsPrivateEndpointsRequest) (response ListEkmsPrivateEndpointsResponse, err error)
ListEkmsPrivateEndpoints Returns a list of all the EKMS private endpoints in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListEkmsPrivateEndpoints.go.html to see an example of how to use ListEkmsPrivateEndpoints API.
func (client *EkmClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client EkmClient) UpdateEkmsPrivateEndpoint(ctx context.Context, request UpdateEkmsPrivateEndpointRequest) (response UpdateEkmsPrivateEndpointResponse, err error)
UpdateEkmsPrivateEndpoint Updates EKMS private endpoint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateEkmsPrivateEndpoint.go.html to see an example of how to use UpdateEkmsPrivateEndpoint API.
EkmsPrivateEndpoint EKMS private endpoint created in customer subnet used to connect to external key manager system
type EkmsPrivateEndpoint struct {
// Unique identifier that is immutable
Id *string `mandatory:"true" json:"id"`
// Compartment Identifier.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Subnet Identifier
SubnetId *string `mandatory:"true" json:"subnetId"`
// EKMS Private Endpoint display name
DisplayName *string `mandatory:"true" json:"displayName"`
// The time the EKMS private endpoint was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the EKMS private endpoint resource.
LifecycleState EkmsPrivateEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Private IP of the external key manager system to connect to from the EKMS private endpoint
ExternalKeyManagerIp *string `mandatory:"true" json:"externalKeyManagerIp"`
// The time the EKMS private endpoint was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The port of the external key manager system
Port *int `mandatory:"false" json:"port"`
// CABundle to validate TLS certificate of the external key manager system in PEM format
CaBundle *string `mandatory:"false" json:"caBundle"`
// The IP address in the customer's VCN for the EKMS private endpoint. This is taken from subnet
PrivateEndpointIp *string `mandatory:"false" json:"privateEndpointIp"`
}
func (m EkmsPrivateEndpoint) String() string
func (m EkmsPrivateEndpoint) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EkmsPrivateEndpointLifecycleStateEnum Enum with underlying type: string
type EkmsPrivateEndpointLifecycleStateEnum string
Set of constants representing the allowable values for EkmsPrivateEndpointLifecycleStateEnum
const (
EkmsPrivateEndpointLifecycleStateCreating EkmsPrivateEndpointLifecycleStateEnum = "CREATING"
EkmsPrivateEndpointLifecycleStateActive EkmsPrivateEndpointLifecycleStateEnum = "ACTIVE"
EkmsPrivateEndpointLifecycleStateDeleting EkmsPrivateEndpointLifecycleStateEnum = "DELETING"
EkmsPrivateEndpointLifecycleStateDeleted EkmsPrivateEndpointLifecycleStateEnum = "DELETED"
EkmsPrivateEndpointLifecycleStateFailed EkmsPrivateEndpointLifecycleStateEnum = "FAILED"
)
func GetEkmsPrivateEndpointLifecycleStateEnumValues() []EkmsPrivateEndpointLifecycleStateEnum
GetEkmsPrivateEndpointLifecycleStateEnumValues Enumerates the set of values for EkmsPrivateEndpointLifecycleStateEnum
func GetMappingEkmsPrivateEndpointLifecycleStateEnum(val string) (EkmsPrivateEndpointLifecycleStateEnum, bool)
GetMappingEkmsPrivateEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
EkmsPrivateEndpointSummary EKMS private endpoints summary
type EkmsPrivateEndpointSummary struct {
// Unique identifier that is immutable
Id *string `mandatory:"true" json:"id"`
// Subnet Identifier
SubnetId *string `mandatory:"true" json:"subnetId"`
// Identifier of the compartment this EKMS private endpoint belongs to
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the EKMS private endpoint was created. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Mutable name of the EKMS private endpoint
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the EKMS private endpoint resource.
LifecycleState EkmsPrivateEndpointSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the EKMS private endpoint was updated. An RFC3339 (https://tools.ietf.org/html/rfc3339) formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m EkmsPrivateEndpointSummary) String() string
func (m EkmsPrivateEndpointSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EkmsPrivateEndpointSummaryLifecycleStateEnum Enum with underlying type: string
type EkmsPrivateEndpointSummaryLifecycleStateEnum string
Set of constants representing the allowable values for EkmsPrivateEndpointSummaryLifecycleStateEnum
const (
EkmsPrivateEndpointSummaryLifecycleStateCreating EkmsPrivateEndpointSummaryLifecycleStateEnum = "CREATING"
EkmsPrivateEndpointSummaryLifecycleStateActive EkmsPrivateEndpointSummaryLifecycleStateEnum = "ACTIVE"
EkmsPrivateEndpointSummaryLifecycleStateDeleting EkmsPrivateEndpointSummaryLifecycleStateEnum = "DELETING"
EkmsPrivateEndpointSummaryLifecycleStateDeleted EkmsPrivateEndpointSummaryLifecycleStateEnum = "DELETED"
EkmsPrivateEndpointSummaryLifecycleStateFailed EkmsPrivateEndpointSummaryLifecycleStateEnum = "FAILED"
)
func GetEkmsPrivateEndpointSummaryLifecycleStateEnumValues() []EkmsPrivateEndpointSummaryLifecycleStateEnum
GetEkmsPrivateEndpointSummaryLifecycleStateEnumValues Enumerates the set of values for EkmsPrivateEndpointSummaryLifecycleStateEnum
func GetMappingEkmsPrivateEndpointSummaryLifecycleStateEnum(val string) (EkmsPrivateEndpointSummaryLifecycleStateEnum, bool)
GetMappingEkmsPrivateEndpointSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
EnableKeyRequest wrapper for the EnableKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/EnableKey.go.html to see an example of how to use EnableKeyRequest.
type EnableKeyRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request EnableKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request EnableKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request EnableKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request EnableKeyRequest) String() string
func (request EnableKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EnableKeyResponse wrapper for the EnableKey operation
type EnableKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response EnableKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response EnableKeyResponse) String() string
EncryptDataDetails The details of the plaintext data that you want to encrypt.
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 key version used to encrypt the ciphertext.
KeyVersionId *string `mandatory:"false" json:"keyVersionId"`
// The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
// `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
// that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the
// key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).
// `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
// and uses OAEP.
EncryptionAlgorithm EncryptDataDetailsEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
}
func (m EncryptDataDetails) String() string
func (m EncryptDataDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EncryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string
type EncryptDataDetailsEncryptionAlgorithmEnum string
Set of constants representing the allowable values for EncryptDataDetailsEncryptionAlgorithmEnum
const (
EncryptDataDetailsEncryptionAlgorithmAes256Gcm EncryptDataDetailsEncryptionAlgorithmEnum = "AES_256_GCM"
EncryptDataDetailsEncryptionAlgorithmRsaOaepSha1 EncryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1"
EncryptDataDetailsEncryptionAlgorithmRsaOaepSha256 EncryptDataDetailsEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256"
)
func GetEncryptDataDetailsEncryptionAlgorithmEnumValues() []EncryptDataDetailsEncryptionAlgorithmEnum
GetEncryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptDataDetailsEncryptionAlgorithmEnum
func GetMappingEncryptDataDetailsEncryptionAlgorithmEnum(val string) (EncryptDataDetailsEncryptionAlgorithmEnum, bool)
GetMappingEncryptDataDetailsEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
EncryptRequest wrapper for the Encrypt operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/Encrypt.go.html to see an example of how to use EncryptRequest.
type EncryptRequest struct {
// EncryptDataDetails
EncryptDataDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request EncryptRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request EncryptRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request EncryptRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request EncryptRequest) String() string
func (request EncryptRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EncryptResponse wrapper for the Encrypt operation
type EncryptResponse struct {
// The underlying http response
RawResponse *http.Response
// The EncryptedData instance
EncryptedData `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response EncryptResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response EncryptResponse) String() string
EncryptedData The response to a request to encrypt the plaintext data.
type EncryptedData struct {
// The encrypted data.
Ciphertext *string `mandatory:"true" json:"ciphertext"`
// The OCID of the key used to encrypt the ciphertext.
KeyId *string `mandatory:"false" json:"keyId"`
// The OCID of the key version used to encrypt the ciphertext.
KeyVersionId *string `mandatory:"false" json:"keyVersionId"`
// The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
// `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and
// that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the
// key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP).
// `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash
// and uses OAEP.
EncryptionAlgorithm EncryptedDataEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
}
func (m EncryptedData) String() string
func (m EncryptedData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EncryptedDataEncryptionAlgorithmEnum Enum with underlying type: string
type EncryptedDataEncryptionAlgorithmEnum string
Set of constants representing the allowable values for EncryptedDataEncryptionAlgorithmEnum
const (
EncryptedDataEncryptionAlgorithmAes256Gcm EncryptedDataEncryptionAlgorithmEnum = "AES_256_GCM"
EncryptedDataEncryptionAlgorithmRsaOaepSha1 EncryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_1"
EncryptedDataEncryptionAlgorithmRsaOaepSha256 EncryptedDataEncryptionAlgorithmEnum = "RSA_OAEP_SHA_256"
)
func GetEncryptedDataEncryptionAlgorithmEnumValues() []EncryptedDataEncryptionAlgorithmEnum
GetEncryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptedDataEncryptionAlgorithmEnum
func GetMappingEncryptedDataEncryptionAlgorithmEnum(val string) (EncryptedDataEncryptionAlgorithmEnum, bool)
GetMappingEncryptedDataEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
ExportKeyDetails The details of the key that you want to wrap and export.
type ExportKeyDetails struct {
// The OCID of the master encryption key associated with the key version you want to export.
KeyId *string `mandatory:"true" json:"keyId"`
// The encryption algorithm to use to encrypt exportable key material from a software-backed key. Specifying `RSA_OAEP_AES_SHA256`
// invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public
// wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap
// the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing
// concatenated blob output that jointly represents them. Specifying `RSA_OAEP_SHA256` means that the software key is wrapped by
// the RSA public wrapping key provided along with the request.
Algorithm ExportKeyDetailsAlgorithmEnum `mandatory:"true" json:"algorithm"`
// The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the key.
PublicKey *string `mandatory:"true" json:"publicKey"`
// The OCID of the specific key version to export. If not specified, the service exports the current key version.
KeyVersionId *string `mandatory:"false" json:"keyVersionId"`
// Information that provides context for audit logging. You can provide this additional
// data as key-value pairs to include in the audit logs when audit logging is enabled.
LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`
}
func (m ExportKeyDetails) String() string
func (m ExportKeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExportKeyDetailsAlgorithmEnum Enum with underlying type: string
type ExportKeyDetailsAlgorithmEnum string
Set of constants representing the allowable values for ExportKeyDetailsAlgorithmEnum
const (
ExportKeyDetailsAlgorithmAesSha256 ExportKeyDetailsAlgorithmEnum = "RSA_OAEP_AES_SHA256"
ExportKeyDetailsAlgorithmSha256 ExportKeyDetailsAlgorithmEnum = "RSA_OAEP_SHA256"
)
func GetExportKeyDetailsAlgorithmEnumValues() []ExportKeyDetailsAlgorithmEnum
GetExportKeyDetailsAlgorithmEnumValues Enumerates the set of values for ExportKeyDetailsAlgorithmEnum
func GetMappingExportKeyDetailsAlgorithmEnum(val string) (ExportKeyDetailsAlgorithmEnum, bool)
GetMappingExportKeyDetailsAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
ExportKeyRequest wrapper for the ExportKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ExportKey.go.html to see an example of how to use ExportKeyRequest.
type ExportKeyRequest struct {
// ExportKeyDetails
ExportKeyDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ExportKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExportKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExportKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExportKeyRequest) String() string
func (request ExportKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExportKeyResponse wrapper for the ExportKey operation
type ExportKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ExportedKeyData instance
ExportedKeyData `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ExportKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExportKeyResponse) String() string
ExportedKeyData The response to a request to export key material.
type ExportedKeyData struct {
// The OCID of the key version.
KeyVersionId *string `mandatory:"true" json:"keyVersionId"`
// The OCID of the master encryption key associated with this key version.
KeyId *string `mandatory:"true" json:"keyId"`
// The date and time this key version was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID of the vault that contains this key version.
VaultId *string `mandatory:"true" json:"vaultId"`
// The base64-encoded exported key material, which is encrypted by using the public RSA wrapping key specified in the export request.
EncryptedKey *string `mandatory:"true" json:"encryptedKey"`
// The encryption algorithm to use to encrypt exportable key material from a key that persists on the server (as opposed to a key that
// persists on a hardware security module and, therefore, cannot be exported). Specifying RSA_OAEP_AES_SHA256 invokes the RSA AES key
// wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along
// with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The
// wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly
// represents them. Specifying RSA_OAEP_SHA256 means that the exportable key material is wrapped by the RSA public wrapping key provided
// along with the request.
Algorithm ExportedKeyDataAlgorithmEnum `mandatory:"true" json:"algorithm"`
}
func (m ExportedKeyData) String() string
func (m ExportedKeyData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExportedKeyDataAlgorithmEnum Enum with underlying type: string
type ExportedKeyDataAlgorithmEnum string
Set of constants representing the allowable values for ExportedKeyDataAlgorithmEnum
const (
ExportedKeyDataAlgorithmAesSha256 ExportedKeyDataAlgorithmEnum = "RSA_OAEP_AES_SHA256"
ExportedKeyDataAlgorithmSha256 ExportedKeyDataAlgorithmEnum = "RSA_OAEP_SHA256"
)
func GetExportedKeyDataAlgorithmEnumValues() []ExportedKeyDataAlgorithmEnum
GetExportedKeyDataAlgorithmEnumValues Enumerates the set of values for ExportedKeyDataAlgorithmEnum
func GetMappingExportedKeyDataAlgorithmEnum(val string) (ExportedKeyDataAlgorithmEnum, bool)
GetMappingExportedKeyDataAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
ExternalKeyManagerMetadata Metadata required for accessing External Key manager
type ExternalKeyManagerMetadata struct {
OauthMetadata *OauthMetadata `mandatory:"true" json:"oauthMetadata"`
// URI of the vault on external key manager.
ExternalVaultEndpointUrl *string `mandatory:"true" json:"externalVaultEndpointUrl"`
// OCID of private endpoint created by customer.
PrivateEndpointId *string `mandatory:"true" json:"privateEndpointId"`
}
func (m ExternalKeyManagerMetadata) String() string
func (m ExternalKeyManagerMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExternalKeyManagerMetadataSummary Summary about metadata of external key manager to be returned to the customer as a response.
type ExternalKeyManagerMetadataSummary struct {
// URL of the vault on external key manager.
ExternalVaultEndpointUrl *string `mandatory:"true" json:"externalVaultEndpointUrl"`
// OCID of the private endpoint.
PrivateEndpointId *string `mandatory:"true" json:"privateEndpointId"`
// Vendor of the external key manager.
Vendor *string `mandatory:"false" json:"vendor"`
OauthMetadataSummary *OauthMetadataSummary `mandatory:"false" json:"oauthMetadataSummary"`
}
func (m ExternalKeyManagerMetadataSummary) String() string
func (m ExternalKeyManagerMetadataSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExternalKeyReference A reference to the key on external key manager.
type ExternalKeyReference struct {
// ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM
ExternalKeyId *string `mandatory:"true" json:"externalKeyId"`
}
func (m ExternalKeyReference) String() string
func (m ExternalKeyReference) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExternalKeyReferenceDetails Key reference data to be returned to the customer as a response.
type ExternalKeyReferenceDetails struct {
// ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.
ExternalKeyId *string `mandatory:"true" json:"externalKeyId"`
// Key version ID associated with the external key.
ExternalKeyVersionId *string `mandatory:"true" json:"externalKeyVersionId"`
}
func (m ExternalKeyReferenceDetails) String() string
func (m ExternalKeyReferenceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExternalKeyVersionReference A reference to key version on external key manager.
type ExternalKeyVersionReference struct {
// Key version ID associated with the external key.
ExternalKeyVersionId *string `mandatory:"false" json:"externalKeyVersionId"`
}
func (m ExternalKeyVersionReference) String() string
func (m ExternalKeyVersionReference) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateDataEncryptionKeyRequest wrapper for the GenerateDataEncryptionKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GenerateDataEncryptionKey.go.html to see an example of how to use GenerateDataEncryptionKeyRequest.
type GenerateDataEncryptionKeyRequest struct {
// GenerateKeyDetails
GenerateKeyDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GenerateDataEncryptionKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateDataEncryptionKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateDataEncryptionKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateDataEncryptionKeyRequest) String() string
func (request GenerateDataEncryptionKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateDataEncryptionKeyResponse wrapper for the GenerateDataEncryptionKey operation
type GenerateDataEncryptionKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The GeneratedKey instance
GeneratedKey `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GenerateDataEncryptionKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateDataEncryptionKeyResponse) String() string
GenerateKeyDetails The details of the key that you want to encrypt or decrypt data.
type GenerateKeyDetails struct {
// If true, the generated key is also returned unencrypted.
IncludePlaintextKey *bool `mandatory:"true" json:"includePlaintextKey"`
// The OCID of the master encryption key to encrypt the generated data encryption key with.
KeyId *string `mandatory:"true" json:"keyId"`
KeyShape *KeyShape `mandatory:"true" json:"keyShape"`
// Information that can be used to provide an encryption context for the encrypted data.
// The length of the string representation of the associated data must be fewer than 4096
// characters.
AssociatedData map[string]string `mandatory:"false" json:"associatedData"`
// Information that provides context for audit logging. You can provide this additional
// data by formatting it as key-value pairs to include in audit logs when audit logging is enabled.
LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`
}
func (m GenerateKeyDetails) String() string
func (m GenerateKeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GeneratedKey The reponse to the regeuest to generate the key to encrypt or decrypt the data.
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.oracle.com/iaas/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.oracle.com/iaas/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey)
// request includes the `includePlaintextKey` parameter and sets its value to "true".
PlaintextChecksum *string `mandatory:"false" json:"plaintextChecksum"`
}
func (m GeneratedKey) String() string
func (m GeneratedKey) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetEkmsPrivateEndpointRequest wrapper for the GetEkmsPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetEkmsPrivateEndpoint.go.html to see an example of how to use GetEkmsPrivateEndpointRequest.
type GetEkmsPrivateEndpointRequest struct {
// Unique EKMS private endpoint identifier.
EkmsPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"ekmsPrivateEndpointId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetEkmsPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetEkmsPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEkmsPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEkmsPrivateEndpointRequest) String() string
func (request GetEkmsPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetEkmsPrivateEndpointResponse wrapper for the GetEkmsPrivateEndpoint operation
type GetEkmsPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The EkmsPrivateEndpoint instance
EkmsPrivateEndpoint `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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetEkmsPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEkmsPrivateEndpointResponse) String() string
GetHsmClusterRequest wrapper for the GetHsmCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetHsmCluster.go.html to see an example of how to use GetHsmClusterRequest.
type GetHsmClusterRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetHsmClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHsmClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHsmClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHsmClusterRequest) String() string
func (request GetHsmClusterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetHsmClusterResponse wrapper for the GetHsmCluster operation
type GetHsmClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The HsmCluster instance
HsmCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetHsmClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHsmClusterResponse) String() string
GetHsmPartitionRequest wrapper for the GetHsmPartition operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetHsmPartition.go.html to see an example of how to use GetHsmPartitionRequest.
type GetHsmPartitionRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// The OCID of the HSM Partition. This is a unique identifier which each hsmPartition will have.
HsmPartitionId *string `mandatory:"true" contributesTo:"path" name:"hsmPartitionId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetHsmPartitionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetHsmPartitionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetHsmPartitionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetHsmPartitionRequest) String() string
func (request GetHsmPartitionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetHsmPartitionResponse wrapper for the GetHsmPartition operation
type GetHsmPartitionResponse struct {
// The underlying http response
RawResponse *http.Response
// The HsmPartition instance
HsmPartition `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetHsmPartitionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetHsmPartitionResponse) String() string
GetKeyRequest wrapper for the GetKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetKey.go.html to see an example of how to use GetKeyRequest.
type GetKeyRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetKeyRequest) String() string
func (request GetKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetKeyResponse wrapper for the GetKey operation
type GetKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetKeyResponse) String() string
GetKeyVersionRequest wrapper for the GetKeyVersion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetKeyVersion.go.html to see an example of how to use GetKeyVersionRequest.
type GetKeyVersionRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// The OCID of the key version.
KeyVersionId *string `mandatory:"true" contributesTo:"path" name:"keyVersionId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetKeyVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetKeyVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetKeyVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetKeyVersionRequest) String() string
func (request GetKeyVersionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetKeyVersionResponse wrapper for the GetKeyVersion operation
type GetKeyVersionResponse struct {
// The underlying http response
RawResponse *http.Response
// The KeyVersion instance
KeyVersion `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetKeyVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetKeyVersionResponse) String() string
GetPreCoUserCredentialsRequest wrapper for the GetPreCoUserCredentials operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetPreCoUserCredentials.go.html to see an example of how to use GetPreCoUserCredentialsRequest.
type GetPreCoUserCredentialsRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetPreCoUserCredentialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPreCoUserCredentialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPreCoUserCredentialsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPreCoUserCredentialsRequest) String() string
func (request GetPreCoUserCredentialsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPreCoUserCredentialsResponse wrapper for the GetPreCoUserCredentials operation
type GetPreCoUserCredentialsResponse struct {
// The underlying http response
RawResponse *http.Response
// The PreCoUserCredentials instance
PreCoUserCredentials `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetPreCoUserCredentialsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPreCoUserCredentialsResponse) String() string
GetReplicationStatusRequest wrapper for the GetReplicationStatus operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetReplicationStatus.go.html to see an example of how to use GetReplicationStatusRequest.
type GetReplicationStatusRequest struct {
// replicationId associated with an operation on a resource
ReplicationId *string `mandatory:"true" contributesTo:"path" name:"replicationId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetReplicationStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetReplicationStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetReplicationStatusRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetReplicationStatusRequest) String() string
func (request GetReplicationStatusRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetReplicationStatusResponse wrapper for the GetReplicationStatus operation
type GetReplicationStatusResponse struct {
// The underlying http response
RawResponse *http.Response
// The ReplicationStatusDetails instance
ReplicationStatusDetails `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetReplicationStatusResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetReplicationStatusResponse) String() string
GetVaultRequest wrapper for the GetVault operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetVault.go.html to see an example of how to use GetVaultRequest.
type GetVaultRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetVaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetVaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVaultRequest) String() string
func (request GetVaultRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetVaultResponse wrapper for the GetVault operation
type GetVaultResponse struct {
// The underlying http response
RawResponse *http.Response
// The Vault instance
Vault `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVaultResponse) String() string
GetVaultUsageRequest wrapper for the GetVaultUsage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetVaultUsage.go.html to see an example of how to use GetVaultUsageRequest.
type GetVaultUsageRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetVaultUsageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetVaultUsageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetVaultUsageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetVaultUsageRequest) String() string
func (request GetVaultUsageRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetVaultUsageResponse wrapper for the GetVaultUsage operation
type GetVaultUsageResponse struct {
// The underlying http response
RawResponse *http.Response
// The VaultUsage instance
VaultUsage `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetVaultUsageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetVaultUsageResponse) String() string
GetWrappingKeyRequest wrapper for the GetWrappingKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetWrappingKey.go.html to see an example of how to use GetWrappingKeyRequest.
type GetWrappingKeyRequest struct {
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWrappingKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWrappingKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWrappingKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWrappingKeyRequest) String() string
func (request GetWrappingKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWrappingKeyResponse wrapper for the GetWrappingKey operation
type GetWrappingKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The WrappingKey instance
WrappingKey `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetWrappingKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWrappingKeyResponse) String() string
HsmCluster Dedicated KMS-HSM Cluster Management
type HsmCluster struct {
// The OCID of the HSMCluster resource.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains this HSMCluster resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly display name for the HSMCluster resource. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The date and time this HSM resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2023-04-03T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time this HSM resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2023-04-03T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The HSMCluster's current state.
// Example: `ACTIVE`
LifecycleState HsmClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// DNS name for the HSM Cluster -- this will contain information about the region as well.
DnsName *string `mandatory:"true" json:"dnsName"`
// 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m HsmCluster) String() string
func (m HsmCluster) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HsmClusterCollection HsmClusterCollection object with page of HsmClusterSummary objects.
type HsmClusterCollection struct {
// List of HSM Cluster Summary Objects.
Items []HsmClusterSummary `mandatory:"true" json:"items"`
}
func (m HsmClusterCollection) String() string
func (m HsmClusterCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HsmClusterLifecycleStateEnum Enum with underlying type: string
type HsmClusterLifecycleStateEnum string
Set of constants representing the allowable values for HsmClusterLifecycleStateEnum
const (
HsmClusterLifecycleStateCreating HsmClusterLifecycleStateEnum = "CREATING"
HsmClusterLifecycleStateInitializationRequired HsmClusterLifecycleStateEnum = "INITIALIZATION_REQUIRED"
HsmClusterLifecycleStateInitializing HsmClusterLifecycleStateEnum = "INITIALIZING"
HsmClusterLifecycleStateActivationRequired HsmClusterLifecycleStateEnum = "ACTIVATION_REQUIRED"
HsmClusterLifecycleStateActivating HsmClusterLifecycleStateEnum = "ACTIVATING"
HsmClusterLifecycleStateActive HsmClusterLifecycleStateEnum = "ACTIVE"
HsmClusterLifecycleStateDeleting HsmClusterLifecycleStateEnum = "DELETING"
HsmClusterLifecycleStateDeleted HsmClusterLifecycleStateEnum = "DELETED"
HsmClusterLifecycleStatePendingDeletion HsmClusterLifecycleStateEnum = "PENDING_DELETION"
HsmClusterLifecycleStateSchedulingDeletion HsmClusterLifecycleStateEnum = "SCHEDULING_DELETION"
HsmClusterLifecycleStateCancellingDeletion HsmClusterLifecycleStateEnum = "CANCELLING_DELETION"
)
func GetHsmClusterLifecycleStateEnumValues() []HsmClusterLifecycleStateEnum
GetHsmClusterLifecycleStateEnumValues Enumerates the set of values for HsmClusterLifecycleStateEnum
func GetMappingHsmClusterLifecycleStateEnum(val string) (HsmClusterLifecycleStateEnum, bool)
GetMappingHsmClusterLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
HsmClusterSummary An object which encapsulates the details of a given HSM Cluster.
type HsmClusterSummary struct {
// The OCID of a HSMCluster resource.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name for a HSMCluster resource. 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 compartment that contains a particular HSMCluster resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A HSMCluster resource's current lifecycle state.
// Example: `ACTIVE`
LifecycleState HsmClusterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// DNS name for the HSMCluster -- this will contain information about the region as well.
DnsName *string `mandatory:"true" json:"dnsName"`
// The date and time a dedicated KMS resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2023-04-03T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time a dedicated KMS resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2023-04-03T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// An optional property indicating when to delete the resource, 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m HsmClusterSummary) String() string
func (m HsmClusterSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HsmPartition Dedicated KMS-HSM Partition Management
type HsmPartition struct {
// The OCID of the HSM resource. Each HSM resource has a unique OCID as an identifier.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains a particular HSM resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (refers to either an enum value of Managementutility,Clientutility, or null)
PortInformation []PortInformation `mandatory:"true" json:"portInformation"`
// The date and time a HSMPartition 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 date and time a HSMPartition was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2018-04-03T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// A HSMCluster resource's current lifecycle state.
// Example: `ACTIVE`
LifecycleState HsmPartitionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m HsmPartition) String() string
func (m HsmPartition) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HsmPartitionCollection HsmPartitionCollection object with page of HsmPartitionSummary objects. A HsmPartitionSummary object contains details about the corresponding HSM.
type HsmPartitionCollection struct {
// List of HsmPartitionSummaries.
Items []HsmPartitionSummary `mandatory:"true" json:"items"`
}
func (m HsmPartitionCollection) String() string
func (m HsmPartitionCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
HsmPartitionLifecycleStateEnum Enum with underlying type: string
type HsmPartitionLifecycleStateEnum string
Set of constants representing the allowable values for HsmPartitionLifecycleStateEnum
const (
HsmPartitionLifecycleStateActive HsmPartitionLifecycleStateEnum = "ACTIVE"
HsmPartitionLifecycleStateInactive HsmPartitionLifecycleStateEnum = "INACTIVE"
HsmPartitionLifecycleStateActivating HsmPartitionLifecycleStateEnum = "ACTIVATING"
HsmPartitionLifecycleStateActivationRequired HsmPartitionLifecycleStateEnum = "ACTIVATION_REQUIRED"
HsmPartitionLifecycleStateSchedulingDeletion HsmPartitionLifecycleStateEnum = "SCHEDULING_DELETION"
HsmPartitionLifecycleStatePendingDeletion HsmPartitionLifecycleStateEnum = "PENDING_DELETION"
HsmPartitionLifecycleStateDeleting HsmPartitionLifecycleStateEnum = "DELETING"
HsmPartitionLifecycleStateDeleted HsmPartitionLifecycleStateEnum = "DELETED"
)
func GetHsmPartitionLifecycleStateEnumValues() []HsmPartitionLifecycleStateEnum
GetHsmPartitionLifecycleStateEnumValues Enumerates the set of values for HsmPartitionLifecycleStateEnum
func GetMappingHsmPartitionLifecycleStateEnum(val string) (HsmPartitionLifecycleStateEnum, bool)
GetMappingHsmPartitionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
HsmPartitionSummary An object which encapsulates the details of a given HSM.
type HsmPartitionSummary struct {
// The OCID of the HSM resource. Each HSM resource will have a unique OCID identifier.
Id *string `mandatory:"true" json:"id"`
// The OCID of the HSMCluster that contains a particular HSM resource.
HsmClusterId *string `mandatory:"true" json:"hsmClusterId"`
// A HSMCluster resource's current lifecycle state.
// Example: `ACTIVE`
LifecycleState HsmPartitionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the compartment that contains a particular HSM resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (refers to either an enum value of Managementutility,Clientutility, or null)
PortInformation []PortInformation `mandatory:"true" json:"portInformation"`
// The date and time an HSM 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 date and time an HSM was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2018-04-03T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
}
func (m HsmPartitionSummary) String() string
func (m HsmPartitionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportKeyDetails The details of the Key that you wish to import.
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"`
// A parameter specifying whether the auto key rotation is enabled or not.
IsAutoRotationEnabled *bool `mandatory:"false" json:"isAutoRotationEnabled"`
AutoKeyRotationDetails *AutoKeyRotationDetails `mandatory:"false" json:"autoKeyRotationDetails"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "foo-value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
// A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
// the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists
// on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default,
// a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported.
ProtectionMode ImportKeyDetailsProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"`
}
func (m ImportKeyDetails) String() string
func (m ImportKeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportKeyDetailsProtectionModeEnum Enum with underlying type: string
type ImportKeyDetailsProtectionModeEnum string
Set of constants representing the allowable values for ImportKeyDetailsProtectionModeEnum
const (
ImportKeyDetailsProtectionModeHsm ImportKeyDetailsProtectionModeEnum = "HSM"
ImportKeyDetailsProtectionModeSoftware ImportKeyDetailsProtectionModeEnum = "SOFTWARE"
)
func GetImportKeyDetailsProtectionModeEnumValues() []ImportKeyDetailsProtectionModeEnum
GetImportKeyDetailsProtectionModeEnumValues Enumerates the set of values for ImportKeyDetailsProtectionModeEnum
func GetMappingImportKeyDetailsProtectionModeEnum(val string) (ImportKeyDetailsProtectionModeEnum, bool)
GetMappingImportKeyDetailsProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum
ImportKeyRequest wrapper for the ImportKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ImportKey.go.html to see an example of how to use ImportKeyRequest.
type ImportKeyRequest struct {
// ImportKeyDetails
ImportKeyDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ImportKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportKeyRequest) String() string
func (request ImportKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportKeyResponse wrapper for the ImportKey operation
type ImportKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ImportKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportKeyResponse) String() string
ImportKeyVersionDetails The details of the KeyVersion that you wish to import.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m ImportKeyVersionDetails) String() string
func (m ImportKeyVersionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportKeyVersionRequest wrapper for the ImportKeyVersion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ImportKeyVersion.go.html to see an example of how to use ImportKeyVersionRequest.
type ImportKeyVersionRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// ImportKeyVersionDetails
ImportKeyVersionDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ImportKeyVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportKeyVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportKeyVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportKeyVersionRequest) String() string
func (request ImportKeyVersionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportKeyVersionResponse wrapper for the ImportKeyVersion operation
type ImportKeyVersionResponse struct {
// The underlying http response
RawResponse *http.Response
// The KeyVersion instance
KeyVersion `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ImportKeyVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportKeyVersionResponse) String() string
Key The logical entities that represent one or more key versions, each of which contains cryptographic material.
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.oracle.com/iaas/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.oracle.com/iaas/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.
// A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle.
// Oracle only hold a reference to that key.
// All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager.
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"`
ReplicaDetails *KeyReplicaDetails `mandatory:"false" json:"replicaDetails"`
// A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
IsPrimary *bool `mandatory:"false" json:"isPrimary"`
// A parameter specifying whether the auto key rotation is enabled or not.
IsAutoRotationEnabled *bool `mandatory:"false" json:"isAutoRotationEnabled"`
AutoKeyRotationDetails *AutoKeyRotationDetails `mandatory:"false" json:"autoKeyRotationDetails"`
ExternalKeyReferenceDetails *ExternalKeyReferenceDetails `mandatory:"false" json:"externalKeyReferenceDetails"`
}
func (m Key) String() string
func (m Key) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyLifecycleStateEnum Enum with underlying type: string
type KeyLifecycleStateEnum string
Set of constants representing the allowable values for KeyLifecycleStateEnum
const (
KeyLifecycleStateCreating KeyLifecycleStateEnum = "CREATING"
KeyLifecycleStateEnabling KeyLifecycleStateEnum = "ENABLING"
KeyLifecycleStateEnabled KeyLifecycleStateEnum = "ENABLED"
KeyLifecycleStateDisabling KeyLifecycleStateEnum = "DISABLING"
KeyLifecycleStateDisabled KeyLifecycleStateEnum = "DISABLED"
KeyLifecycleStateDeleting KeyLifecycleStateEnum = "DELETING"
KeyLifecycleStateDeleted KeyLifecycleStateEnum = "DELETED"
KeyLifecycleStatePendingDeletion KeyLifecycleStateEnum = "PENDING_DELETION"
KeyLifecycleStateSchedulingDeletion KeyLifecycleStateEnum = "SCHEDULING_DELETION"
KeyLifecycleStateCancellingDeletion KeyLifecycleStateEnum = "CANCELLING_DELETION"
KeyLifecycleStateUpdating KeyLifecycleStateEnum = "UPDATING"
KeyLifecycleStateBackupInProgress KeyLifecycleStateEnum = "BACKUP_IN_PROGRESS"
KeyLifecycleStateRestoring KeyLifecycleStateEnum = "RESTORING"
)
func GetKeyLifecycleStateEnumValues() []KeyLifecycleStateEnum
GetKeyLifecycleStateEnumValues Enumerates the set of values for KeyLifecycleStateEnum
func GetMappingKeyLifecycleStateEnum(val string) (KeyLifecycleStateEnum, bool)
GetMappingKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
KeyProtectionModeEnum Enum with underlying type: string
type KeyProtectionModeEnum string
Set of constants representing the allowable values for KeyProtectionModeEnum
const (
KeyProtectionModeHsm KeyProtectionModeEnum = "HSM"
KeyProtectionModeSoftware KeyProtectionModeEnum = "SOFTWARE"
KeyProtectionModeExternal KeyProtectionModeEnum = "EXTERNAL"
)
func GetKeyProtectionModeEnumValues() []KeyProtectionModeEnum
GetKeyProtectionModeEnumValues Enumerates the set of values for KeyProtectionModeEnum
func GetMappingKeyProtectionModeEnum(val string) (KeyProtectionModeEnum, bool)
GetMappingKeyProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum
KeyReplicaDetails Key replica details
type KeyReplicaDetails struct {
// ReplicationId associated with a key operation
ReplicationId *string `mandatory:"false" json:"replicationId"`
}
func (m KeyReplicaDetails) String() string
func (m KeyReplicaDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyShape The cryptographic properties of a key.
type KeyShape struct {
// The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for `External` keys.
Algorithm KeyShapeAlgorithmEnum `mandatory:"true" json:"algorithm"`
// The length of the key in bytes, expressed as an integer. Supported values include the following:
// - AES: 16, 24, or 32
// - RSA: 256, 384, or 512
// - ECDSA: 32, 48, or 66
Length *int `mandatory:"true" json:"length"`
// Supported curve IDs for ECDSA keys.
CurveId KeyShapeCurveIdEnum `mandatory:"false" json:"curveId,omitempty"`
}
func (m KeyShape) String() string
func (m KeyShape) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyShapeAlgorithmEnum Enum with underlying type: string
type KeyShapeAlgorithmEnum string
Set of constants representing the allowable values for KeyShapeAlgorithmEnum
const (
KeyShapeAlgorithmAes KeyShapeAlgorithmEnum = "AES"
KeyShapeAlgorithmRsa KeyShapeAlgorithmEnum = "RSA"
KeyShapeAlgorithmEcdsa KeyShapeAlgorithmEnum = "ECDSA"
)
func GetKeyShapeAlgorithmEnumValues() []KeyShapeAlgorithmEnum
GetKeyShapeAlgorithmEnumValues Enumerates the set of values for KeyShapeAlgorithmEnum
func GetMappingKeyShapeAlgorithmEnum(val string) (KeyShapeAlgorithmEnum, bool)
GetMappingKeyShapeAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
KeyShapeCurveIdEnum Enum with underlying type: string
type KeyShapeCurveIdEnum string
Set of constants representing the allowable values for KeyShapeCurveIdEnum
const (
KeyShapeCurveIdP256 KeyShapeCurveIdEnum = "NIST_P256"
KeyShapeCurveIdP384 KeyShapeCurveIdEnum = "NIST_P384"
KeyShapeCurveIdP521 KeyShapeCurveIdEnum = "NIST_P521"
)
func GetKeyShapeCurveIdEnumValues() []KeyShapeCurveIdEnum
GetKeyShapeCurveIdEnumValues Enumerates the set of values for KeyShapeCurveIdEnum
func GetMappingKeyShapeCurveIdEnum(val string) (KeyShapeCurveIdEnum, bool)
GetMappingKeyShapeCurveIdEnum performs case Insensitive comparison on enum value and return the desired enum
KeySummary The details of the Key.
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.oracle.com/iaas/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.oracle.com/iaas/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.
// A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle.
// Oracle only hold a reference to that key.
// All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager.
ProtectionMode KeySummaryProtectionModeEnum `mandatory:"false" json:"protectionMode,omitempty"`
// The algorithm used by a key's key versions to encrypt or decrypt data.
Algorithm KeySummaryAlgorithmEnum `mandatory:"false" json:"algorithm,omitempty"`
ExternalKeyReferenceDetails *ExternalKeyReferenceDetails `mandatory:"false" json:"externalKeyReferenceDetails"`
// A parameter specifying whether the auto key rotation is enabled or not.
IsAutoRotationEnabled *bool `mandatory:"false" json:"isAutoRotationEnabled"`
}
func (m KeySummary) String() string
func (m KeySummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeySummaryAlgorithmEnum Enum with underlying type: string
type KeySummaryAlgorithmEnum string
Set of constants representing the allowable values for KeySummaryAlgorithmEnum
const (
KeySummaryAlgorithmAes KeySummaryAlgorithmEnum = "AES"
KeySummaryAlgorithmRsa KeySummaryAlgorithmEnum = "RSA"
KeySummaryAlgorithmEcdsa KeySummaryAlgorithmEnum = "ECDSA"
)
func GetKeySummaryAlgorithmEnumValues() []KeySummaryAlgorithmEnum
GetKeySummaryAlgorithmEnumValues Enumerates the set of values for KeySummaryAlgorithmEnum
func GetMappingKeySummaryAlgorithmEnum(val string) (KeySummaryAlgorithmEnum, bool)
GetMappingKeySummaryAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
KeySummaryLifecycleStateEnum Enum with underlying type: string
type KeySummaryLifecycleStateEnum string
Set of constants representing the allowable values for KeySummaryLifecycleStateEnum
const (
KeySummaryLifecycleStateCreating KeySummaryLifecycleStateEnum = "CREATING"
KeySummaryLifecycleStateEnabling KeySummaryLifecycleStateEnum = "ENABLING"
KeySummaryLifecycleStateEnabled KeySummaryLifecycleStateEnum = "ENABLED"
KeySummaryLifecycleStateDisabling KeySummaryLifecycleStateEnum = "DISABLING"
KeySummaryLifecycleStateDisabled KeySummaryLifecycleStateEnum = "DISABLED"
KeySummaryLifecycleStateDeleting KeySummaryLifecycleStateEnum = "DELETING"
KeySummaryLifecycleStateDeleted KeySummaryLifecycleStateEnum = "DELETED"
KeySummaryLifecycleStatePendingDeletion KeySummaryLifecycleStateEnum = "PENDING_DELETION"
KeySummaryLifecycleStateSchedulingDeletion KeySummaryLifecycleStateEnum = "SCHEDULING_DELETION"
KeySummaryLifecycleStateCancellingDeletion KeySummaryLifecycleStateEnum = "CANCELLING_DELETION"
KeySummaryLifecycleStateUpdating KeySummaryLifecycleStateEnum = "UPDATING"
KeySummaryLifecycleStateBackupInProgress KeySummaryLifecycleStateEnum = "BACKUP_IN_PROGRESS"
KeySummaryLifecycleStateRestoring KeySummaryLifecycleStateEnum = "RESTORING"
)
func GetKeySummaryLifecycleStateEnumValues() []KeySummaryLifecycleStateEnum
GetKeySummaryLifecycleStateEnumValues Enumerates the set of values for KeySummaryLifecycleStateEnum
func GetMappingKeySummaryLifecycleStateEnum(val string) (KeySummaryLifecycleStateEnum, bool)
GetMappingKeySummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
KeySummaryProtectionModeEnum Enum with underlying type: string
type KeySummaryProtectionModeEnum string
Set of constants representing the allowable values for KeySummaryProtectionModeEnum
const (
KeySummaryProtectionModeHsm KeySummaryProtectionModeEnum = "HSM"
KeySummaryProtectionModeSoftware KeySummaryProtectionModeEnum = "SOFTWARE"
KeySummaryProtectionModeExternal KeySummaryProtectionModeEnum = "EXTERNAL"
)
func GetKeySummaryProtectionModeEnumValues() []KeySummaryProtectionModeEnum
GetKeySummaryProtectionModeEnumValues Enumerates the set of values for KeySummaryProtectionModeEnum
func GetMappingKeySummaryProtectionModeEnum(val string) (KeySummaryProtectionModeEnum, bool)
GetMappingKeySummaryProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum
KeyVersion The details of the KeyVersion associated with the Key.
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. (This value pertains only to 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"`
ReplicaDetails *KeyVersionReplicaDetails `mandatory:"false" json:"replicaDetails"`
// A Boolean value that indicates whether the KeyVersion belongs to primary Vault or replica Vault.
IsPrimary *bool `mandatory:"false" json:"isPrimary"`
ExternalKeyReferenceDetails *ExternalKeyReferenceDetails `mandatory:"false" json:"externalKeyReferenceDetails"`
// A Boolean Value indicating whether this keyversion is generated from auto rotation of key
IsAutoRotated *bool `mandatory:"false" json:"isAutoRotated"`
}
func (m KeyVersion) String() string
func (m KeyVersion) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyVersionLifecycleStateEnum Enum with underlying type: string
type KeyVersionLifecycleStateEnum string
Set of constants representing the allowable values for KeyVersionLifecycleStateEnum
const (
KeyVersionLifecycleStateCreating KeyVersionLifecycleStateEnum = "CREATING"
KeyVersionLifecycleStateEnabling KeyVersionLifecycleStateEnum = "ENABLING"
KeyVersionLifecycleStateEnabled KeyVersionLifecycleStateEnum = "ENABLED"
KeyVersionLifecycleStateDisabling KeyVersionLifecycleStateEnum = "DISABLING"
KeyVersionLifecycleStateDisabled KeyVersionLifecycleStateEnum = "DISABLED"
KeyVersionLifecycleStateDeleting KeyVersionLifecycleStateEnum = "DELETING"
KeyVersionLifecycleStateDeleted KeyVersionLifecycleStateEnum = "DELETED"
KeyVersionLifecycleStatePendingDeletion KeyVersionLifecycleStateEnum = "PENDING_DELETION"
KeyVersionLifecycleStateSchedulingDeletion KeyVersionLifecycleStateEnum = "SCHEDULING_DELETION"
KeyVersionLifecycleStateCancellingDeletion KeyVersionLifecycleStateEnum = "CANCELLING_DELETION"
)
func GetKeyVersionLifecycleStateEnumValues() []KeyVersionLifecycleStateEnum
GetKeyVersionLifecycleStateEnumValues Enumerates the set of values for KeyVersionLifecycleStateEnum
func GetMappingKeyVersionLifecycleStateEnum(val string) (KeyVersionLifecycleStateEnum, bool)
GetMappingKeyVersionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
KeyVersionOriginEnum Enum with underlying type: string
type KeyVersionOriginEnum string
Set of constants representing the allowable values for KeyVersionOriginEnum
const (
KeyVersionOriginInternal KeyVersionOriginEnum = "INTERNAL"
KeyVersionOriginExternal KeyVersionOriginEnum = "EXTERNAL"
)
func GetKeyVersionOriginEnumValues() []KeyVersionOriginEnum
GetKeyVersionOriginEnumValues Enumerates the set of values for KeyVersionOriginEnum
func GetMappingKeyVersionOriginEnum(val string) (KeyVersionOriginEnum, bool)
GetMappingKeyVersionOriginEnum performs case Insensitive comparison on enum value and return the desired enum
KeyVersionReplicaDetails KeyVersion replica details
type KeyVersionReplicaDetails struct {
// ReplicationId associated with a key version operation
ReplicationId *string `mandatory:"false" json:"replicationId"`
}
func (m KeyVersionReplicaDetails) String() string
func (m KeyVersionReplicaDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyVersionSummary The details of the KeyVersion.
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"`
ExternalKeyReferenceDetails *ExternalKeyReferenceDetails `mandatory:"false" json:"externalKeyReferenceDetails"`
// An optional property indicating whether this keyversion is generated from auto rotatation.
IsAutoRotated *bool `mandatory:"false" json:"isAutoRotated"`
}
func (m KeyVersionSummary) String() string
func (m KeyVersionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KeyVersionSummaryLifecycleStateEnum Enum with underlying type: string
type KeyVersionSummaryLifecycleStateEnum string
Set of constants representing the allowable values for KeyVersionSummaryLifecycleStateEnum
const (
KeyVersionSummaryLifecycleStateCreating KeyVersionSummaryLifecycleStateEnum = "CREATING"
KeyVersionSummaryLifecycleStateEnabling KeyVersionSummaryLifecycleStateEnum = "ENABLING"
KeyVersionSummaryLifecycleStateEnabled KeyVersionSummaryLifecycleStateEnum = "ENABLED"
KeyVersionSummaryLifecycleStateDisabling KeyVersionSummaryLifecycleStateEnum = "DISABLING"
KeyVersionSummaryLifecycleStateDisabled KeyVersionSummaryLifecycleStateEnum = "DISABLED"
KeyVersionSummaryLifecycleStateDeleting KeyVersionSummaryLifecycleStateEnum = "DELETING"
KeyVersionSummaryLifecycleStateDeleted KeyVersionSummaryLifecycleStateEnum = "DELETED"
KeyVersionSummaryLifecycleStatePendingDeletion KeyVersionSummaryLifecycleStateEnum = "PENDING_DELETION"
KeyVersionSummaryLifecycleStateSchedulingDeletion KeyVersionSummaryLifecycleStateEnum = "SCHEDULING_DELETION"
KeyVersionSummaryLifecycleStateCancellingDeletion KeyVersionSummaryLifecycleStateEnum = "CANCELLING_DELETION"
)
func GetKeyVersionSummaryLifecycleStateEnumValues() []KeyVersionSummaryLifecycleStateEnum
GetKeyVersionSummaryLifecycleStateEnumValues Enumerates the set of values for KeyVersionSummaryLifecycleStateEnum
func GetMappingKeyVersionSummaryLifecycleStateEnum(val string) (KeyVersionSummaryLifecycleStateEnum, bool)
GetMappingKeyVersionSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
KeyVersionSummaryOriginEnum Enum with underlying type: string
type KeyVersionSummaryOriginEnum string
Set of constants representing the allowable values for KeyVersionSummaryOriginEnum
const (
KeyVersionSummaryOriginInternal KeyVersionSummaryOriginEnum = "INTERNAL"
KeyVersionSummaryOriginExternal KeyVersionSummaryOriginEnum = "EXTERNAL"
)
func GetKeyVersionSummaryOriginEnumValues() []KeyVersionSummaryOriginEnum
GetKeyVersionSummaryOriginEnumValues Enumerates the set of values for KeyVersionSummaryOriginEnum
func GetMappingKeyVersionSummaryOriginEnum(val string) (KeyVersionSummaryOriginEnum, bool)
GetMappingKeyVersionSummaryOriginEnum performs case Insensitive comparison on enum value and return the desired enum
KmsCryptoClient a client for KmsCrypto
type KmsCryptoClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client *KmsCryptoClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client KmsCryptoClient) Decrypt(ctx context.Context, request DecryptRequest) (response DecryptResponse, err error)
Decrypt Decrypts data using the given DecryptDataDetails (https://docs.oracle.com/iaas/api/#/en/key/latest/datatypes/DecryptDataDetails) resource.
Click https://docs.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 (client KmsCryptoClient) Encrypt(ctx context.Context, request EncryptRequest) (response EncryptResponse, err error)
Encrypt Encrypts data using the given EncryptDataDetails (https://docs.oracle.com/iaas/api/#/en/key/latest/datatypes/EncryptDataDetails) resource. Plaintext included in the example request is a base64-encoded value of a UTF-8 string.
Click https://docs.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 (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. This operation is not supported for keys having protection mode `EXTERNAL`.
Click https://docs.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 (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.
Click https://docs.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 (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 of a public-private key pair, also known as an asymmetric key. To verify the generated signature, you can use the Verify (https://docs.oracle.com/iaas/api/#/en/key/latest/VerifiedData/Verify) operation. Or, if you want to validate the signature outside of the service, you can do so by using the public key of the same asymmetric key. This operation is not supported for keys having protection mode `EXTERNAL`.
Click https://docs.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 (client KmsCryptoClient) Verify(ctx context.Context, request VerifyRequest) (response VerifyResponse, err error)
Verify Verifies a digital signature that was generated by the Sign (https://docs.oracle.com/iaas/api/#/en/key/latest/SignedData/Sign) operation by using the public key of the same asymmetric key that was used to sign the data. If you want to validate the digital signature outside of the service, you can do so by using the public key of the asymmetric key. This operation is not supported for keys having protection mode `EXTERNAL`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/Verify.go.html to see an example of how to use Verify API.
KmsHsmClusterClient a client for KmsHsmCluster
type KmsHsmClusterClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewKmsHsmClusterClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client KmsHsmClusterClient, err error)
NewKmsHsmClusterClientWithConfigurationProvider Creates a new default KmsHsmCluster client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewKmsHsmClusterClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client KmsHsmClusterClient, err error)
NewKmsHsmClusterClientWithOboToken Creates a new default KmsHsmCluster 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 (client KmsHsmClusterClient) CancelHsmClusterDeletion(ctx context.Context, request CancelHsmClusterDeletionRequest) (response CancelHsmClusterDeletionResponse, err error)
CancelHsmClusterDeletion Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CancelHsmClusterDeletion.go.html to see an example of how to use CancelHsmClusterDeletion API.
func (client KmsHsmClusterClient) ChangeHsmClusterCompartment(ctx context.Context, request ChangeHsmClusterCompartmentRequest) (response ChangeHsmClusterCompartmentResponse, err error)
ChangeHsmClusterCompartment Moves a HSM Cluster resource to a different compartment within the same tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ChangeHsmClusterCompartment.go.html to see an example of how to use ChangeHsmClusterCompartment API.
func (client *KmsHsmClusterClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client KmsHsmClusterClient) CreateHsmCluster(ctx context.Context, request CreateHsmClusterRequest) (response CreateHsmClusterResponse, err error)
CreateHsmCluster Creates a new HSM cluster resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateHsmCluster.go.html to see an example of how to use CreateHsmCluster API.
func (client KmsHsmClusterClient) DownloadCertificateSigningRequest(ctx context.Context, request DownloadCertificateSigningRequestRequest) (response DownloadCertificateSigningRequestResponse, err error)
DownloadCertificateSigningRequest Retrieves the certificate signing request for the designated HSM Cluster resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/DownloadCertificateSigningRequest.go.html to see an example of how to use DownloadCertificateSigningRequest API.
func (client KmsHsmClusterClient) GetHsmCluster(ctx context.Context, request GetHsmClusterRequest) (response GetHsmClusterResponse, err error)
GetHsmCluster Retrieves configuration details for the specified HSM Cluster 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 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetHsmCluster.go.html to see an example of how to use GetHsmCluster API.
func (client KmsHsmClusterClient) GetHsmPartition(ctx context.Context, request GetHsmPartitionRequest) (response GetHsmPartitionResponse, err error)
GetHsmPartition Retrieves HSM partition details for the specified HSM cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetHsmPartition.go.html to see an example of how to use GetHsmPartition API.
func (client KmsHsmClusterClient) GetPreCoUserCredentials(ctx context.Context, request GetPreCoUserCredentialsRequest) (response GetPreCoUserCredentialsResponse, err error)
GetPreCoUserCredentials Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetPreCoUserCredentials.go.html to see an example of how to use GetPreCoUserCredentials API.
func (client KmsHsmClusterClient) ListHsmClusters(ctx context.Context, request ListHsmClustersRequest) (response ListHsmClustersResponse, err error)
ListHsmClusters Lists all HSM cluster resources contained within 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListHsmClusters.go.html to see an example of how to use ListHsmClusters API.
func (client KmsHsmClusterClient) ListHsmPartitions(ctx context.Context, request ListHsmPartitionsRequest) (response ListHsmPartitionsResponse, err error)
ListHsmPartitions Lists all HSM partitions within the specified HSM Cluster resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListHsmPartitions.go.html to see an example of how to use ListHsmPartitions API.
func (client KmsHsmClusterClient) ScheduleHsmClusterDeletion(ctx context.Context, request ScheduleHsmClusterDeletionRequest) (response ScheduleHsmClusterDeletionResponse, err error)
ScheduleHsmClusterDeletion Schedules HSM cluster for deletion, update its lifecycle state to 'PENDING_DELETION' and deletes it after the retention period.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ScheduleHsmClusterDeletion.go.html to see an example of how to use ScheduleHsmClusterDeletion API.
func (client *KmsHsmClusterClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client KmsHsmClusterClient) UpdateHsmCluster(ctx context.Context, request UpdateHsmClusterRequest) (response UpdateHsmClusterResponse, err error)
UpdateHsmCluster Modifies properties of an HSM cluster resource, including `displayName`, `freeformTags` and `definedTags`. 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateHsmCluster.go.html to see an example of how to use UpdateHsmCluster API.
func (client KmsHsmClusterClient) UploadPartitionCertificates(ctx context.Context, request UploadPartitionCertificatesRequest) (response UploadPartitionCertificatesResponse, err error)
UploadPartitionCertificates Uploads the partition owner certificates to the HSM Cluster resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UploadPartitionCertificates.go.html to see an example of how to use UploadPartitionCertificates API.
KmsManagementClient a client for KmsManagement
type KmsManagementClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.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.
Click https://docs.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 (client *KmsManagementClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
Click https://docs.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 (client KmsManagementClient) CreateKeyVersion(ctx context.Context, request CreateKeyVersionRequest) (response CreateKeyVersionResponse, err error)
CreateKeyVersion Generates a new KeyVersion (https://docs.oracle.com/iaas/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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client KmsManagementClient) GetReplicationStatus(ctx context.Context, request GetReplicationStatusRequest) (response GetReplicationStatusResponse, err error)
GetReplicationStatus When a vault has a replica, each operation on the vault or its resources, such as keys, is replicated and has an associated replicationId. Replication status provides details about whether the operation associated with the given replicationId has been successfully applied across replicas.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/GetReplicationStatus.go.html to see an example of how to use GetReplicationStatus API.
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.
Click https://docs.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 (client KmsManagementClient) ImportKey(ctx context.Context, request ImportKeyRequest) (response ImportKeyResponse, err error)
ImportKey Imports AES and RSA keys to create a new key. 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 both RSA and AES keys. The AES keys are symmetric keys of length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). Furthermore, the key length must match what you specify at the time of import. When importing an asymmetric key, only private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.
Click https://docs.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 (client KmsManagementClient) ImportKeyVersion(ctx context.Context, request ImportKeyVersionRequest) (response ImportKeyVersionResponse, err error)
ImportKeyVersion Imports AES key material to create a new key version and then rotate 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. When importing an asymmetric key, only the private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.
Click https://docs.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 (client KmsManagementClient) ListKeyVersions(ctx context.Context, request ListKeyVersionsRequest) (response ListKeyVersionsResponse, err error)
ListKeyVersions Lists all KeyVersion (https://docs.oracle.com/iaas/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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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 be 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateKey.go.html to see an example of how to use UpdateKey API.
KmsVaultClient a client for KmsVault
type KmsVaultClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.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.
Click https://docs.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 (client *KmsVaultClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
Click https://docs.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 (client KmsVaultClient) CreateVaultReplica(ctx context.Context, request CreateVaultReplicaRequest) (response CreateVaultReplicaResponse, err error)
CreateVaultReplica Creates a replica for the vault in another region in the same realm The API is a no-op if called for same region that a vault is already replicated to. 409 if called on a vault that is already replicated to a different region. Users need to delete existing replica first before calling it with a different region. 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/CreateVaultReplica.go.html to see an example of how to use CreateVaultReplica API.
func (client KmsVaultClient) DeleteVaultReplica(ctx context.Context, request DeleteVaultReplicaRequest) (response DeleteVaultReplicaResponse, err error)
DeleteVaultReplica Deletes a vault replica 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/DeleteVaultReplica.go.html to see an example of how to use DeleteVaultReplica API.
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.
Click https://docs.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 (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.
Click https://docs.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 (client KmsVaultClient) ListVaultReplicas(ctx context.Context, request ListVaultReplicasRequest) (response ListVaultReplicasResponse, err error)
ListVaultReplicas Lists the replicas for a vault 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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListVaultReplicas.go.html to see an example of how to use ListVaultReplicas API.
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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client *KmsVaultClient) SetRegion(region string)
SetRegion overrides the region of this client.
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateVault.go.html to see an example of how to use UpdateVault API.
ListEkmsPrivateEndpointsRequest wrapper for the ListEkmsPrivateEndpoints operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListEkmsPrivateEndpoints.go.html to see an example of how to use ListEkmsPrivateEndpointsRequest.
type ListEkmsPrivateEndpointsRequest 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"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListEkmsPrivateEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListEkmsPrivateEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListEkmsPrivateEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEkmsPrivateEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEkmsPrivateEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEkmsPrivateEndpointsRequest) String() string
func (request ListEkmsPrivateEndpointsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListEkmsPrivateEndpointsResponse wrapper for the ListEkmsPrivateEndpoints operation
type ListEkmsPrivateEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []EkmsPrivateEndpointSummary instances
Items []EkmsPrivateEndpointSummary `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListEkmsPrivateEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEkmsPrivateEndpointsResponse) String() string
ListEkmsPrivateEndpointsSortByEnum Enum with underlying type: string
type ListEkmsPrivateEndpointsSortByEnum string
Set of constants representing the allowable values for ListEkmsPrivateEndpointsSortByEnum
const (
ListEkmsPrivateEndpointsSortByTimecreated ListEkmsPrivateEndpointsSortByEnum = "TIMECREATED"
ListEkmsPrivateEndpointsSortByDisplayname ListEkmsPrivateEndpointsSortByEnum = "DISPLAYNAME"
)
func GetListEkmsPrivateEndpointsSortByEnumValues() []ListEkmsPrivateEndpointsSortByEnum
GetListEkmsPrivateEndpointsSortByEnumValues Enumerates the set of values for ListEkmsPrivateEndpointsSortByEnum
func GetMappingListEkmsPrivateEndpointsSortByEnum(val string) (ListEkmsPrivateEndpointsSortByEnum, bool)
GetMappingListEkmsPrivateEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEkmsPrivateEndpointsSortOrderEnum Enum with underlying type: string
type ListEkmsPrivateEndpointsSortOrderEnum string
Set of constants representing the allowable values for ListEkmsPrivateEndpointsSortOrderEnum
const (
ListEkmsPrivateEndpointsSortOrderAsc ListEkmsPrivateEndpointsSortOrderEnum = "ASC"
ListEkmsPrivateEndpointsSortOrderDesc ListEkmsPrivateEndpointsSortOrderEnum = "DESC"
)
func GetListEkmsPrivateEndpointsSortOrderEnumValues() []ListEkmsPrivateEndpointsSortOrderEnum
GetListEkmsPrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListEkmsPrivateEndpointsSortOrderEnum
func GetMappingListEkmsPrivateEndpointsSortOrderEnum(val string) (ListEkmsPrivateEndpointsSortOrderEnum, bool)
GetMappingListEkmsPrivateEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListHsmClustersRequest wrapper for the ListHsmClusters operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListHsmClusters.go.html to see an example of how to use ListHsmClustersRequest.
type ListHsmClustersRequest 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 ListHsmClustersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListHsmClustersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListHsmClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHsmClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHsmClustersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHsmClustersRequest) String() string
func (request ListHsmClustersRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListHsmClustersResponse wrapper for the ListHsmClusters operation
type ListHsmClustersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of HsmClusterCollection instances
HsmClusterCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListHsmClustersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHsmClustersResponse) String() string
ListHsmClustersSortByEnum Enum with underlying type: string
type ListHsmClustersSortByEnum string
Set of constants representing the allowable values for ListHsmClustersSortByEnum
const (
ListHsmClustersSortByTimecreated ListHsmClustersSortByEnum = "TIMECREATED"
ListHsmClustersSortByDisplayname ListHsmClustersSortByEnum = "DISPLAYNAME"
)
func GetListHsmClustersSortByEnumValues() []ListHsmClustersSortByEnum
GetListHsmClustersSortByEnumValues Enumerates the set of values for ListHsmClustersSortByEnum
func GetMappingListHsmClustersSortByEnum(val string) (ListHsmClustersSortByEnum, bool)
GetMappingListHsmClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListHsmClustersSortOrderEnum Enum with underlying type: string
type ListHsmClustersSortOrderEnum string
Set of constants representing the allowable values for ListHsmClustersSortOrderEnum
const (
ListHsmClustersSortOrderAsc ListHsmClustersSortOrderEnum = "ASC"
ListHsmClustersSortOrderDesc ListHsmClustersSortOrderEnum = "DESC"
)
func GetListHsmClustersSortOrderEnumValues() []ListHsmClustersSortOrderEnum
GetListHsmClustersSortOrderEnumValues Enumerates the set of values for ListHsmClustersSortOrderEnum
func GetMappingListHsmClustersSortOrderEnum(val string) (ListHsmClustersSortOrderEnum, bool)
GetMappingListHsmClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListHsmPartitionsRequest wrapper for the ListHsmPartitions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListHsmPartitions.go.html to see an example of how to use ListHsmPartitionsRequest.
type ListHsmPartitionsRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// 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 ListHsmPartitionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListHsmPartitionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.
LifecycleState HsmPartitionLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListHsmPartitionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListHsmPartitionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListHsmPartitionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListHsmPartitionsRequest) String() string
func (request ListHsmPartitionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListHsmPartitionsResponse wrapper for the ListHsmPartitions operation
type ListHsmPartitionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of HsmPartitionCollection instances
HsmPartitionCollection `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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListHsmPartitionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListHsmPartitionsResponse) String() string
ListHsmPartitionsSortByEnum Enum with underlying type: string
type ListHsmPartitionsSortByEnum string
Set of constants representing the allowable values for ListHsmPartitionsSortByEnum
const (
ListHsmPartitionsSortByTimecreated ListHsmPartitionsSortByEnum = "TIMECREATED"
ListHsmPartitionsSortByDisplayname ListHsmPartitionsSortByEnum = "DISPLAYNAME"
)
func GetListHsmPartitionsSortByEnumValues() []ListHsmPartitionsSortByEnum
GetListHsmPartitionsSortByEnumValues Enumerates the set of values for ListHsmPartitionsSortByEnum
func GetMappingListHsmPartitionsSortByEnum(val string) (ListHsmPartitionsSortByEnum, bool)
GetMappingListHsmPartitionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListHsmPartitionsSortOrderEnum Enum with underlying type: string
type ListHsmPartitionsSortOrderEnum string
Set of constants representing the allowable values for ListHsmPartitionsSortOrderEnum
const (
ListHsmPartitionsSortOrderAsc ListHsmPartitionsSortOrderEnum = "ASC"
ListHsmPartitionsSortOrderDesc ListHsmPartitionsSortOrderEnum = "DESC"
)
func GetListHsmPartitionsSortOrderEnumValues() []ListHsmPartitionsSortOrderEnum
GetListHsmPartitionsSortOrderEnumValues Enumerates the set of values for ListHsmPartitionsSortOrderEnum
func GetMappingListHsmPartitionsSortOrderEnum(val string) (ListHsmPartitionsSortOrderEnum, bool)
GetMappingListHsmPartitionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListKeyVersionsRequest wrapper for the ListKeyVersions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListKeyVersions.go.html to see an example of how to use ListKeyVersionsRequest.
type ListKeyVersionsRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header
// from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The field to sort by. You can specify only one sort order. The default
// order for `TIMECREATED` is descending. The default order for `DISPLAYNAME`
// is ascending.
SortBy ListKeyVersionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListKeyVersionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListKeyVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListKeyVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListKeyVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListKeyVersionsRequest) String() string
func (request ListKeyVersionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListKeyVersionsResponse wrapper for the ListKeyVersions operation
type ListKeyVersionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []KeyVersionSummary instances
Items []KeyVersionSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then there are additional items still to get. Include this value as the `page` parameter for the
// subsequent GET request. For information about pagination, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListKeyVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListKeyVersionsResponse) String() string
ListKeyVersionsSortByEnum Enum with underlying type: string
type ListKeyVersionsSortByEnum string
Set of constants representing the allowable values for ListKeyVersionsSortByEnum
const (
ListKeyVersionsSortByTimecreated ListKeyVersionsSortByEnum = "TIMECREATED"
ListKeyVersionsSortByDisplayname ListKeyVersionsSortByEnum = "DISPLAYNAME"
)
func GetListKeyVersionsSortByEnumValues() []ListKeyVersionsSortByEnum
GetListKeyVersionsSortByEnumValues Enumerates the set of values for ListKeyVersionsSortByEnum
func GetMappingListKeyVersionsSortByEnum(val string) (ListKeyVersionsSortByEnum, bool)
GetMappingListKeyVersionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListKeyVersionsSortOrderEnum Enum with underlying type: string
type ListKeyVersionsSortOrderEnum string
Set of constants representing the allowable values for ListKeyVersionsSortOrderEnum
const (
ListKeyVersionsSortOrderAsc ListKeyVersionsSortOrderEnum = "ASC"
ListKeyVersionsSortOrderDesc ListKeyVersionsSortOrderEnum = "DESC"
)
func GetListKeyVersionsSortOrderEnumValues() []ListKeyVersionsSortOrderEnum
GetListKeyVersionsSortOrderEnumValues Enumerates the set of values for ListKeyVersionsSortOrderEnum
func GetMappingListKeyVersionsSortOrderEnum(val string) (ListKeyVersionsSortOrderEnum, bool)
GetMappingListKeyVersionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListKeysAlgorithmEnum Enum with underlying type: string
type ListKeysAlgorithmEnum string
Set of constants representing the allowable values for ListKeysAlgorithmEnum
const (
ListKeysAlgorithmAes ListKeysAlgorithmEnum = "AES"
ListKeysAlgorithmRsa ListKeysAlgorithmEnum = "RSA"
ListKeysAlgorithmEcdsa ListKeysAlgorithmEnum = "ECDSA"
)
func GetListKeysAlgorithmEnumValues() []ListKeysAlgorithmEnum
GetListKeysAlgorithmEnumValues Enumerates the set of values for ListKeysAlgorithmEnum
func GetMappingListKeysAlgorithmEnum(val string) (ListKeysAlgorithmEnum, bool)
GetMappingListKeysAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
ListKeysCurveIdEnum Enum with underlying type: string
type ListKeysCurveIdEnum string
Set of constants representing the allowable values for ListKeysCurveIdEnum
const (
ListKeysCurveIdP256 ListKeysCurveIdEnum = "NIST_P256"
ListKeysCurveIdP384 ListKeysCurveIdEnum = "NIST_P384"
ListKeysCurveIdP521 ListKeysCurveIdEnum = "NIST_P521"
)
func GetListKeysCurveIdEnumValues() []ListKeysCurveIdEnum
GetListKeysCurveIdEnumValues Enumerates the set of values for ListKeysCurveIdEnum
func GetMappingListKeysCurveIdEnum(val string) (ListKeysCurveIdEnum, bool)
GetMappingListKeysCurveIdEnum performs case Insensitive comparison on enum value and return the desired enum
ListKeysProtectionModeEnum Enum with underlying type: string
type ListKeysProtectionModeEnum string
Set of constants representing the allowable values for ListKeysProtectionModeEnum
const (
ListKeysProtectionModeHsm ListKeysProtectionModeEnum = "HSM"
ListKeysProtectionModeSoftware ListKeysProtectionModeEnum = "SOFTWARE"
ListKeysProtectionModeExternal ListKeysProtectionModeEnum = "EXTERNAL"
)
func GetListKeysProtectionModeEnumValues() []ListKeysProtectionModeEnum
GetListKeysProtectionModeEnumValues Enumerates the set of values for ListKeysProtectionModeEnum
func GetMappingListKeysProtectionModeEnum(val string) (ListKeysProtectionModeEnum, bool)
GetMappingListKeysProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum
ListKeysRequest wrapper for the ListKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListKeys.go.html to see an example of how to use ListKeysRequest.
type ListKeysRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header
// from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The field to sort by. You can specify only one sort order. The default
// order for `TIMECREATED` is descending. The default order for `DISPLAYNAME`
// is ascending.
SortBy ListKeysSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListKeysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// A key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A
// protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are
// performed inside the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's
// RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of
// `SOFTWARE` are performed on the server.
// A protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle.
// Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager.
ProtectionMode ListKeysProtectionModeEnum `mandatory:"false" contributesTo:"query" name:"protectionMode" omitEmpty:"true"`
// The algorithm used by a key's key versions to encrypt or decrypt data. Currently, support includes AES, RSA, and ECDSA algorithms.
Algorithm ListKeysAlgorithmEnum `mandatory:"false" contributesTo:"query" name:"algorithm" omitEmpty:"true"`
// The length of the key in bytes, expressed as an integer. Supported values include 16, 24, or 32.
Length *int `mandatory:"false" contributesTo:"query" name:"length"`
// The curve ID of the keys. (This pertains only to ECDSA keys.)
CurveId ListKeysCurveIdEnum `mandatory:"false" contributesTo:"query" name:"curveId" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListKeysRequest) String() string
func (request ListKeysRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListKeysResponse wrapper for the ListKeys operation
type ListKeysResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []KeySummary instances
Items []KeySummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then there are additional items still to get. Include this value as the `page` parameter for the
// subsequent GET request. For information about pagination, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListKeysResponse) String() string
ListKeysSortByEnum Enum with underlying type: string
type ListKeysSortByEnum string
Set of constants representing the allowable values for ListKeysSortByEnum
const (
ListKeysSortByTimecreated ListKeysSortByEnum = "TIMECREATED"
ListKeysSortByDisplayname ListKeysSortByEnum = "DISPLAYNAME"
)
func GetListKeysSortByEnumValues() []ListKeysSortByEnum
GetListKeysSortByEnumValues Enumerates the set of values for ListKeysSortByEnum
func GetMappingListKeysSortByEnum(val string) (ListKeysSortByEnum, bool)
GetMappingListKeysSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListKeysSortOrderEnum Enum with underlying type: string
type ListKeysSortOrderEnum string
Set of constants representing the allowable values for ListKeysSortOrderEnum
const (
ListKeysSortOrderAsc ListKeysSortOrderEnum = "ASC"
ListKeysSortOrderDesc ListKeysSortOrderEnum = "DESC"
)
func GetListKeysSortOrderEnumValues() []ListKeysSortOrderEnum
GetListKeysSortOrderEnumValues Enumerates the set of values for ListKeysSortOrderEnum
func GetMappingListKeysSortOrderEnum(val string) (ListKeysSortOrderEnum, bool)
GetMappingListKeysSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListVaultReplicasRequest wrapper for the ListVaultReplicas operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListVaultReplicas.go.html to see an example of how to use ListVaultReplicasRequest.
type ListVaultReplicasRequest 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"`
// 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"`
// 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"`
// 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 ListVaultReplicasSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListVaultReplicasSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListVaultReplicasRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVaultReplicasRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVaultReplicasRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVaultReplicasRequest) String() string
func (request ListVaultReplicasRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListVaultReplicasResponse wrapper for the ListVaultReplicas operation
type ListVaultReplicasResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []VaultReplicaSummary instances
Items []VaultReplicaSummary `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// 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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListVaultReplicasResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVaultReplicasResponse) String() string
ListVaultReplicasSortByEnum Enum with underlying type: string
type ListVaultReplicasSortByEnum string
Set of constants representing the allowable values for ListVaultReplicasSortByEnum
const (
ListVaultReplicasSortByTimecreated ListVaultReplicasSortByEnum = "TIMECREATED"
ListVaultReplicasSortByDisplayname ListVaultReplicasSortByEnum = "DISPLAYNAME"
)
func GetListVaultReplicasSortByEnumValues() []ListVaultReplicasSortByEnum
GetListVaultReplicasSortByEnumValues Enumerates the set of values for ListVaultReplicasSortByEnum
func GetMappingListVaultReplicasSortByEnum(val string) (ListVaultReplicasSortByEnum, bool)
GetMappingListVaultReplicasSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListVaultReplicasSortOrderEnum Enum with underlying type: string
type ListVaultReplicasSortOrderEnum string
Set of constants representing the allowable values for ListVaultReplicasSortOrderEnum
const (
ListVaultReplicasSortOrderAsc ListVaultReplicasSortOrderEnum = "ASC"
ListVaultReplicasSortOrderDesc ListVaultReplicasSortOrderEnum = "DESC"
)
func GetListVaultReplicasSortOrderEnumValues() []ListVaultReplicasSortOrderEnum
GetListVaultReplicasSortOrderEnumValues Enumerates the set of values for ListVaultReplicasSortOrderEnum
func GetMappingListVaultReplicasSortOrderEnum(val string) (ListVaultReplicasSortOrderEnum, bool)
GetMappingListVaultReplicasSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListVaultsRequest wrapper for the ListVaults operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ListVaults.go.html to see an example of how to use ListVaultsRequest.
type ListVaultsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header
// from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The field to sort by. You can specify only one sort order. The default
// order for `TIMECREATED` is descending. The default order for `DISPLAYNAME`
// is ascending.
SortBy ListVaultsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListVaultsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListVaultsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListVaultsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListVaultsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListVaultsRequest) String() string
func (request ListVaultsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListVaultsResponse wrapper for the ListVaults operation
type ListVaultsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []VaultSummary instances
Items []VaultSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then there are additional items still to get. Include this value as the `page` parameter for the
// subsequent GET request. For information about pagination, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListVaultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListVaultsResponse) String() string
ListVaultsSortByEnum Enum with underlying type: string
type ListVaultsSortByEnum string
Set of constants representing the allowable values for ListVaultsSortByEnum
const (
ListVaultsSortByTimecreated ListVaultsSortByEnum = "TIMECREATED"
ListVaultsSortByDisplayname ListVaultsSortByEnum = "DISPLAYNAME"
)
func GetListVaultsSortByEnumValues() []ListVaultsSortByEnum
GetListVaultsSortByEnumValues Enumerates the set of values for ListVaultsSortByEnum
func GetMappingListVaultsSortByEnum(val string) (ListVaultsSortByEnum, bool)
GetMappingListVaultsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListVaultsSortOrderEnum Enum with underlying type: string
type ListVaultsSortOrderEnum string
Set of constants representing the allowable values for ListVaultsSortOrderEnum
const (
ListVaultsSortOrderAsc ListVaultsSortOrderEnum = "ASC"
ListVaultsSortOrderDesc ListVaultsSortOrderEnum = "DESC"
)
func GetListVaultsSortOrderEnumValues() []ListVaultsSortOrderEnum
GetListVaultsSortOrderEnumValues Enumerates the set of values for ListVaultsSortOrderEnum
func GetMappingListVaultsSortOrderEnum(val string) (ListVaultsSortOrderEnum, bool)
GetMappingListVaultsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
OauthMetadata Authorization details required to get access token from IDP for accessing protected resources.
type OauthMetadata struct {
// Base URL of the IDCS account where confidential client app is created.
IdcsAccountNameUrl *string `mandatory:"true" json:"idcsAccountNameUrl"`
// ID of the client app created in IDP.
ClientAppId *string `mandatory:"true" json:"clientAppId"`
// Secret of the client app created in IDP.
ClientAppSecret *string `mandatory:"true" json:"clientAppSecret"`
}
func (m OauthMetadata) String() string
func (m OauthMetadata) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OauthMetadataSummary Summary about authorization to be returned to the customer as a response.
type OauthMetadataSummary struct {
// Base URL of the IDCS account where confidential client app is created.
IdcsAccountNameUrl *string `mandatory:"true" json:"idcsAccountNameUrl"`
// ID of the client app created in IDP.
ClientAppId *string `mandatory:"true" json:"clientAppId"`
}
func (m OauthMetadataSummary) String() string
func (m OauthMetadataSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PortInformation Details of a single portInformation item include the PortNumber (an integer used as an identifier) and the PortType (this refers to either an enum value of Management Utility, Client Utility, or null)
type PortInformation struct {
// The port number is a unique identifier which is typically used as the loadbalancer listener.
PortNumber *int `mandatory:"true" json:"portNumber"`
// Port type associated for the port number. The two port type enums are `CLIENTUTILITY` and `MANAGEMENTUTILITY`. The CLIENTUTILITY enum corresponds to a port which is used by the client daemon. The MANAGEMENTUTILITY enum corresponds to a port used by user management utility.
PortType PortInformationPortTypeEnum `mandatory:"true" json:"portType"`
}
func (m PortInformation) String() string
func (m PortInformation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PortInformationPortTypeEnum Enum with underlying type: string
type PortInformationPortTypeEnum string
Set of constants representing the allowable values for PortInformationPortTypeEnum
const (
PortInformationPortTypeClientutility PortInformationPortTypeEnum = "CLIENTUTILITY"
PortInformationPortTypeManagementutility PortInformationPortTypeEnum = "MANAGEMENTUTILITY"
)
func GetMappingPortInformationPortTypeEnum(val string) (PortInformationPortTypeEnum, bool)
GetMappingPortInformationPortTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPortInformationPortTypeEnumValues() []PortInformationPortTypeEnum
GetPortInformationPortTypeEnumValues Enumerates the set of values for PortInformationPortTypeEnum
PreCoUserCredentials Pre Crypto officer user credentials.
type PreCoUserCredentials struct {
// The pre crypto officer username, which should be chosen as a non confidential string.
Username *string `mandatory:"true" json:"username"`
// The base 64 encoded pre crypto officer password.
Password *string `mandatory:"true" json:"password"`
}
func (m PreCoUserCredentials) String() string
func (m PreCoUserCredentials) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ReplicaDetails Details of replication status
type ReplicaDetails struct {
// The replica region
Region *string `mandatory:"false" json:"region"`
// Replication status associated with a replicationId
Status ReplicaDetailsStatusEnum `mandatory:"false" json:"status,omitempty"`
}
func (m ReplicaDetails) String() string
func (m ReplicaDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ReplicaDetailsStatusEnum Enum with underlying type: string
type ReplicaDetailsStatusEnum string
Set of constants representing the allowable values for ReplicaDetailsStatusEnum
const (
ReplicaDetailsStatusReplicating ReplicaDetailsStatusEnum = "REPLICATING"
ReplicaDetailsStatusReplicated ReplicaDetailsStatusEnum = "REPLICATED"
)
func GetMappingReplicaDetailsStatusEnum(val string) (ReplicaDetailsStatusEnum, bool)
GetMappingReplicaDetailsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetReplicaDetailsStatusEnumValues() []ReplicaDetailsStatusEnum
GetReplicaDetailsStatusEnumValues Enumerates the set of values for ReplicaDetailsStatusEnum
ReplicationStatusDetails Details of replication status across all replica regions
type ReplicationStatusDetails struct {
// Replica Details.
ReplicaDetails []ReplicaDetails `mandatory:"false" json:"replicaDetails"`
}
func (m ReplicationStatusDetails) String() string
func (m ReplicationStatusDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreKeyFromFileRequest wrapper for the RestoreKeyFromFile operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/RestoreKeyFromFile.go.html to see an example of how to use RestoreKeyFromFileRequest.
type RestoreKeyFromFileRequest struct {
// The content length of the body.
ContentLength *int64 `mandatory:"false" contributesTo:"header" name:"content-length"`
// The encrypted backup file to upload to restore the key.
RestoreKeyFromFileDetails io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The base64-encoded MD5 hash value of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.15.
// If the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5
// hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and
// a response with 400 Unmatched Content MD5 error is returned, along with the message: "The computed MD5 of the request body (ACTUAL_MD5)
// does not match the Content-MD5 header (HEADER_MD5)."
ContentMd5 *string `mandatory:"false" contributesTo:"header" name:"content-md5"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RestoreKeyFromFileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestoreKeyFromFileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreKeyFromFileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreKeyFromFileRequest) String() string
func (request RestoreKeyFromFileRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreKeyFromFileResponse wrapper for the RestoreKeyFromFile operation
type RestoreKeyFromFileResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The base64-encoded MD5 hash value of the request body, as computed
// by the server.
OpcContentMd5 *string `presentIn:"header" name:"opc-content-md5"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the work request, used to track the progress of the
// restore operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response RestoreKeyFromFileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreKeyFromFileResponse) String() string
RestoreKeyFromObjectStoreDetails The details of the backup location from which you want to restore the Key.
type RestoreKeyFromObjectStoreDetails struct {
BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
}
func (m RestoreKeyFromObjectStoreDetails) String() string
func (m *RestoreKeyFromObjectStoreDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m RestoreKeyFromObjectStoreDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreKeyFromObjectStoreRequest wrapper for the RestoreKeyFromObjectStore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/RestoreKeyFromObjectStore.go.html to see an example of how to use RestoreKeyFromObjectStoreRequest.
type RestoreKeyFromObjectStoreRequest struct {
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Location to restore the backup from
RestoreKeyFromObjectStoreDetails `contributesTo:"body"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RestoreKeyFromObjectStoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestoreKeyFromObjectStoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreKeyFromObjectStoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreKeyFromObjectStoreRequest) String() string
func (request RestoreKeyFromObjectStoreRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreKeyFromObjectStoreResponse wrapper for the RestoreKeyFromObjectStore operation
type RestoreKeyFromObjectStoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the work request, used to track the progress of the
// restore operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response RestoreKeyFromObjectStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreKeyFromObjectStoreResponse) String() string
RestoreVaultFromFileRequest wrapper for the RestoreVaultFromFile operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/RestoreVaultFromFile.go.html to see an example of how to use RestoreVaultFromFileRequest.
type RestoreVaultFromFileRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The content length of the body.
ContentLength *int64 `mandatory:"false" contributesTo:"header" name:"content-length"`
// The encrypted backup file to upload to restore the vault.
RestoreVaultFromFileDetails io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The base64-encoded MD5 hash value of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.15.
// If the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5
// hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and
// a response with 400 Unmatched Content MD5 error is returned, along with the message: "The computed MD5 of the request body (ACTUAL_MD5)
// does not match the Content-MD5 header (HEADER_MD5)."
ContentMd5 *string `mandatory:"false" contributesTo:"header" name:"content-md5"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RestoreVaultFromFileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestoreVaultFromFileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreVaultFromFileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreVaultFromFileRequest) String() string
func (request RestoreVaultFromFileRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreVaultFromFileResponse wrapper for the RestoreVaultFromFile operation
type RestoreVaultFromFileResponse struct {
// The underlying http response
RawResponse *http.Response
// The Vault instance
Vault `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The base64-encoded MD5 hash value of the request body, as computed
// by the server.
OpcContentMd5 *string `presentIn:"header" name:"opc-content-md5"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the work request, used to track the progress of the
// restore operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response RestoreVaultFromFileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreVaultFromFileResponse) String() string
RestoreVaultFromObjectStoreDetails The details of the backup location from which you want to restore the Vault.
type RestoreVaultFromObjectStoreDetails struct {
BackupLocation BackupLocation `mandatory:"false" json:"backupLocation"`
}
func (m RestoreVaultFromObjectStoreDetails) String() string
func (m *RestoreVaultFromObjectStoreDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m RestoreVaultFromObjectStoreDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreVaultFromObjectStoreRequest wrapper for the RestoreVaultFromObjectStore operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/RestoreVaultFromObjectStore.go.html to see an example of how to use RestoreVaultFromObjectStoreRequest.
type RestoreVaultFromObjectStoreRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// RestoreVaultFromObjectStoreDetails
RestoreVaultFromObjectStoreDetails `contributesTo:"body"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RestoreVaultFromObjectStoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestoreVaultFromObjectStoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestoreVaultFromObjectStoreRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestoreVaultFromObjectStoreRequest) String() string
func (request RestoreVaultFromObjectStoreRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RestoreVaultFromObjectStoreResponse wrapper for the RestoreVaultFromObjectStore operation
type RestoreVaultFromObjectStoreResponse struct {
// The underlying http response
RawResponse *http.Response
// The Vault instance
Vault `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the work request, used to track the progress of the
// restore operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response RestoreVaultFromObjectStoreResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestoreVaultFromObjectStoreResponse) String() string
ScheduleHsmClusterDeletionDetails Details for scheduling HSM resource deletion.
type ScheduleHsmClusterDeletionDetails struct {
// An optional property indicating when to delete the HsmCluster resource, expressed in
// RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. The specified
// time must be between 7 and 30 days from the time when the request is received.
// If this property is missing, it will be set to 30 days from the time of the request
// by default.
TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}
func (m ScheduleHsmClusterDeletionDetails) String() string
func (m ScheduleHsmClusterDeletionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleHsmClusterDeletionRequest wrapper for the ScheduleHsmClusterDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ScheduleHsmClusterDeletion.go.html to see an example of how to use ScheduleHsmClusterDeletionRequest.
type ScheduleHsmClusterDeletionRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// Details of ScheduleHsmClusterDeletionDetails
ScheduleHsmClusterDeletionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ScheduleHsmClusterDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ScheduleHsmClusterDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScheduleHsmClusterDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScheduleHsmClusterDeletionRequest) String() string
func (request ScheduleHsmClusterDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleHsmClusterDeletionResponse wrapper for the ScheduleHsmClusterDeletion operation
type ScheduleHsmClusterDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// The HsmCluster instance
HsmCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ScheduleHsmClusterDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScheduleHsmClusterDeletionResponse) String() string
ScheduleKeyDeletionDetails Details for scheduling key deletion.
type ScheduleKeyDeletionDetails struct {
// An optional property to indicate when to delete the vault, expressed in
// RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. The specified
// time must be between 7 and 30 days from when the request is received.
// If this property is missing, it will be set to 30 days from the time of the request
// by default.
TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}
func (m ScheduleKeyDeletionDetails) String() string
func (m ScheduleKeyDeletionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleKeyDeletionRequest wrapper for the ScheduleKeyDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ScheduleKeyDeletion.go.html to see an example of how to use ScheduleKeyDeletionRequest.
type ScheduleKeyDeletionRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// ScheduleKeyDeletionDetails
ScheduleKeyDeletionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ScheduleKeyDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ScheduleKeyDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScheduleKeyDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScheduleKeyDeletionRequest) String() string
func (request ScheduleKeyDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleKeyDeletionResponse wrapper for the ScheduleKeyDeletion operation
type ScheduleKeyDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ScheduleKeyDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScheduleKeyDeletionResponse) String() string
ScheduleKeyVersionDeletionDetails Details for scheduling key version deletion.
type ScheduleKeyVersionDeletionDetails struct {
// An optional property to indicate when to delete the key version, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format. The specified time must be between 7 and 30 days from the time
// when the request is received. If this property is missing, it will be set to 30 days from the time of the request by default.
TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}
func (m ScheduleKeyVersionDeletionDetails) String() string
func (m ScheduleKeyVersionDeletionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleKeyVersionDeletionRequest wrapper for the ScheduleKeyVersionDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ScheduleKeyVersionDeletion.go.html to see an example of how to use ScheduleKeyVersionDeletionRequest.
type ScheduleKeyVersionDeletionRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// The OCID of the key version.
KeyVersionId *string `mandatory:"true" contributesTo:"path" name:"keyVersionId"`
// ScheduleKeyVersionDeletionDetails
ScheduleKeyVersionDeletionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ScheduleKeyVersionDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ScheduleKeyVersionDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScheduleKeyVersionDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScheduleKeyVersionDeletionRequest) String() string
func (request ScheduleKeyVersionDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleKeyVersionDeletionResponse wrapper for the ScheduleKeyVersionDeletion operation
type ScheduleKeyVersionDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// The KeyVersion instance
KeyVersion `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ScheduleKeyVersionDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScheduleKeyVersionDeletionResponse) String() string
ScheduleVaultDeletionDetails Details for scheduling vault deletion.
type ScheduleVaultDeletionDetails struct {
// An optional property indicating when to delete the vault, expressed in
// RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. The specified
// time must be between 7 and 30 days from the time when the request is received.
// If this property is missing, it will be set to 30 days from the time of the request
// by default.
TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}
func (m ScheduleVaultDeletionDetails) String() string
func (m ScheduleVaultDeletionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleVaultDeletionRequest wrapper for the ScheduleVaultDeletion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/ScheduleVaultDeletion.go.html to see an example of how to use ScheduleVaultDeletionRequest.
type ScheduleVaultDeletionRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// ScheduleVaultDeletionDetails
ScheduleVaultDeletionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case
// of a timeout or server error without risk of executing that same action
// again. Retry tokens expire after 24 hours, but can be invalidated
// before then due to conflicting operations (e.g., if a resource has been
// deleted and purged from the system, then a retry of the original
// creation request may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ScheduleVaultDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ScheduleVaultDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ScheduleVaultDeletionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ScheduleVaultDeletionRequest) String() string
func (request ScheduleVaultDeletionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ScheduleVaultDeletionResponse wrapper for the ScheduleVaultDeletion operation
type ScheduleVaultDeletionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Vault instance
Vault `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ScheduleVaultDeletionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ScheduleVaultDeletionResponse) String() string
SignDataDetails The details of the message that you want to sign.
type SignDataDetails struct {
// The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. 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 use to sign the message or message digest.
// For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with
// different hashing algorithms.
// For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms.
// When you pass a message digest for signing, ensure that you specify the same hashing algorithm
// as used when creating the message digest.
SigningAlgorithm SignDataDetailsSigningAlgorithmEnum `mandatory:"true" json:"signingAlgorithm"`
// The OCID of the key version 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"`
// Information that can be used to provide context for audit logging. It is a map that contains any additional
// data that you provide to include with audit logs, if audit logging is enabled.
LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`
}
func (m SignDataDetails) String() string
func (m SignDataDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SignDataDetailsMessageTypeEnum Enum with underlying type: string
type SignDataDetailsMessageTypeEnum string
Set of constants representing the allowable values for SignDataDetailsMessageTypeEnum
const (
SignDataDetailsMessageTypeRaw SignDataDetailsMessageTypeEnum = "RAW"
SignDataDetailsMessageTypeDigest SignDataDetailsMessageTypeEnum = "DIGEST"
)
func GetMappingSignDataDetailsMessageTypeEnum(val string) (SignDataDetailsMessageTypeEnum, bool)
GetMappingSignDataDetailsMessageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSignDataDetailsMessageTypeEnumValues() []SignDataDetailsMessageTypeEnum
GetSignDataDetailsMessageTypeEnumValues Enumerates the set of values for SignDataDetailsMessageTypeEnum
SignDataDetailsSigningAlgorithmEnum Enum with underlying type: string
type SignDataDetailsSigningAlgorithmEnum string
Set of constants representing the allowable values for SignDataDetailsSigningAlgorithmEnum
const (
SignDataDetailsSigningAlgorithmSha224RsaPkcsPss SignDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS_PSS"
SignDataDetailsSigningAlgorithmSha256RsaPkcsPss SignDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS_PSS"
SignDataDetailsSigningAlgorithmSha384RsaPkcsPss SignDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS_PSS"
SignDataDetailsSigningAlgorithmSha512RsaPkcsPss SignDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS_PSS"
SignDataDetailsSigningAlgorithmSha224RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS1_V1_5"
SignDataDetailsSigningAlgorithmSha256RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS1_V1_5"
SignDataDetailsSigningAlgorithmSha384RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS1_V1_5"
SignDataDetailsSigningAlgorithmSha512RsaPkcs1V15 SignDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS1_V1_5"
SignDataDetailsSigningAlgorithmEcdsaSha256 SignDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_256"
SignDataDetailsSigningAlgorithmEcdsaSha384 SignDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_384"
SignDataDetailsSigningAlgorithmEcdsaSha512 SignDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_512"
)
func GetMappingSignDataDetailsSigningAlgorithmEnum(val string) (SignDataDetailsSigningAlgorithmEnum, bool)
GetMappingSignDataDetailsSigningAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSignDataDetailsSigningAlgorithmEnumValues() []SignDataDetailsSigningAlgorithmEnum
GetSignDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for SignDataDetailsSigningAlgorithmEnum
SignRequest wrapper for the Sign operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/Sign.go.html to see an example of how to use SignRequest.
type SignRequest struct {
// SignDataDetails
SignDataDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request SignRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SignRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SignRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SignRequest) String() string
func (request SignRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SignResponse wrapper for the Sign operation
type SignResponse struct {
// The underlying http response
RawResponse *http.Response
// The SignedData instance
SignedData `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response SignResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SignResponse) String() string
SignedData The response to a request to sign the message.
type SignedData struct {
// The OCID of the key used to sign the message.
KeyId *string `mandatory:"true" json:"keyId"`
// The OCID of the key version used to sign the message.
KeyVersionId *string `mandatory:"true" json:"keyVersionId"`
// The base64-encoded binary data object denoting the cryptographic signature generated for the message or message digest.
Signature *string `mandatory:"true" json:"signature"`
// The algorithm to use to sign the message or message digest.
// For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with
// different hashing algorithms.
// For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms.
// When you pass a message digest for signing, ensure that you specify the same hashing algorithm
// as used when creating the message digest.
SigningAlgorithm SignedDataSigningAlgorithmEnum `mandatory:"true" json:"signingAlgorithm"`
}
func (m SignedData) String() string
func (m SignedData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SignedDataSigningAlgorithmEnum Enum with underlying type: string
type SignedDataSigningAlgorithmEnum string
Set of constants representing the allowable values for SignedDataSigningAlgorithmEnum
const (
SignedDataSigningAlgorithmSha224RsaPkcsPss SignedDataSigningAlgorithmEnum = "SHA_224_RSA_PKCS_PSS"
SignedDataSigningAlgorithmSha256RsaPkcsPss SignedDataSigningAlgorithmEnum = "SHA_256_RSA_PKCS_PSS"
SignedDataSigningAlgorithmSha384RsaPkcsPss SignedDataSigningAlgorithmEnum = "SHA_384_RSA_PKCS_PSS"
SignedDataSigningAlgorithmSha512RsaPkcsPss SignedDataSigningAlgorithmEnum = "SHA_512_RSA_PKCS_PSS"
SignedDataSigningAlgorithmSha224RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_224_RSA_PKCS1_V1_5"
SignedDataSigningAlgorithmSha256RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_256_RSA_PKCS1_V1_5"
SignedDataSigningAlgorithmSha384RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_384_RSA_PKCS1_V1_5"
SignedDataSigningAlgorithmSha512RsaPkcs1V15 SignedDataSigningAlgorithmEnum = "SHA_512_RSA_PKCS1_V1_5"
SignedDataSigningAlgorithmEcdsaSha256 SignedDataSigningAlgorithmEnum = "ECDSA_SHA_256"
SignedDataSigningAlgorithmEcdsaSha384 SignedDataSigningAlgorithmEnum = "ECDSA_SHA_384"
SignedDataSigningAlgorithmEcdsaSha512 SignedDataSigningAlgorithmEnum = "ECDSA_SHA_512"
)
func GetMappingSignedDataSigningAlgorithmEnum(val string) (SignedDataSigningAlgorithmEnum, bool)
GetMappingSignedDataSigningAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSignedDataSigningAlgorithmEnumValues() []SignedDataSigningAlgorithmEnum
GetSignedDataSigningAlgorithmEnumValues Enumerates the set of values for SignedDataSigningAlgorithmEnum
UpdateEkmsPrivateEndpointDetails Information needed to modify EKMS private endpoint resource
type UpdateEkmsPrivateEndpointDetails struct {
// Display name of EKMS private endpoint resource.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateEkmsPrivateEndpointDetails) String() string
func (m UpdateEkmsPrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateEkmsPrivateEndpointRequest wrapper for the UpdateEkmsPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateEkmsPrivateEndpoint.go.html to see an example of how to use UpdateEkmsPrivateEndpointRequest.
type UpdateEkmsPrivateEndpointRequest struct {
// Unique EKMS private endpoint identifier.
EkmsPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"ekmsPrivateEndpointId"`
// The information to be updated in EKMS private endpoint
UpdateEkmsPrivateEndpointDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateEkmsPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateEkmsPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateEkmsPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateEkmsPrivateEndpointRequest) String() string
func (request UpdateEkmsPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateEkmsPrivateEndpointResponse wrapper for the UpdateEkmsPrivateEndpoint operation
type UpdateEkmsPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The EkmsPrivateEndpoint instance
EkmsPrivateEndpoint `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateEkmsPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateEkmsPrivateEndpointResponse) String() string
UpdateHsmClusterDetails The details of the HsmCluster resource that you wish to update.
type UpdateHsmClusterDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/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 HSM resource. 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateHsmClusterDetails) String() string
func (m UpdateHsmClusterDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateHsmClusterRequest wrapper for the UpdateHsmCluster operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateHsmCluster.go.html to see an example of how to use UpdateHsmClusterRequest.
type UpdateHsmClusterRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// Details of the HsmCluster Resource
UpdateHsmClusterDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateHsmClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateHsmClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateHsmClusterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateHsmClusterRequest) String() string
func (request UpdateHsmClusterRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateHsmClusterResponse wrapper for the UpdateHsmCluster operation
type UpdateHsmClusterResponse struct {
// The underlying http response
RawResponse *http.Response
// The HsmCluster instance
HsmCluster `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateHsmClusterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateHsmClusterResponse) String() string
UpdateKeyDetails The details of the Key that you wish to update.
type UpdateKeyDetails struct {
// A parameter specifying whether the auto key rotation is enabled or not.
IsAutoRotationEnabled *bool `mandatory:"false" json:"isAutoRotationEnabled"`
AutoKeyRotationDetails *AutoKeyRotationDetails `mandatory:"false" json:"autoKeyRotationDetails"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateKeyDetails) String() string
func (m UpdateKeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateKeyRequest wrapper for the UpdateKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateKey.go.html to see an example of how to use UpdateKeyRequest.
type UpdateKeyRequest struct {
// The OCID of the key.
KeyId *string `mandatory:"true" contributesTo:"path" name:"keyId"`
// UpdateKeyDetails
UpdateKeyDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateKeyRequest) String() string
func (request UpdateKeyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateKeyResponse wrapper for the UpdateKey operation
type UpdateKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The Key instance
Key `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateKeyResponse) String() string
UpdateVaultDetails The details of the Vault that you wish to update.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateVaultDetails) String() string
func (m UpdateVaultDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateVaultRequest wrapper for the UpdateVault operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UpdateVault.go.html to see an example of how to use UpdateVaultRequest.
type UpdateVaultRequest struct {
// The OCID of the vault.
VaultId *string `mandatory:"true" contributesTo:"path" name:"vaultId"`
// UpdateVaultDetails
UpdateVaultDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a
// resource, set the `if-match` parameter to the value of the etag from a
// previous GET or POST response for that resource. The resource will be
// updated or deleted only if the etag you provide matches the resource's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateVaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateVaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateVaultRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateVaultRequest) String() string
func (request UpdateVaultRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateVaultResponse wrapper for the UpdateVault operation
type UpdateVaultResponse struct {
// The underlying http response
RawResponse *http.Response
// The Vault instance
Vault `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateVaultResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateVaultResponse) String() string
UploadPartitionCertificatesDetails An object that encapsulates the necessary partition certificates.
type UploadPartitionCertificatesDetails struct {
// Base64 encoded (StandardCharsets.UTF_8) Partition Certificate, which gets created when the CSR is signed.
PartitionCertificate *string `mandatory:"true" json:"partitionCertificate"`
// Base64 encoded (StandardCharsets.UTF_8) Partition Owner Certificate, which is used to help sign the CSR.
PartitionOwnerCertificate *string `mandatory:"true" json:"partitionOwnerCertificate"`
}
func (m UploadPartitionCertificatesDetails) String() string
func (m UploadPartitionCertificatesDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UploadPartitionCertificatesRequest wrapper for the UploadPartitionCertificates operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/UploadPartitionCertificates.go.html to see an example of how to use UploadPartitionCertificatesRequest.
type UploadPartitionCertificatesRequest struct {
// The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
HsmClusterId *string `mandatory:"true" contributesTo:"path" name:"hsmClusterId"`
// To upload partition certificates.
UploadPartitionCertificatesDetails `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"`
// 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"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UploadPartitionCertificatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UploadPartitionCertificatesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UploadPartitionCertificatesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UploadPartitionCertificatesRequest) String() string
func (request UploadPartitionCertificatesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UploadPartitionCertificatesResponse wrapper for the UploadPartitionCertificates operation
type UploadPartitionCertificatesResponse struct {
// The underlying http response
RawResponse *http.Response
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UploadPartitionCertificatesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UploadPartitionCertificatesResponse) String() string
Vault The logical entity where the Vault service creates and durably stores keys.
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.oracle.com/iaas/api/#/en/key/latest/EncryptedData/Encrypt), Decrypt (https://docs.oracle.com/iaas/api/#/en/key/latest/DecryptedData/Decrypt),
// and GenerateDataEncryptionKey (https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/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"`
ReplicaDetails *VaultReplicaDetails `mandatory:"false" json:"replicaDetails"`
// A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
IsPrimary *bool `mandatory:"false" json:"isPrimary"`
// A Boolean value that indicates whether the Vault has cross region replication capability. Always true for Virtual Private Vaults.
IsVaultReplicable *bool `mandatory:"false" json:"isVaultReplicable"`
ExternalKeyManagerMetadataSummary *ExternalKeyManagerMetadataSummary `mandatory:"false" json:"externalKeyManagerMetadataSummary"`
}
func (m Vault) String() string
func (m Vault) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VaultLifecycleStateEnum Enum with underlying type: string
type VaultLifecycleStateEnum string
Set of constants representing the allowable values for VaultLifecycleStateEnum
const (
VaultLifecycleStateCreating VaultLifecycleStateEnum = "CREATING"
VaultLifecycleStateActive VaultLifecycleStateEnum = "ACTIVE"
VaultLifecycleStateDeleting VaultLifecycleStateEnum = "DELETING"
VaultLifecycleStateDeleted VaultLifecycleStateEnum = "DELETED"
VaultLifecycleStatePendingDeletion VaultLifecycleStateEnum = "PENDING_DELETION"
VaultLifecycleStateSchedulingDeletion VaultLifecycleStateEnum = "SCHEDULING_DELETION"
VaultLifecycleStateCancellingDeletion VaultLifecycleStateEnum = "CANCELLING_DELETION"
VaultLifecycleStateUpdating VaultLifecycleStateEnum = "UPDATING"
VaultLifecycleStateBackupInProgress VaultLifecycleStateEnum = "BACKUP_IN_PROGRESS"
VaultLifecycleStateRestoring VaultLifecycleStateEnum = "RESTORING"
)
func GetMappingVaultLifecycleStateEnum(val string) (VaultLifecycleStateEnum, bool)
GetMappingVaultLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVaultLifecycleStateEnumValues() []VaultLifecycleStateEnum
GetVaultLifecycleStateEnumValues Enumerates the set of values for VaultLifecycleStateEnum
VaultReplicaDetails Vault replica details
type VaultReplicaDetails struct {
// ReplicationId associated with a vault operation
ReplicationId *string `mandatory:"false" json:"replicationId"`
}
func (m VaultReplicaDetails) String() string
func (m VaultReplicaDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VaultReplicaSummary Summary of vault replicas
type VaultReplicaSummary struct {
// The vault replica's crypto endpoint
CryptoEndpoint *string `mandatory:"false" json:"cryptoEndpoint"`
// The vault replica's management endpoint
ManagementEndpoint *string `mandatory:"false" json:"managementEndpoint"`
// Region to which vault is replicated to
Region *string `mandatory:"false" json:"region"`
// Status of the Vault
Status VaultReplicaSummaryStatusEnum `mandatory:"false" json:"status,omitempty"`
}
func (m VaultReplicaSummary) String() string
func (m VaultReplicaSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VaultReplicaSummaryStatusEnum Enum with underlying type: string
type VaultReplicaSummaryStatusEnum string
Set of constants representing the allowable values for VaultReplicaSummaryStatusEnum
const (
VaultReplicaSummaryStatusCreating VaultReplicaSummaryStatusEnum = "CREATING"
VaultReplicaSummaryStatusCreated VaultReplicaSummaryStatusEnum = "CREATED"
VaultReplicaSummaryStatusDeleting VaultReplicaSummaryStatusEnum = "DELETING"
VaultReplicaSummaryStatusDeleted VaultReplicaSummaryStatusEnum = "DELETED"
)
func GetMappingVaultReplicaSummaryStatusEnum(val string) (VaultReplicaSummaryStatusEnum, bool)
GetMappingVaultReplicaSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVaultReplicaSummaryStatusEnumValues() []VaultReplicaSummaryStatusEnum
GetVaultReplicaSummaryStatusEnumValues Enumerates the set of values for VaultReplicaSummaryStatusEnum
VaultSummary The details of the Vault.
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.oracle.com/iaas/api/#/en/key/latest/EncryptedData/Encrypt), Decrypt (https://docs.oracle.com/iaas/api/#/en/key/latest/DecryptedData/Decrypt),
// and GenerateDataEncryptionKey (https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
ExternalKeyManagerMetadataSummary *ExternalKeyManagerMetadataSummary `mandatory:"false" json:"externalKeyManagerMetadataSummary"`
}
func (m VaultSummary) String() string
func (m VaultSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VaultSummaryLifecycleStateEnum Enum with underlying type: string
type VaultSummaryLifecycleStateEnum string
Set of constants representing the allowable values for VaultSummaryLifecycleStateEnum
const (
VaultSummaryLifecycleStateCreating VaultSummaryLifecycleStateEnum = "CREATING"
VaultSummaryLifecycleStateActive VaultSummaryLifecycleStateEnum = "ACTIVE"
VaultSummaryLifecycleStateDeleting VaultSummaryLifecycleStateEnum = "DELETING"
VaultSummaryLifecycleStateDeleted VaultSummaryLifecycleStateEnum = "DELETED"
VaultSummaryLifecycleStatePendingDeletion VaultSummaryLifecycleStateEnum = "PENDING_DELETION"
VaultSummaryLifecycleStateSchedulingDeletion VaultSummaryLifecycleStateEnum = "SCHEDULING_DELETION"
VaultSummaryLifecycleStateCancellingDeletion VaultSummaryLifecycleStateEnum = "CANCELLING_DELETION"
VaultSummaryLifecycleStateUpdating VaultSummaryLifecycleStateEnum = "UPDATING"
VaultSummaryLifecycleStateBackupInProgress VaultSummaryLifecycleStateEnum = "BACKUP_IN_PROGRESS"
VaultSummaryLifecycleStateRestoring VaultSummaryLifecycleStateEnum = "RESTORING"
)
func GetMappingVaultSummaryLifecycleStateEnum(val string) (VaultSummaryLifecycleStateEnum, bool)
GetMappingVaultSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVaultSummaryLifecycleStateEnumValues() []VaultSummaryLifecycleStateEnum
GetVaultSummaryLifecycleStateEnumValues Enumerates the set of values for VaultSummaryLifecycleStateEnum
VaultSummaryVaultTypeEnum Enum with underlying type: string
type VaultSummaryVaultTypeEnum string
Set of constants representing the allowable values for VaultSummaryVaultTypeEnum
const (
VaultSummaryVaultTypeVirtualPrivate VaultSummaryVaultTypeEnum = "VIRTUAL_PRIVATE"
VaultSummaryVaultTypeExternal VaultSummaryVaultTypeEnum = "EXTERNAL"
VaultSummaryVaultTypeDefault VaultSummaryVaultTypeEnum = "DEFAULT"
)
func GetMappingVaultSummaryVaultTypeEnum(val string) (VaultSummaryVaultTypeEnum, bool)
GetMappingVaultSummaryVaultTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVaultSummaryVaultTypeEnumValues() []VaultSummaryVaultTypeEnum
GetVaultSummaryVaultTypeEnumValues Enumerates the set of values for VaultSummaryVaultTypeEnum
VaultUsage The details of the number of Keys and KeyVersions usage in a Vault.
type VaultUsage struct {
// The number of keys in this vault that persist on a hardware security module (HSM), across all compartments, excluding keys in a `DELETED` state.
KeyCount *int `mandatory:"true" json:"keyCount"`
// The number of key versions in this vault that persist on a hardware security module (HSM), across all compartments, excluding key versions in a `DELETED` state.
KeyVersionCount *int `mandatory:"true" json:"keyVersionCount"`
// The number of keys in this vault that persist on the server, across all compartments, excluding keys in a `DELETED` state.
SoftwareKeyCount *int `mandatory:"false" json:"softwareKeyCount"`
// The number of key versions in this vault that persist on the server, across all compartments, excluding key versions in a `DELETED` state.
SoftwareKeyVersionCount *int `mandatory:"false" json:"softwareKeyVersionCount"`
}
func (m VaultUsage) String() string
func (m VaultUsage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VaultVaultTypeEnum Enum with underlying type: string
type VaultVaultTypeEnum string
Set of constants representing the allowable values for VaultVaultTypeEnum
const (
VaultVaultTypeVirtualPrivate VaultVaultTypeEnum = "VIRTUAL_PRIVATE"
VaultVaultTypeDefault VaultVaultTypeEnum = "DEFAULT"
VaultVaultTypeExternal VaultVaultTypeEnum = "EXTERNAL"
)
func GetMappingVaultVaultTypeEnum(val string) (VaultVaultTypeEnum, bool)
GetMappingVaultVaultTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVaultVaultTypeEnumValues() []VaultVaultTypeEnum
GetVaultVaultTypeEnumValues Enumerates the set of values for VaultVaultTypeEnum
VerifiedData The response to a request to verify the message.
type VerifiedData struct {
// A Boolean value that indicates whether the signature was verified.
IsSignatureValid *bool `mandatory:"true" json:"isSignatureValid"`
}
func (m VerifiedData) String() string
func (m VerifiedData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VerifyDataDetails The details of the message that you want to verify.
type VerifyDataDetails struct {
// The OCID of the key used to sign the message.
KeyId *string `mandatory:"true" json:"keyId"`
// The OCID of the key version used to sign the message.
KeyVersionId *string `mandatory:"true" json:"keyVersionId"`
// The base64-encoded binary data object denoting the cryptographic signature generated for the message.
Signature *string `mandatory:"true" json:"signature"`
// The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest.
Message *string `mandatory:"true" json:"message"`
// The algorithm to use to sign the message or message digest.
// For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with
// different hashing algorithms.
// For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms.
// When you pass a message digest for signing, ensure that you specify the same hashing algorithm
// as used when creating the message 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, use `DIGEST`.
MessageType VerifyDataDetailsMessageTypeEnum `mandatory:"false" json:"messageType,omitempty"`
}
func (m VerifyDataDetails) String() string
func (m VerifyDataDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VerifyDataDetailsMessageTypeEnum Enum with underlying type: string
type VerifyDataDetailsMessageTypeEnum string
Set of constants representing the allowable values for VerifyDataDetailsMessageTypeEnum
const (
VerifyDataDetailsMessageTypeRaw VerifyDataDetailsMessageTypeEnum = "RAW"
VerifyDataDetailsMessageTypeDigest VerifyDataDetailsMessageTypeEnum = "DIGEST"
)
func GetMappingVerifyDataDetailsMessageTypeEnum(val string) (VerifyDataDetailsMessageTypeEnum, bool)
GetMappingVerifyDataDetailsMessageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVerifyDataDetailsMessageTypeEnumValues() []VerifyDataDetailsMessageTypeEnum
GetVerifyDataDetailsMessageTypeEnumValues Enumerates the set of values for VerifyDataDetailsMessageTypeEnum
VerifyDataDetailsSigningAlgorithmEnum Enum with underlying type: string
type VerifyDataDetailsSigningAlgorithmEnum string
Set of constants representing the allowable values for VerifyDataDetailsSigningAlgorithmEnum
const (
VerifyDataDetailsSigningAlgorithmSha224RsaPkcsPss VerifyDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS_PSS"
VerifyDataDetailsSigningAlgorithmSha256RsaPkcsPss VerifyDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS_PSS"
VerifyDataDetailsSigningAlgorithmSha384RsaPkcsPss VerifyDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS_PSS"
VerifyDataDetailsSigningAlgorithmSha512RsaPkcsPss VerifyDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS_PSS"
VerifyDataDetailsSigningAlgorithmSha224RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_224_RSA_PKCS1_V1_5"
VerifyDataDetailsSigningAlgorithmSha256RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_256_RSA_PKCS1_V1_5"
VerifyDataDetailsSigningAlgorithmSha384RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_384_RSA_PKCS1_V1_5"
VerifyDataDetailsSigningAlgorithmSha512RsaPkcs1V15 VerifyDataDetailsSigningAlgorithmEnum = "SHA_512_RSA_PKCS1_V1_5"
VerifyDataDetailsSigningAlgorithmEcdsaSha256 VerifyDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_256"
VerifyDataDetailsSigningAlgorithmEcdsaSha384 VerifyDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_384"
VerifyDataDetailsSigningAlgorithmEcdsaSha512 VerifyDataDetailsSigningAlgorithmEnum = "ECDSA_SHA_512"
)
func GetMappingVerifyDataDetailsSigningAlgorithmEnum(val string) (VerifyDataDetailsSigningAlgorithmEnum, bool)
GetMappingVerifyDataDetailsSigningAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVerifyDataDetailsSigningAlgorithmEnumValues() []VerifyDataDetailsSigningAlgorithmEnum
GetVerifyDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for VerifyDataDetailsSigningAlgorithmEnum
VerifyRequest wrapper for the Verify operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/keymanagement/Verify.go.html to see an example of how to use VerifyRequest.
type VerifyRequest struct {
// VerifyDataDetails
VerifyDataDetails `contributesTo:"body"`
// Unique identifier for the request. If provided, the returned request ID
// will include this value. Otherwise, a random request ID will be
// generated by the service.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request VerifyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request VerifyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request VerifyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request VerifyRequest) String() string
func (request VerifyRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
VerifyResponse wrapper for the Verify operation
type VerifyResponse struct {
// The underlying http response
RawResponse *http.Response
// The VerifiedData instance
VerifiedData `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response VerifyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response VerifyResponse) String() string
WrappedImportKey The details of the wrapped import Key.
type WrappedImportKey struct {
// The key material to import, wrapped by the vault's RSA public 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's 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's RSA public wrapping key.
WrappingAlgorithm WrappedImportKeyWrappingAlgorithmEnum `mandatory:"true" json:"wrappingAlgorithm"`
}
func (m WrappedImportKey) String() string
func (m WrappedImportKey) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WrappedImportKeyWrappingAlgorithmEnum Enum with underlying type: string
type WrappedImportKeyWrappingAlgorithmEnum string
Set of constants representing the allowable values for WrappedImportKeyWrappingAlgorithmEnum
const (
WrappedImportKeyWrappingAlgorithmSha256 WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_SHA256"
WrappedImportKeyWrappingAlgorithmAesSha256 WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_AES_SHA256"
)
func GetMappingWrappedImportKeyWrappingAlgorithmEnum(val string) (WrappedImportKeyWrappingAlgorithmEnum, bool)
GetMappingWrappedImportKeyWrappingAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWrappedImportKeyWrappingAlgorithmEnumValues() []WrappedImportKeyWrappingAlgorithmEnum
GetWrappedImportKeyWrappingAlgorithmEnumValues Enumerates the set of values for WrappedImportKeyWrappingAlgorithmEnum
WrappingKey The public RSA wrapping key associated with the vault
type WrappingKey struct {
// The OCID of the compartment that contains this key.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the key.
Id *string `mandatory:"true" json:"id"`
// The key's current lifecycle state.
// Example: `ENABLED`
LifecycleState WrappingKeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The public key, in PEM format, to use to wrap the key material before importing it.
PublicKey *string `mandatory:"true" json:"publicKey"`
// The date and time the key was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2018-04-03T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID of the vault that contains this key.
VaultId *string `mandatory:"true" json:"vaultId"`
}
func (m WrappingKey) String() string
func (m WrappingKey) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WrappingKeyLifecycleStateEnum Enum with underlying type: string
type WrappingKeyLifecycleStateEnum string
Set of constants representing the allowable values for WrappingKeyLifecycleStateEnum
const (
WrappingKeyLifecycleStateCreating WrappingKeyLifecycleStateEnum = "CREATING"
WrappingKeyLifecycleStateEnabling WrappingKeyLifecycleStateEnum = "ENABLING"
WrappingKeyLifecycleStateEnabled WrappingKeyLifecycleStateEnum = "ENABLED"
WrappingKeyLifecycleStateDisabling WrappingKeyLifecycleStateEnum = "DISABLING"
WrappingKeyLifecycleStateDisabled WrappingKeyLifecycleStateEnum = "DISABLED"
WrappingKeyLifecycleStateDeleting WrappingKeyLifecycleStateEnum = "DELETING"
WrappingKeyLifecycleStateDeleted WrappingKeyLifecycleStateEnum = "DELETED"
WrappingKeyLifecycleStatePendingDeletion WrappingKeyLifecycleStateEnum = "PENDING_DELETION"
WrappingKeyLifecycleStateSchedulingDeletion WrappingKeyLifecycleStateEnum = "SCHEDULING_DELETION"
WrappingKeyLifecycleStateCancellingDeletion WrappingKeyLifecycleStateEnum = "CANCELLING_DELETION"
WrappingKeyLifecycleStateUpdating WrappingKeyLifecycleStateEnum = "UPDATING"
WrappingKeyLifecycleStateBackupInProgress WrappingKeyLifecycleStateEnum = "BACKUP_IN_PROGRESS"
WrappingKeyLifecycleStateRestoring WrappingKeyLifecycleStateEnum = "RESTORING"
)
func GetMappingWrappingKeyLifecycleStateEnum(val string) (WrappingKeyLifecycleStateEnum, bool)
GetMappingWrappingKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWrappingKeyLifecycleStateEnumValues() []WrappingKeyLifecycleStateEnum
GetWrappingKeyLifecycleStateEnumValues Enumerates the set of values for WrappingKeyLifecycleStateEnum