keymanagement

package
v65.73.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 27, 2024 License: Apache-2.0, UPL-1.0 Imports: 8 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAutoKeyRotationDetailsLastRotationStatusEnumStringValues added in v65.60.0 

func GetAutoKeyRotationDetailsLastRotationStatusEnumStringValues() []string

GetAutoKeyRotationDetailsLastRotationStatusEnumStringValues Enumerates the set of values in String for AutoKeyRotationDetailsLastRotationStatusEnum

func GetBackupLocationDestinationEnumStringValues 

func GetBackupLocationDestinationEnumStringValues() []string

GetBackupLocationDestinationEnumStringValues Enumerates the set of values in String for BackupLocationDestinationEnum

func GetCreateKeyDetailsProtectionModeEnumStringValues 

func GetCreateKeyDetailsProtectionModeEnumStringValues() []string

GetCreateKeyDetailsProtectionModeEnumStringValues Enumerates the set of values in String for CreateKeyDetailsProtectionModeEnum

func GetCreateVaultDetailsVaultTypeEnumStringValues 

func GetCreateVaultDetailsVaultTypeEnumStringValues() []string

GetCreateVaultDetailsVaultTypeEnumStringValues Enumerates the set of values in String for CreateVaultDetailsVaultTypeEnum

func GetDecryptDataDetailsEncryptionAlgorithmEnumStringValues 

func GetDecryptDataDetailsEncryptionAlgorithmEnumStringValues() []string

GetDecryptDataDetailsEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for DecryptDataDetailsEncryptionAlgorithmEnum

func GetDecryptedDataEncryptionAlgorithmEnumStringValues 

func GetDecryptedDataEncryptionAlgorithmEnumStringValues() []string

GetDecryptedDataEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for DecryptedDataEncryptionAlgorithmEnum

func GetEkmsPrivateEndpointLifecycleStateEnumStringValues added in v65.49.2 

func GetEkmsPrivateEndpointLifecycleStateEnumStringValues() []string

GetEkmsPrivateEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for EkmsPrivateEndpointLifecycleStateEnum

func GetEkmsPrivateEndpointSummaryLifecycleStateEnumStringValues added in v65.49.2 

func GetEkmsPrivateEndpointSummaryLifecycleStateEnumStringValues() []string

GetEkmsPrivateEndpointSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for EkmsPrivateEndpointSummaryLifecycleStateEnum

func GetEncryptDataDetailsEncryptionAlgorithmEnumStringValues 

func GetEncryptDataDetailsEncryptionAlgorithmEnumStringValues() []string

GetEncryptDataDetailsEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for EncryptDataDetailsEncryptionAlgorithmEnum

func GetEncryptedDataEncryptionAlgorithmEnumStringValues 

func GetEncryptedDataEncryptionAlgorithmEnumStringValues() []string

GetEncryptedDataEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for EncryptedDataEncryptionAlgorithmEnum

func GetExportKeyDetailsAlgorithmEnumStringValues 

func GetExportKeyDetailsAlgorithmEnumStringValues() []string

GetExportKeyDetailsAlgorithmEnumStringValues Enumerates the set of values in String for ExportKeyDetailsAlgorithmEnum

func GetExportedKeyDataAlgorithmEnumStringValues 

func GetExportedKeyDataAlgorithmEnumStringValues() []string

GetExportedKeyDataAlgorithmEnumStringValues Enumerates the set of values in String for ExportedKeyDataAlgorithmEnum

func GetHsmClusterLifecycleStateEnumStringValues added in v65.58.0 

func GetHsmClusterLifecycleStateEnumStringValues() []string

GetHsmClusterLifecycleStateEnumStringValues Enumerates the set of values in String for HsmClusterLifecycleStateEnum

func GetHsmPartitionLifecycleStateEnumStringValues added in v65.58.0 

func GetHsmPartitionLifecycleStateEnumStringValues() []string

GetHsmPartitionLifecycleStateEnumStringValues Enumerates the set of values in String for HsmPartitionLifecycleStateEnum

func GetImportKeyDetailsProtectionModeEnumStringValues 

func GetImportKeyDetailsProtectionModeEnumStringValues() []string

GetImportKeyDetailsProtectionModeEnumStringValues Enumerates the set of values in String for ImportKeyDetailsProtectionModeEnum

func GetKeyLifecycleStateEnumStringValues 

func GetKeyLifecycleStateEnumStringValues() []string

GetKeyLifecycleStateEnumStringValues Enumerates the set of values in String for KeyLifecycleStateEnum

func GetKeyProtectionModeEnumStringValues 

func GetKeyProtectionModeEnumStringValues() []string

GetKeyProtectionModeEnumStringValues Enumerates the set of values in String for KeyProtectionModeEnum

func GetKeyShapeAlgorithmEnumStringValues 

func GetKeyShapeAlgorithmEnumStringValues() []string

GetKeyShapeAlgorithmEnumStringValues Enumerates the set of values in String for KeyShapeAlgorithmEnum

func GetKeyShapeCurveIdEnumStringValues 

func GetKeyShapeCurveIdEnumStringValues() []string

GetKeyShapeCurveIdEnumStringValues Enumerates the set of values in String for KeyShapeCurveIdEnum

func GetKeySummaryAlgorithmEnumStringValues 

func GetKeySummaryAlgorithmEnumStringValues() []string

GetKeySummaryAlgorithmEnumStringValues Enumerates the set of values in String for KeySummaryAlgorithmEnum

func GetKeySummaryLifecycleStateEnumStringValues 

func GetKeySummaryLifecycleStateEnumStringValues() []string

GetKeySummaryLifecycleStateEnumStringValues Enumerates the set of values in String for KeySummaryLifecycleStateEnum

func GetKeySummaryProtectionModeEnumStringValues 

func GetKeySummaryProtectionModeEnumStringValues() []string

GetKeySummaryProtectionModeEnumStringValues Enumerates the set of values in String for KeySummaryProtectionModeEnum

func GetKeyVersionLifecycleStateEnumStringValues 

func GetKeyVersionLifecycleStateEnumStringValues() []string

GetKeyVersionLifecycleStateEnumStringValues Enumerates the set of values in String for KeyVersionLifecycleStateEnum

func GetKeyVersionOriginEnumStringValues 

func GetKeyVersionOriginEnumStringValues() []string

GetKeyVersionOriginEnumStringValues Enumerates the set of values in String for KeyVersionOriginEnum

func GetKeyVersionSummaryLifecycleStateEnumStringValues 

func GetKeyVersionSummaryLifecycleStateEnumStringValues() []string

GetKeyVersionSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for KeyVersionSummaryLifecycleStateEnum

func GetKeyVersionSummaryOriginEnumStringValues 

func GetKeyVersionSummaryOriginEnumStringValues() []string

GetKeyVersionSummaryOriginEnumStringValues Enumerates the set of values in String for KeyVersionSummaryOriginEnum

func GetListEkmsPrivateEndpointsSortByEnumStringValues added in v65.49.2 

func GetListEkmsPrivateEndpointsSortByEnumStringValues() []string

GetListEkmsPrivateEndpointsSortByEnumStringValues Enumerates the set of values in String for ListEkmsPrivateEndpointsSortByEnum

func GetListEkmsPrivateEndpointsSortOrderEnumStringValues added in v65.49.2 

func GetListEkmsPrivateEndpointsSortOrderEnumStringValues() []string

GetListEkmsPrivateEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListEkmsPrivateEndpointsSortOrderEnum

func GetListHsmClustersSortByEnumStringValues added in v65.58.0 

func GetListHsmClustersSortByEnumStringValues() []string

GetListHsmClustersSortByEnumStringValues Enumerates the set of values in String for ListHsmClustersSortByEnum

func GetListHsmClustersSortOrderEnumStringValues added in v65.58.0 

func GetListHsmClustersSortOrderEnumStringValues() []string

GetListHsmClustersSortOrderEnumStringValues Enumerates the set of values in String for ListHsmClustersSortOrderEnum

func GetListHsmPartitionsSortByEnumStringValues added in v65.58.0 

func GetListHsmPartitionsSortByEnumStringValues() []string

GetListHsmPartitionsSortByEnumStringValues Enumerates the set of values in String for ListHsmPartitionsSortByEnum

func GetListHsmPartitionsSortOrderEnumStringValues added in v65.58.0 

func GetListHsmPartitionsSortOrderEnumStringValues() []string

GetListHsmPartitionsSortOrderEnumStringValues Enumerates the set of values in String for ListHsmPartitionsSortOrderEnum

func GetListKeyVersionsSortByEnumStringValues 

func GetListKeyVersionsSortByEnumStringValues() []string

GetListKeyVersionsSortByEnumStringValues Enumerates the set of values in String for ListKeyVersionsSortByEnum

func GetListKeyVersionsSortOrderEnumStringValues 

func GetListKeyVersionsSortOrderEnumStringValues() []string

GetListKeyVersionsSortOrderEnumStringValues Enumerates the set of values in String for ListKeyVersionsSortOrderEnum

func GetListKeysAlgorithmEnumStringValues 

func GetListKeysAlgorithmEnumStringValues() []string

GetListKeysAlgorithmEnumStringValues Enumerates the set of values in String for ListKeysAlgorithmEnum

func GetListKeysCurveIdEnumStringValues 

func GetListKeysCurveIdEnumStringValues() []string

GetListKeysCurveIdEnumStringValues Enumerates the set of values in String for ListKeysCurveIdEnum

func GetListKeysProtectionModeEnumStringValues 

func GetListKeysProtectionModeEnumStringValues() []string

GetListKeysProtectionModeEnumStringValues Enumerates the set of values in String for ListKeysProtectionModeEnum

func GetListKeysSortByEnumStringValues 

func GetListKeysSortByEnumStringValues() []string

GetListKeysSortByEnumStringValues Enumerates the set of values in String for ListKeysSortByEnum

func GetListKeysSortOrderEnumStringValues 

func GetListKeysSortOrderEnumStringValues() []string

GetListKeysSortOrderEnumStringValues Enumerates the set of values in String for ListKeysSortOrderEnum

func GetListVaultReplicasSortByEnumStringValues 

func GetListVaultReplicasSortByEnumStringValues() []string

GetListVaultReplicasSortByEnumStringValues Enumerates the set of values in String for ListVaultReplicasSortByEnum

func GetListVaultReplicasSortOrderEnumStringValues 

func GetListVaultReplicasSortOrderEnumStringValues() []string

GetListVaultReplicasSortOrderEnumStringValues Enumerates the set of values in String for ListVaultReplicasSortOrderEnum

func GetListVaultsSortByEnumStringValues 

func GetListVaultsSortByEnumStringValues() []string

GetListVaultsSortByEnumStringValues Enumerates the set of values in String for ListVaultsSortByEnum

func GetListVaultsSortOrderEnumStringValues 

func GetListVaultsSortOrderEnumStringValues() []string

GetListVaultsSortOrderEnumStringValues Enumerates the set of values in String for ListVaultsSortOrderEnum

func GetPortInformationPortTypeEnumStringValues added in v65.58.0 

func GetPortInformationPortTypeEnumStringValues() []string

GetPortInformationPortTypeEnumStringValues Enumerates the set of values in String for PortInformationPortTypeEnum

func GetReplicaDetailsStatusEnumStringValues 

func GetReplicaDetailsStatusEnumStringValues() []string

GetReplicaDetailsStatusEnumStringValues Enumerates the set of values in String for ReplicaDetailsStatusEnum

func GetSignDataDetailsMessageTypeEnumStringValues 

func GetSignDataDetailsMessageTypeEnumStringValues() []string

GetSignDataDetailsMessageTypeEnumStringValues Enumerates the set of values in String for SignDataDetailsMessageTypeEnum

func GetSignDataDetailsSigningAlgorithmEnumStringValues 

func GetSignDataDetailsSigningAlgorithmEnumStringValues() []string

GetSignDataDetailsSigningAlgorithmEnumStringValues Enumerates the set of values in String for SignDataDetailsSigningAlgorithmEnum

func GetSignedDataSigningAlgorithmEnumStringValues 

func GetSignedDataSigningAlgorithmEnumStringValues() []string

GetSignedDataSigningAlgorithmEnumStringValues Enumerates the set of values in String for SignedDataSigningAlgorithmEnum

func GetVaultLifecycleStateEnumStringValues 

func GetVaultLifecycleStateEnumStringValues() []string

GetVaultLifecycleStateEnumStringValues Enumerates the set of values in String for VaultLifecycleStateEnum

func GetVaultReplicaSummaryStatusEnumStringValues 

func GetVaultReplicaSummaryStatusEnumStringValues() []string

GetVaultReplicaSummaryStatusEnumStringValues Enumerates the set of values in String for VaultReplicaSummaryStatusEnum

func GetVaultSummaryLifecycleStateEnumStringValues 

func GetVaultSummaryLifecycleStateEnumStringValues() []string

GetVaultSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for VaultSummaryLifecycleStateEnum

func GetVaultSummaryVaultTypeEnumStringValues 

func GetVaultSummaryVaultTypeEnumStringValues() []string

GetVaultSummaryVaultTypeEnumStringValues Enumerates the set of values in String for VaultSummaryVaultTypeEnum

func GetVaultVaultTypeEnumStringValues 

func GetVaultVaultTypeEnumStringValues() []string

GetVaultVaultTypeEnumStringValues Enumerates the set of values in String for VaultVaultTypeEnum

func GetVerifyDataDetailsMessageTypeEnumStringValues 

func GetVerifyDataDetailsMessageTypeEnumStringValues() []string

GetVerifyDataDetailsMessageTypeEnumStringValues Enumerates the set of values in String for VerifyDataDetailsMessageTypeEnum

func GetVerifyDataDetailsSigningAlgorithmEnumStringValues 

func GetVerifyDataDetailsSigningAlgorithmEnumStringValues() []string

GetVerifyDataDetailsSigningAlgorithmEnumStringValues Enumerates the set of values in String for VerifyDataDetailsSigningAlgorithmEnum

func GetWrappedImportKeyWrappingAlgorithmEnumStringValues 

func GetWrappedImportKeyWrappingAlgorithmEnumStringValues() []string

GetWrappedImportKeyWrappingAlgorithmEnumStringValues Enumerates the set of values in String for WrappedImportKeyWrappingAlgorithmEnum

func GetWrappingKeyLifecycleStateEnumStringValues 

func GetWrappingKeyLifecycleStateEnumStringValues() []string

GetWrappingKeyLifecycleStateEnumStringValues Enumerates the set of values in String for WrappingKeyLifecycleStateEnum

Types

type AutoKeyRotationDetails added in v65.60.0 

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"`
}

AutoKeyRotationDetails The details of auto rotation schedule for the Key being create updated or imported.

func (AutoKeyRotationDetails) String added in v65.60.0 

func (m AutoKeyRotationDetails) String() string

func (AutoKeyRotationDetails) ValidateEnumValue added in v65.60.0 

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

type AutoKeyRotationDetailsLastRotationStatusEnum added in v65.60.0 

type AutoKeyRotationDetailsLastRotationStatusEnum string

AutoKeyRotationDetailsLastRotationStatusEnum Enum with underlying type: string 

const (
	AutoKeyRotationDetailsLastRotationStatusSuccess    AutoKeyRotationDetailsLastRotationStatusEnum = "SUCCESS"
	AutoKeyRotationDetailsLastRotationStatusFailed     AutoKeyRotationDetailsLastRotationStatusEnum = "FAILED"
	AutoKeyRotationDetailsLastRotationStatusInProgress AutoKeyRotationDetailsLastRotationStatusEnum = "IN_PROGRESS"
)

Set of constants representing the allowable values for AutoKeyRotationDetailsLastRotationStatusEnum

func GetAutoKeyRotationDetailsLastRotationStatusEnumValues added in v65.60.0 

func GetAutoKeyRotationDetailsLastRotationStatusEnumValues() []AutoKeyRotationDetailsLastRotationStatusEnum

GetAutoKeyRotationDetailsLastRotationStatusEnumValues Enumerates the set of values for AutoKeyRotationDetailsLastRotationStatusEnum

func GetMappingAutoKeyRotationDetailsLastRotationStatusEnum added in v65.60.0 

func GetMappingAutoKeyRotationDetailsLastRotationStatusEnum(val string) (AutoKeyRotationDetailsLastRotationStatusEnum, bool)

GetMappingAutoKeyRotationDetailsLastRotationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type BackupKeyDetails 

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

BackupKeyDetails The details of the Key that you wish to backup.

func (BackupKeyDetails) String 

func (m BackupKeyDetails) String() string

func (*BackupKeyDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (BackupKeyDetails) ValidateEnumValue 

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

type BackupKeyRequest 

type BackupKeyRequest struct {

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

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

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

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

	// BackupKeyDetails
	BackupKeyDetails `contributesTo:"body"`

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

BackupKeyRequest wrapper for the BackupKey operation

See also

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

func (BackupKeyRequest) BinaryRequestBody 

func (request BackupKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (BackupKeyRequest) HTTPRequest 

func (request BackupKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BackupKeyRequest) RetryPolicy 

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

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

func (BackupKeyRequest) String 

func (request BackupKeyRequest) String() string

func (BackupKeyRequest) ValidateEnumValue 

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

type BackupKeyResponse 

type BackupKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

BackupKeyResponse wrapper for the BackupKey operation

func (BackupKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (BackupKeyResponse) String 

func (response BackupKeyResponse) String() string

type BackupLocation 

type BackupLocation interface {
}

BackupLocation Backup upload location

type BackupLocationBucket 

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

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

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

BackupLocationBucket Object storage bucket details to upload or download the backup

func (BackupLocationBucket) MarshalJSON 

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

MarshalJSON marshals to json representation

func (BackupLocationBucket) String 

func (m BackupLocationBucket) String() string

func (BackupLocationBucket) ValidateEnumValue 

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

type BackupLocationDestinationEnum 

type BackupLocationDestinationEnum string

BackupLocationDestinationEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for BackupLocationDestinationEnum

func GetBackupLocationDestinationEnumValues 

func GetBackupLocationDestinationEnumValues() []BackupLocationDestinationEnum

GetBackupLocationDestinationEnumValues Enumerates the set of values for BackupLocationDestinationEnum

func GetMappingBackupLocationDestinationEnum 

func GetMappingBackupLocationDestinationEnum(val string) (BackupLocationDestinationEnum, bool)

GetMappingBackupLocationDestinationEnum performs case Insensitive comparison on enum value and return the desired enum

type BackupLocationUri 

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

BackupLocationUri PreAuthenticated object storage URI to upload or download the backup

func (BackupLocationUri) MarshalJSON 

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

MarshalJSON marshals to json representation

func (BackupLocationUri) String 

func (m BackupLocationUri) String() string

func (BackupLocationUri) ValidateEnumValue 

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

type BackupVaultDetails 

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"`
}

BackupVaultDetails The details of the Vault that you wish to backup.

func (BackupVaultDetails) String 

func (m BackupVaultDetails) String() string

func (*BackupVaultDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (BackupVaultDetails) ValidateEnumValue 

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

type BackupVaultRequest 

type BackupVaultRequest struct {

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

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

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

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

	// BackupVaultDetails
	BackupVaultDetails `contributesTo:"body"`

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

BackupVaultRequest wrapper for the BackupVault operation

See also

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

func (BackupVaultRequest) BinaryRequestBody 

func (request BackupVaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (BackupVaultRequest) HTTPRequest 

func (request BackupVaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BackupVaultRequest) RetryPolicy 

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

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

func (BackupVaultRequest) String 

func (request BackupVaultRequest) String() string

func (BackupVaultRequest) ValidateEnumValue 

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

type BackupVaultResponse 

type BackupVaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

BackupVaultResponse wrapper for the BackupVault operation

func (BackupVaultResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (BackupVaultResponse) String 

func (response BackupVaultResponse) String() string

type CancelHsmClusterDeletionRequest added in v65.58.0 

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
}

CancelHsmClusterDeletionRequest wrapper for the CancelHsmClusterDeletion operation

See also

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

func (CancelHsmClusterDeletionRequest) BinaryRequestBody added in v65.58.0 

func (request CancelHsmClusterDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelHsmClusterDeletionRequest) HTTPRequest added in v65.58.0 

func (request CancelHsmClusterDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelHsmClusterDeletionRequest) RetryPolicy added in v65.58.0 

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

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

func (CancelHsmClusterDeletionRequest) String added in v65.58.0 

func (request CancelHsmClusterDeletionRequest) String() string

func (CancelHsmClusterDeletionRequest) ValidateEnumValue added in v65.58.0 

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

type CancelHsmClusterDeletionResponse added in v65.58.0 

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"`
}

CancelHsmClusterDeletionResponse wrapper for the CancelHsmClusterDeletion operation

func (CancelHsmClusterDeletionResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (CancelHsmClusterDeletionResponse) String added in v65.58.0 

func (response CancelHsmClusterDeletionResponse) String() string

type CancelKeyDeletionRequest 

type CancelKeyDeletionRequest struct {

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

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

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

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

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

CancelKeyDeletionRequest wrapper for the CancelKeyDeletion operation

See also

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

func (CancelKeyDeletionRequest) BinaryRequestBody 

func (request CancelKeyDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelKeyDeletionRequest) HTTPRequest 

func (request CancelKeyDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelKeyDeletionRequest) RetryPolicy 

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

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

func (CancelKeyDeletionRequest) String 

func (request CancelKeyDeletionRequest) String() string

func (CancelKeyDeletionRequest) ValidateEnumValue 

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

type CancelKeyDeletionResponse 

type CancelKeyDeletionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CancelKeyDeletionResponse wrapper for the CancelKeyDeletion operation

func (CancelKeyDeletionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CancelKeyDeletionResponse) String 

func (response CancelKeyDeletionResponse) String() string

type CancelKeyVersionDeletionRequest 

type CancelKeyVersionDeletionRequest struct {

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

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

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

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

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

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

CancelKeyVersionDeletionRequest wrapper for the CancelKeyVersionDeletion operation

See also

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

func (CancelKeyVersionDeletionRequest) BinaryRequestBody 

func (request CancelKeyVersionDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelKeyVersionDeletionRequest) HTTPRequest 

func (request CancelKeyVersionDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelKeyVersionDeletionRequest) RetryPolicy 

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

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

func (CancelKeyVersionDeletionRequest) String 

func (request CancelKeyVersionDeletionRequest) String() string

func (CancelKeyVersionDeletionRequest) ValidateEnumValue 

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

type CancelKeyVersionDeletionResponse 

type CancelKeyVersionDeletionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CancelKeyVersionDeletionResponse wrapper for the CancelKeyVersionDeletion operation

func (CancelKeyVersionDeletionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CancelKeyVersionDeletionResponse) String 

func (response CancelKeyVersionDeletionResponse) String() string

type CancelVaultDeletionRequest 

type CancelVaultDeletionRequest struct {

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

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

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

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

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

CancelVaultDeletionRequest wrapper for the CancelVaultDeletion operation

See also

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

func (CancelVaultDeletionRequest) BinaryRequestBody 

func (request CancelVaultDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelVaultDeletionRequest) HTTPRequest 

func (request CancelVaultDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelVaultDeletionRequest) RetryPolicy 

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

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

func (CancelVaultDeletionRequest) String 

func (request CancelVaultDeletionRequest) String() string

func (CancelVaultDeletionRequest) ValidateEnumValue 

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

type CancelVaultDeletionResponse 

type CancelVaultDeletionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CancelVaultDeletionResponse wrapper for the CancelVaultDeletion operation

func (CancelVaultDeletionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CancelVaultDeletionResponse) String 

func (response CancelVaultDeletionResponse) String() string

type ChangeHsmClusterCompartmentDetails added in v65.58.0 

type ChangeHsmClusterCompartmentDetails struct {

	// The [OCID] of the compartment to move the hsm cluster to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeHsmClusterCompartmentDetails The details of the compartment you wish to move the hsm cluster to.

func (ChangeHsmClusterCompartmentDetails) String added in v65.58.0 

func (m ChangeHsmClusterCompartmentDetails) String() string

func (ChangeHsmClusterCompartmentDetails) ValidateEnumValue added in v65.58.0 

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

type ChangeHsmClusterCompartmentRequest added in v65.58.0 

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
}

ChangeHsmClusterCompartmentRequest wrapper for the ChangeHsmClusterCompartment operation

See also

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

func (ChangeHsmClusterCompartmentRequest) BinaryRequestBody added in v65.58.0 

func (request ChangeHsmClusterCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeHsmClusterCompartmentRequest) HTTPRequest added in v65.58.0 

func (request ChangeHsmClusterCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeHsmClusterCompartmentRequest) RetryPolicy added in v65.58.0 

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

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

func (ChangeHsmClusterCompartmentRequest) String added in v65.58.0 

func (request ChangeHsmClusterCompartmentRequest) String() string

func (ChangeHsmClusterCompartmentRequest) ValidateEnumValue added in v65.58.0 

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

type ChangeHsmClusterCompartmentResponse added in v65.58.0 

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"`
}

ChangeHsmClusterCompartmentResponse wrapper for the ChangeHsmClusterCompartment operation

func (ChangeHsmClusterCompartmentResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeHsmClusterCompartmentResponse) String added in v65.58.0 

func (response ChangeHsmClusterCompartmentResponse) String() string

type ChangeKeyCompartmentDetails 

type ChangeKeyCompartmentDetails struct {

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

ChangeKeyCompartmentDetails The deatils of the compartment that you wish to move the Key.

func (ChangeKeyCompartmentDetails) String 

func (m ChangeKeyCompartmentDetails) String() string

func (ChangeKeyCompartmentDetails) ValidateEnumValue 

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

type 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
}

ChangeKeyCompartmentRequest wrapper for the ChangeKeyCompartment operation

See also

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

func (ChangeKeyCompartmentRequest) BinaryRequestBody 

func (request ChangeKeyCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeKeyCompartmentRequest) HTTPRequest 

func (request ChangeKeyCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeKeyCompartmentRequest) RetryPolicy 

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

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

func (ChangeKeyCompartmentRequest) String 

func (request ChangeKeyCompartmentRequest) String() string

func (ChangeKeyCompartmentRequest) ValidateEnumValue 

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

type ChangeKeyCompartmentResponse 

type ChangeKeyCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ChangeKeyCompartmentResponse wrapper for the ChangeKeyCompartment operation

func (ChangeKeyCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeKeyCompartmentResponse) String 

func (response ChangeKeyCompartmentResponse) String() string

type ChangeVaultCompartmentDetails 

type ChangeVaultCompartmentDetails struct {

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

ChangeVaultCompartmentDetails The details of the compartment you wish to move the Vault.

func (ChangeVaultCompartmentDetails) String 

func (m ChangeVaultCompartmentDetails) String() string

func (ChangeVaultCompartmentDetails) ValidateEnumValue 

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

type 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
}

ChangeVaultCompartmentRequest wrapper for the ChangeVaultCompartment operation

See also

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

func (ChangeVaultCompartmentRequest) BinaryRequestBody 

func (request ChangeVaultCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeVaultCompartmentRequest) HTTPRequest 

func (request ChangeVaultCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeVaultCompartmentRequest) RetryPolicy 

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

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

func (ChangeVaultCompartmentRequest) String 

func (request ChangeVaultCompartmentRequest) String() string

func (ChangeVaultCompartmentRequest) ValidateEnumValue 

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

type ChangeVaultCompartmentResponse 

type ChangeVaultCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ChangeVaultCompartmentResponse wrapper for the ChangeVaultCompartment operation

func (ChangeVaultCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeVaultCompartmentResponse) String 

func (response ChangeVaultCompartmentResponse) String() string

type CreateEkmsPrivateEndpointDetails added in v65.49.2 

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"`
}

CreateEkmsPrivateEndpointDetails Information needed to create EKMS private endpoint resource

func (CreateEkmsPrivateEndpointDetails) String added in v65.49.2 

func (m CreateEkmsPrivateEndpointDetails) String() string

func (CreateEkmsPrivateEndpointDetails) ValidateEnumValue added in v65.49.2 

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

type CreateEkmsPrivateEndpointRequest added in v65.49.2 

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
}

CreateEkmsPrivateEndpointRequest wrapper for the CreateEkmsPrivateEndpoint operation

See also

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

func (CreateEkmsPrivateEndpointRequest) BinaryRequestBody added in v65.49.2 

func (request CreateEkmsPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateEkmsPrivateEndpointRequest) HTTPRequest added in v65.49.2 

func (request CreateEkmsPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateEkmsPrivateEndpointRequest) RetryPolicy added in v65.49.2 

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

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

func (CreateEkmsPrivateEndpointRequest) String added in v65.49.2 

func (request CreateEkmsPrivateEndpointRequest) String() string

func (CreateEkmsPrivateEndpointRequest) ValidateEnumValue added in v65.49.2 

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

type CreateEkmsPrivateEndpointResponse added in v65.49.2 

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"`
}

CreateEkmsPrivateEndpointResponse wrapper for the CreateEkmsPrivateEndpoint operation

func (CreateEkmsPrivateEndpointResponse) HTTPResponse added in v65.49.2 

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

HTTPResponse implements the OCIResponse interface

func (CreateEkmsPrivateEndpointResponse) String added in v65.49.2 

func (response CreateEkmsPrivateEndpointResponse) String() string

type CreateHsmClusterDetails added in v65.58.0 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

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

CreateHsmClusterDetails The details of the HSM cluster resource that you want to create.

func (CreateHsmClusterDetails) String added in v65.58.0 

func (m CreateHsmClusterDetails) String() string

func (CreateHsmClusterDetails) ValidateEnumValue added in v65.58.0 

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

type CreateHsmClusterRequest added in v65.58.0 

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
}

CreateHsmClusterRequest wrapper for the CreateHsmCluster operation

See also

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

func (CreateHsmClusterRequest) BinaryRequestBody added in v65.58.0 

func (request CreateHsmClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateHsmClusterRequest) HTTPRequest added in v65.58.0 

func (request CreateHsmClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateHsmClusterRequest) RetryPolicy added in v65.58.0 

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

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

func (CreateHsmClusterRequest) String added in v65.58.0 

func (request CreateHsmClusterRequest) String() string

func (CreateHsmClusterRequest) ValidateEnumValue added in v65.58.0 

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

type CreateHsmClusterResponse added in v65.58.0 

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"`
}

CreateHsmClusterResponse wrapper for the CreateHsmCluster operation

func (CreateHsmClusterResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateHsmClusterResponse) String added in v65.58.0 

func (response CreateHsmClusterResponse) String() string

type CreateKeyDetails 

type CreateKeyDetails struct {

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

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

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

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

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

	// 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"`
}

CreateKeyDetails The details of the key that you want to create.

func (CreateKeyDetails) String 

func (m CreateKeyDetails) String() string

func (CreateKeyDetails) ValidateEnumValue 

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

type CreateKeyDetailsProtectionModeEnum 

type CreateKeyDetailsProtectionModeEnum string

CreateKeyDetailsProtectionModeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for CreateKeyDetailsProtectionModeEnum

func GetCreateKeyDetailsProtectionModeEnumValues 

func GetCreateKeyDetailsProtectionModeEnumValues() []CreateKeyDetailsProtectionModeEnum

GetCreateKeyDetailsProtectionModeEnumValues Enumerates the set of values for CreateKeyDetailsProtectionModeEnum

func GetMappingCreateKeyDetailsProtectionModeEnum 

func GetMappingCreateKeyDetailsProtectionModeEnum(val string) (CreateKeyDetailsProtectionModeEnum, bool)

GetMappingCreateKeyDetailsProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateKeyRequest 

type CreateKeyRequest struct {

	// CreateKeyDetails
	CreateKeyDetails `contributesTo:"body"`

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

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

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

CreateKeyRequest wrapper for the CreateKey operation

See also

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

func (CreateKeyRequest) BinaryRequestBody 

func (request CreateKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateKeyRequest) HTTPRequest 

func (request CreateKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateKeyRequest) RetryPolicy 

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

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

func (CreateKeyRequest) String 

func (request CreateKeyRequest) String() string

func (CreateKeyRequest) ValidateEnumValue 

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

type CreateKeyResponse 

type CreateKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateKeyResponse wrapper for the CreateKey operation

func (CreateKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateKeyResponse) String 

func (response CreateKeyResponse) String() string

type CreateKeyVersionRequest 

type CreateKeyVersionRequest struct {

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

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

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

	// 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
}

CreateKeyVersionRequest wrapper for the CreateKeyVersion operation

See also

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

func (CreateKeyVersionRequest) BinaryRequestBody 

func (request CreateKeyVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateKeyVersionRequest) HTTPRequest 

func (request CreateKeyVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateKeyVersionRequest) RetryPolicy 

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

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

func (CreateKeyVersionRequest) String 

func (request CreateKeyVersionRequest) String() string

func (CreateKeyVersionRequest) ValidateEnumValue 

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

type CreateKeyVersionResponse 

type CreateKeyVersionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateKeyVersionResponse wrapper for the CreateKeyVersion operation

func (CreateKeyVersionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateKeyVersionResponse) String 

func (response CreateKeyVersionResponse) String() string

type CreateVaultDetails 

type CreateVaultDetails struct {

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

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

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

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

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

	ExternalKeyManagerMetadata *ExternalKeyManagerMetadata `mandatory:"false" json:"externalKeyManagerMetadata"`
}

CreateVaultDetails The details of the vault that you want to create.

func (CreateVaultDetails) String 

func (m CreateVaultDetails) String() string

func (CreateVaultDetails) ValidateEnumValue 

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

type CreateVaultDetailsVaultTypeEnum 

type CreateVaultDetailsVaultTypeEnum string

CreateVaultDetailsVaultTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for CreateVaultDetailsVaultTypeEnum

func GetCreateVaultDetailsVaultTypeEnumValues 

func GetCreateVaultDetailsVaultTypeEnumValues() []CreateVaultDetailsVaultTypeEnum

GetCreateVaultDetailsVaultTypeEnumValues Enumerates the set of values for CreateVaultDetailsVaultTypeEnum

func GetMappingCreateVaultDetailsVaultTypeEnum 

func GetMappingCreateVaultDetailsVaultTypeEnum(val string) (CreateVaultDetailsVaultTypeEnum, bool)

GetMappingCreateVaultDetailsVaultTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateVaultReplicaDetails 

type CreateVaultReplicaDetails struct {

	// The region in the realm to which the vault need to be replicated to
	ReplicaRegion *string `mandatory:"true" json:"replicaRegion"`
}

CreateVaultReplicaDetails Creates a vault replica.

func (CreateVaultReplicaDetails) String 

func (m CreateVaultReplicaDetails) String() string

func (CreateVaultReplicaDetails) ValidateEnumValue 

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

type 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
}

CreateVaultReplicaRequest wrapper for the CreateVaultReplica operation

See also

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

func (CreateVaultReplicaRequest) BinaryRequestBody 

func (request CreateVaultReplicaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateVaultReplicaRequest) HTTPRequest 

func (request CreateVaultReplicaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVaultReplicaRequest) RetryPolicy 

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

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

func (CreateVaultReplicaRequest) String 

func (request CreateVaultReplicaRequest) String() string

func (CreateVaultReplicaRequest) ValidateEnumValue 

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

type CreateVaultReplicaResponse 

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"`
}

CreateVaultReplicaResponse wrapper for the CreateVaultReplica operation

func (CreateVaultReplicaResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateVaultReplicaResponse) String 

func (response CreateVaultReplicaResponse) String() string

type CreateVaultRequest 

type CreateVaultRequest struct {

	// CreateVaultDetails
	CreateVaultDetails `contributesTo:"body"`

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

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

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

CreateVaultRequest wrapper for the CreateVault operation

See also

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

func (CreateVaultRequest) BinaryRequestBody 

func (request CreateVaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateVaultRequest) HTTPRequest 

func (request CreateVaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVaultRequest) RetryPolicy 

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

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

func (CreateVaultRequest) String 

func (request CreateVaultRequest) String() string

func (CreateVaultRequest) ValidateEnumValue 

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

type CreateVaultResponse 

type CreateVaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateVaultResponse wrapper for the CreateVault operation

func (CreateVaultResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateVaultResponse) String 

func (response CreateVaultResponse) String() string

type DecryptDataDetails 

type DecryptDataDetails struct {

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

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

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

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

	// The OCID of the 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"`
}

DecryptDataDetails The details of the encrypted data that you want to decrypt.

func (DecryptDataDetails) String 

func (m DecryptDataDetails) String() string

func (DecryptDataDetails) ValidateEnumValue 

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

type DecryptDataDetailsEncryptionAlgorithmEnum 

type DecryptDataDetailsEncryptionAlgorithmEnum string

DecryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for DecryptDataDetailsEncryptionAlgorithmEnum

func GetDecryptDataDetailsEncryptionAlgorithmEnumValues 

func GetDecryptDataDetailsEncryptionAlgorithmEnumValues() []DecryptDataDetailsEncryptionAlgorithmEnum

GetDecryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptDataDetailsEncryptionAlgorithmEnum

func GetMappingDecryptDataDetailsEncryptionAlgorithmEnum 

func GetMappingDecryptDataDetailsEncryptionAlgorithmEnum(val string) (DecryptDataDetailsEncryptionAlgorithmEnum, bool)

GetMappingDecryptDataDetailsEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

type DecryptRequest 

type DecryptRequest struct {

	// DecryptDataDetails
	DecryptDataDetails `contributesTo:"body"`

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

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

DecryptRequest wrapper for the Decrypt operation

See also

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

func (DecryptRequest) BinaryRequestBody 

func (request DecryptRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DecryptRequest) HTTPRequest 

func (request DecryptRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DecryptRequest) RetryPolicy 

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

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

func (DecryptRequest) String 

func (request DecryptRequest) String() string

func (DecryptRequest) ValidateEnumValue 

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

type DecryptResponse 

type DecryptResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

DecryptResponse wrapper for the Decrypt operation

func (DecryptResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DecryptResponse) String 

func (response DecryptResponse) String() string

type DecryptedData 

type DecryptedData struct {

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

	// 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"`
}

DecryptedData The response to a request to decrypt the encrypted data.

func (DecryptedData) String 

func (m DecryptedData) String() string

func (DecryptedData) ValidateEnumValue 

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

type DecryptedDataEncryptionAlgorithmEnum 

type DecryptedDataEncryptionAlgorithmEnum string

DecryptedDataEncryptionAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for DecryptedDataEncryptionAlgorithmEnum

func GetDecryptedDataEncryptionAlgorithmEnumValues 

func GetDecryptedDataEncryptionAlgorithmEnumValues() []DecryptedDataEncryptionAlgorithmEnum

GetDecryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for DecryptedDataEncryptionAlgorithmEnum

func GetMappingDecryptedDataEncryptionAlgorithmEnum 

func GetMappingDecryptedDataEncryptionAlgorithmEnum(val string) (DecryptedDataEncryptionAlgorithmEnum, bool)

GetMappingDecryptedDataEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

type DeleteEkmsPrivateEndpointRequest added in v65.49.2 

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
}

DeleteEkmsPrivateEndpointRequest wrapper for the DeleteEkmsPrivateEndpoint operation

See also

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

func (DeleteEkmsPrivateEndpointRequest) BinaryRequestBody added in v65.49.2 

func (request DeleteEkmsPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteEkmsPrivateEndpointRequest) HTTPRequest added in v65.49.2 

func (request DeleteEkmsPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteEkmsPrivateEndpointRequest) RetryPolicy added in v65.49.2 

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

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

func (DeleteEkmsPrivateEndpointRequest) String added in v65.49.2 

func (request DeleteEkmsPrivateEndpointRequest) String() string

func (DeleteEkmsPrivateEndpointRequest) ValidateEnumValue added in v65.49.2 

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

type DeleteEkmsPrivateEndpointResponse added in v65.49.2 

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"`
}

DeleteEkmsPrivateEndpointResponse wrapper for the DeleteEkmsPrivateEndpoint operation

func (DeleteEkmsPrivateEndpointResponse) HTTPResponse added in v65.49.2 

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

HTTPResponse implements the OCIResponse interface

func (DeleteEkmsPrivateEndpointResponse) String added in v65.49.2 

func (response DeleteEkmsPrivateEndpointResponse) String() string

type DeleteVaultReplicaDetails 

type DeleteVaultReplicaDetails struct {

	// The region in the realm on which the replica should be deleted
	ReplicaRegion *string `mandatory:"true" json:"replicaRegion"`
}

DeleteVaultReplicaDetails Deletes a vault replica

func (DeleteVaultReplicaDetails) String 

func (m DeleteVaultReplicaDetails) String() string

func (DeleteVaultReplicaDetails) ValidateEnumValue 

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

type 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
}

DeleteVaultReplicaRequest wrapper for the DeleteVaultReplica operation

See also

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

func (DeleteVaultReplicaRequest) BinaryRequestBody 

func (request DeleteVaultReplicaRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteVaultReplicaRequest) HTTPRequest 

func (request DeleteVaultReplicaRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVaultReplicaRequest) RetryPolicy 

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

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

func (DeleteVaultReplicaRequest) String 

func (request DeleteVaultReplicaRequest) String() string

func (DeleteVaultReplicaRequest) ValidateEnumValue 

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

type DeleteVaultReplicaResponse 

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"`
}

DeleteVaultReplicaResponse wrapper for the DeleteVaultReplica operation

func (DeleteVaultReplicaResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteVaultReplicaResponse) String 

func (response DeleteVaultReplicaResponse) String() string

type DisableKeyRequest 

type DisableKeyRequest struct {

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

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

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

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

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

DisableKeyRequest wrapper for the DisableKey operation

See also

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

func (DisableKeyRequest) BinaryRequestBody 

func (request DisableKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DisableKeyRequest) HTTPRequest 

func (request DisableKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DisableKeyRequest) RetryPolicy 

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

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

func (DisableKeyRequest) String 

func (request DisableKeyRequest) String() string

func (DisableKeyRequest) ValidateEnumValue 

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

type DisableKeyResponse 

type DisableKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

DisableKeyResponse wrapper for the DisableKey operation

func (DisableKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DisableKeyResponse) String 

func (response DisableKeyResponse) String() string

type DownloadCertificateSigningRequestRequest added in v65.58.0 

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
}

DownloadCertificateSigningRequestRequest wrapper for the DownloadCertificateSigningRequest operation

See also

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

func (DownloadCertificateSigningRequestRequest) BinaryRequestBody added in v65.58.0 

func (request DownloadCertificateSigningRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DownloadCertificateSigningRequestRequest) HTTPRequest added in v65.58.0 

func (request DownloadCertificateSigningRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DownloadCertificateSigningRequestRequest) RetryPolicy added in v65.58.0 

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

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

func (DownloadCertificateSigningRequestRequest) String added in v65.58.0 

func (request DownloadCertificateSigningRequestRequest) String() string

func (DownloadCertificateSigningRequestRequest) ValidateEnumValue added in v65.58.0 

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

type DownloadCertificateSigningRequestResponse added in v65.58.0 

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"`
}

DownloadCertificateSigningRequestResponse wrapper for the DownloadCertificateSigningRequest operation

func (DownloadCertificateSigningRequestResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (DownloadCertificateSigningRequestResponse) String added in v65.58.0 

func (response DownloadCertificateSigningRequestResponse) String() string

type EkmClient added in v65.49.2 

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

EkmClient a client for Ekm

func NewEkmClientWithConfigurationProvider added in v65.49.2 

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 added in v65.49.2 

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 (*EkmClient) ConfigurationProvider added in v65.49.2 

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

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

func (EkmClient) CreateEkmsPrivateEndpoint added in v65.49.2 

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

See also

Click https://docs.cloud.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 (EkmClient) DeleteEkmsPrivateEndpoint added in v65.49.2 

func (client EkmClient) DeleteEkmsPrivateEndpoint(ctx context.Context, request DeleteEkmsPrivateEndpointRequest) (response DeleteEkmsPrivateEndpointResponse, err error)

DeleteEkmsPrivateEndpoint Deletes EKMS private endpoint by identifier.

See also

Click https://docs.cloud.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 (EkmClient) GetEkmsPrivateEndpoint added in v65.49.2 

func (client EkmClient) GetEkmsPrivateEndpoint(ctx context.Context, request GetEkmsPrivateEndpointRequest) (response GetEkmsPrivateEndpointResponse, err error)

GetEkmsPrivateEndpoint Gets a specific EKMS private by identifier.

See also

Click https://docs.cloud.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 (EkmClient) ListEkmsPrivateEndpoints added in v65.49.2 

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.

See also

Click https://docs.cloud.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 (*EkmClient) SetRegion added in v65.49.2 

func (client *EkmClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (EkmClient) UpdateEkmsPrivateEndpoint added in v65.49.2 

func (client EkmClient) UpdateEkmsPrivateEndpoint(ctx context.Context, request UpdateEkmsPrivateEndpointRequest) (response UpdateEkmsPrivateEndpointResponse, err error)

UpdateEkmsPrivateEndpoint Updates EKMS private endpoint.

See also

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

type EkmsPrivateEndpoint added in v65.49.2 

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"`
}

EkmsPrivateEndpoint EKMS private endpoint created in customer subnet used to connect to external key manager system

func (EkmsPrivateEndpoint) String added in v65.49.2 

func (m EkmsPrivateEndpoint) String() string

func (EkmsPrivateEndpoint) ValidateEnumValue added in v65.49.2 

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

type EkmsPrivateEndpointLifecycleStateEnum added in v65.49.2 

type EkmsPrivateEndpointLifecycleStateEnum string

EkmsPrivateEndpointLifecycleStateEnum Enum with underlying type: string 

const (
	EkmsPrivateEndpointLifecycleStateCreating EkmsPrivateEndpointLifecycleStateEnum = "CREATING"
	EkmsPrivateEndpointLifecycleStateActive   EkmsPrivateEndpointLifecycleStateEnum = "ACTIVE"
	EkmsPrivateEndpointLifecycleStateDeleting EkmsPrivateEndpointLifecycleStateEnum = "DELETING"
	EkmsPrivateEndpointLifecycleStateDeleted  EkmsPrivateEndpointLifecycleStateEnum = "DELETED"
	EkmsPrivateEndpointLifecycleStateFailed   EkmsPrivateEndpointLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for EkmsPrivateEndpointLifecycleStateEnum

func GetEkmsPrivateEndpointLifecycleStateEnumValues added in v65.49.2 

func GetEkmsPrivateEndpointLifecycleStateEnumValues() []EkmsPrivateEndpointLifecycleStateEnum

GetEkmsPrivateEndpointLifecycleStateEnumValues Enumerates the set of values for EkmsPrivateEndpointLifecycleStateEnum

func GetMappingEkmsPrivateEndpointLifecycleStateEnum added in v65.49.2 

func GetMappingEkmsPrivateEndpointLifecycleStateEnum(val string) (EkmsPrivateEndpointLifecycleStateEnum, bool)

GetMappingEkmsPrivateEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type EkmsPrivateEndpointSummary added in v65.49.2 

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"`
}

EkmsPrivateEndpointSummary EKMS private endpoints summary

func (EkmsPrivateEndpointSummary) String added in v65.49.2 

func (m EkmsPrivateEndpointSummary) String() string

func (EkmsPrivateEndpointSummary) ValidateEnumValue added in v65.49.2 

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

type EkmsPrivateEndpointSummaryLifecycleStateEnum added in v65.49.2 

type EkmsPrivateEndpointSummaryLifecycleStateEnum string

EkmsPrivateEndpointSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	EkmsPrivateEndpointSummaryLifecycleStateCreating EkmsPrivateEndpointSummaryLifecycleStateEnum = "CREATING"
	EkmsPrivateEndpointSummaryLifecycleStateActive   EkmsPrivateEndpointSummaryLifecycleStateEnum = "ACTIVE"
	EkmsPrivateEndpointSummaryLifecycleStateDeleting EkmsPrivateEndpointSummaryLifecycleStateEnum = "DELETING"
	EkmsPrivateEndpointSummaryLifecycleStateDeleted  EkmsPrivateEndpointSummaryLifecycleStateEnum = "DELETED"
	EkmsPrivateEndpointSummaryLifecycleStateFailed   EkmsPrivateEndpointSummaryLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for EkmsPrivateEndpointSummaryLifecycleStateEnum

func GetEkmsPrivateEndpointSummaryLifecycleStateEnumValues added in v65.49.2 

func GetEkmsPrivateEndpointSummaryLifecycleStateEnumValues() []EkmsPrivateEndpointSummaryLifecycleStateEnum

GetEkmsPrivateEndpointSummaryLifecycleStateEnumValues Enumerates the set of values for EkmsPrivateEndpointSummaryLifecycleStateEnum

func GetMappingEkmsPrivateEndpointSummaryLifecycleStateEnum added in v65.49.2 

func GetMappingEkmsPrivateEndpointSummaryLifecycleStateEnum(val string) (EkmsPrivateEndpointSummaryLifecycleStateEnum, bool)

GetMappingEkmsPrivateEndpointSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type EnableKeyRequest 

type EnableKeyRequest struct {

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

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

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

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

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

EnableKeyRequest wrapper for the EnableKey operation

See also

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

func (EnableKeyRequest) BinaryRequestBody 

func (request EnableKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (EnableKeyRequest) HTTPRequest 

func (request EnableKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (EnableKeyRequest) RetryPolicy 

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

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

func (EnableKeyRequest) String 

func (request EnableKeyRequest) String() string

func (EnableKeyRequest) ValidateEnumValue 

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

type EnableKeyResponse 

type EnableKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

EnableKeyResponse wrapper for the EnableKey operation

func (EnableKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (EnableKeyResponse) String 

func (response EnableKeyResponse) String() string

type EncryptDataDetails 

type EncryptDataDetails struct {

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

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

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

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

	// The OCID of the 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"`
}

EncryptDataDetails The details of the plaintext data that you want to encrypt.

func (EncryptDataDetails) String 

func (m EncryptDataDetails) String() string

func (EncryptDataDetails) ValidateEnumValue 

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

type EncryptDataDetailsEncryptionAlgorithmEnum 

type EncryptDataDetailsEncryptionAlgorithmEnum string

EncryptDataDetailsEncryptionAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for EncryptDataDetailsEncryptionAlgorithmEnum

func GetEncryptDataDetailsEncryptionAlgorithmEnumValues 

func GetEncryptDataDetailsEncryptionAlgorithmEnumValues() []EncryptDataDetailsEncryptionAlgorithmEnum

GetEncryptDataDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptDataDetailsEncryptionAlgorithmEnum

func GetMappingEncryptDataDetailsEncryptionAlgorithmEnum 

func GetMappingEncryptDataDetailsEncryptionAlgorithmEnum(val string) (EncryptDataDetailsEncryptionAlgorithmEnum, bool)

GetMappingEncryptDataDetailsEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

type EncryptRequest 

type EncryptRequest struct {

	// EncryptDataDetails
	EncryptDataDetails `contributesTo:"body"`

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

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

EncryptRequest wrapper for the Encrypt operation

See also

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

func (EncryptRequest) BinaryRequestBody 

func (request EncryptRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (EncryptRequest) HTTPRequest 

func (request EncryptRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (EncryptRequest) RetryPolicy 

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

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

func (EncryptRequest) String 

func (request EncryptRequest) String() string

func (EncryptRequest) ValidateEnumValue 

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

type EncryptResponse 

type EncryptResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

EncryptResponse wrapper for the Encrypt operation

func (EncryptResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (EncryptResponse) String 

func (response EncryptResponse) String() string

type EncryptedData 

type EncryptedData struct {

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

	// The OCID of the key used to 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"`
}

EncryptedData The response to a request to encrypt the plaintext data.

func (EncryptedData) String 

func (m EncryptedData) String() string

func (EncryptedData) ValidateEnumValue 

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

type EncryptedDataEncryptionAlgorithmEnum 

type EncryptedDataEncryptionAlgorithmEnum string

EncryptedDataEncryptionAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for EncryptedDataEncryptionAlgorithmEnum

func GetEncryptedDataEncryptionAlgorithmEnumValues 

func GetEncryptedDataEncryptionAlgorithmEnumValues() []EncryptedDataEncryptionAlgorithmEnum

GetEncryptedDataEncryptionAlgorithmEnumValues Enumerates the set of values for EncryptedDataEncryptionAlgorithmEnum

func GetMappingEncryptedDataEncryptionAlgorithmEnum 

func GetMappingEncryptedDataEncryptionAlgorithmEnum(val string) (EncryptedDataEncryptionAlgorithmEnum, bool)

GetMappingEncryptedDataEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

type ExportKeyDetails 

type ExportKeyDetails struct {

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

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

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

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

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

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

func (ExportKeyDetails) String 

func (m ExportKeyDetails) String() string

func (ExportKeyDetails) ValidateEnumValue 

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

type ExportKeyDetailsAlgorithmEnum 

type ExportKeyDetailsAlgorithmEnum string

ExportKeyDetailsAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ExportKeyDetailsAlgorithmEnum

func GetExportKeyDetailsAlgorithmEnumValues 

func GetExportKeyDetailsAlgorithmEnumValues() []ExportKeyDetailsAlgorithmEnum

GetExportKeyDetailsAlgorithmEnumValues Enumerates the set of values for ExportKeyDetailsAlgorithmEnum

func GetMappingExportKeyDetailsAlgorithmEnum 

func GetMappingExportKeyDetailsAlgorithmEnum(val string) (ExportKeyDetailsAlgorithmEnum, bool)

GetMappingExportKeyDetailsAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

type ExportKeyRequest 

type ExportKeyRequest struct {

	// ExportKeyDetails
	ExportKeyDetails `contributesTo:"body"`

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

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

ExportKeyRequest wrapper for the ExportKey operation

See also

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

func (ExportKeyRequest) BinaryRequestBody 

func (request ExportKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ExportKeyRequest) HTTPRequest 

func (request ExportKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ExportKeyRequest) RetryPolicy 

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

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

func (ExportKeyRequest) String 

func (request ExportKeyRequest) String() string

func (ExportKeyRequest) ValidateEnumValue 

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

type ExportKeyResponse 

type ExportKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ExportKeyResponse wrapper for the ExportKey operation

func (ExportKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ExportKeyResponse) String 

func (response ExportKeyResponse) String() string

type ExportedKeyData 

type ExportedKeyData struct {

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

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

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

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

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

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

ExportedKeyData The response to a request to export key material.

func (ExportedKeyData) String 

func (m ExportedKeyData) String() string

func (ExportedKeyData) ValidateEnumValue 

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

type ExportedKeyDataAlgorithmEnum 

type ExportedKeyDataAlgorithmEnum string

ExportedKeyDataAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ExportedKeyDataAlgorithmEnum

func GetExportedKeyDataAlgorithmEnumValues 

func GetExportedKeyDataAlgorithmEnumValues() []ExportedKeyDataAlgorithmEnum

GetExportedKeyDataAlgorithmEnumValues Enumerates the set of values for ExportedKeyDataAlgorithmEnum

func GetMappingExportedKeyDataAlgorithmEnum 

func GetMappingExportedKeyDataAlgorithmEnum(val string) (ExportedKeyDataAlgorithmEnum, bool)

GetMappingExportedKeyDataAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

type ExternalKeyManagerMetadata added in v65.49.2 

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"`
}

ExternalKeyManagerMetadata Metadata required for accessing External Key manager

func (ExternalKeyManagerMetadata) String added in v65.49.2 

func (m ExternalKeyManagerMetadata) String() string

func (ExternalKeyManagerMetadata) ValidateEnumValue added in v65.49.2 

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

type ExternalKeyManagerMetadataSummary added in v65.49.2 

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"`
}

ExternalKeyManagerMetadataSummary Summary about metadata of external key manager to be returned to the customer as a response.

func (ExternalKeyManagerMetadataSummary) String added in v65.49.2 

func (m ExternalKeyManagerMetadataSummary) String() string

func (ExternalKeyManagerMetadataSummary) ValidateEnumValue added in v65.49.2 

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

type ExternalKeyReference added in v65.49.2 

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"`
}

ExternalKeyReference A reference to the key on external key manager.

func (ExternalKeyReference) String added in v65.49.2 

func (m ExternalKeyReference) String() string

func (ExternalKeyReference) ValidateEnumValue added in v65.49.2 

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

type ExternalKeyReferenceDetails added in v65.49.2 

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"`
}

ExternalKeyReferenceDetails Key reference data to be returned to the customer as a response.

func (ExternalKeyReferenceDetails) String added in v65.49.2 

func (m ExternalKeyReferenceDetails) String() string

func (ExternalKeyReferenceDetails) ValidateEnumValue added in v65.49.2 

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

type ExternalKeyVersionReference added in v65.49.2 

type ExternalKeyVersionReference struct {

	// Key version ID associated with the external key.
	ExternalKeyVersionId *string `mandatory:"false" json:"externalKeyVersionId"`
}

ExternalKeyVersionReference A reference to key version on external key manager.

func (ExternalKeyVersionReference) String added in v65.49.2 

func (m ExternalKeyVersionReference) String() string

func (ExternalKeyVersionReference) ValidateEnumValue added in v65.49.2 

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

type GenerateDataEncryptionKeyRequest 

type GenerateDataEncryptionKeyRequest struct {

	// GenerateKeyDetails
	GenerateKeyDetails `contributesTo:"body"`

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

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

GenerateDataEncryptionKeyRequest wrapper for the GenerateDataEncryptionKey operation

See also

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

func (GenerateDataEncryptionKeyRequest) BinaryRequestBody 

func (request GenerateDataEncryptionKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GenerateDataEncryptionKeyRequest) HTTPRequest 

func (request GenerateDataEncryptionKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GenerateDataEncryptionKeyRequest) RetryPolicy 

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

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

func (GenerateDataEncryptionKeyRequest) String 

func (request GenerateDataEncryptionKeyRequest) String() string

func (GenerateDataEncryptionKeyRequest) ValidateEnumValue 

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

type GenerateDataEncryptionKeyResponse 

type GenerateDataEncryptionKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

GenerateDataEncryptionKeyResponse wrapper for the GenerateDataEncryptionKey operation

func (GenerateDataEncryptionKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GenerateDataEncryptionKeyResponse) String 

func (response GenerateDataEncryptionKeyResponse) String() string

type GenerateKeyDetails 

type GenerateKeyDetails struct {

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

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

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

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

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

GenerateKeyDetails The details of the key that you want to encrypt or decrypt data.

func (GenerateKeyDetails) String 

func (m GenerateKeyDetails) String() string

func (GenerateKeyDetails) ValidateEnumValue 

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

type GeneratedKey 

type GeneratedKey struct {

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

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

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

GeneratedKey The reponse to the regeuest to generate the key to encrypt or decrypt the data.

func (GeneratedKey) String 

func (m GeneratedKey) String() string

func (GeneratedKey) ValidateEnumValue 

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

type GetEkmsPrivateEndpointRequest added in v65.49.2 

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
}

GetEkmsPrivateEndpointRequest wrapper for the GetEkmsPrivateEndpoint operation

See also

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

func (GetEkmsPrivateEndpointRequest) BinaryRequestBody added in v65.49.2 

func (request GetEkmsPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetEkmsPrivateEndpointRequest) HTTPRequest added in v65.49.2 

func (request GetEkmsPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetEkmsPrivateEndpointRequest) RetryPolicy added in v65.49.2 

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

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

func (GetEkmsPrivateEndpointRequest) String added in v65.49.2 

func (request GetEkmsPrivateEndpointRequest) String() string

func (GetEkmsPrivateEndpointRequest) ValidateEnumValue added in v65.49.2 

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

type GetEkmsPrivateEndpointResponse added in v65.49.2 

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"`
}

GetEkmsPrivateEndpointResponse wrapper for the GetEkmsPrivateEndpoint operation

func (GetEkmsPrivateEndpointResponse) HTTPResponse added in v65.49.2 

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

HTTPResponse implements the OCIResponse interface

func (GetEkmsPrivateEndpointResponse) String added in v65.49.2 

func (response GetEkmsPrivateEndpointResponse) String() string

type GetHsmClusterRequest added in v65.58.0 

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
}

GetHsmClusterRequest wrapper for the GetHsmCluster operation

See also

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

func (GetHsmClusterRequest) BinaryRequestBody added in v65.58.0 

func (request GetHsmClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetHsmClusterRequest) HTTPRequest added in v65.58.0 

func (request GetHsmClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetHsmClusterRequest) RetryPolicy added in v65.58.0 

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

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

func (GetHsmClusterRequest) String added in v65.58.0 

func (request GetHsmClusterRequest) String() string

func (GetHsmClusterRequest) ValidateEnumValue added in v65.58.0 

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

type GetHsmClusterResponse added in v65.58.0 

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"`
}

GetHsmClusterResponse wrapper for the GetHsmCluster operation

func (GetHsmClusterResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (GetHsmClusterResponse) String added in v65.58.0 

func (response GetHsmClusterResponse) String() string

type GetHsmPartitionRequest added in v65.58.0 

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
}

GetHsmPartitionRequest wrapper for the GetHsmPartition operation

See also

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

func (GetHsmPartitionRequest) BinaryRequestBody added in v65.58.0 

func (request GetHsmPartitionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetHsmPartitionRequest) HTTPRequest added in v65.58.0 

func (request GetHsmPartitionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetHsmPartitionRequest) RetryPolicy added in v65.58.0 

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

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

func (GetHsmPartitionRequest) String added in v65.58.0 

func (request GetHsmPartitionRequest) String() string

func (GetHsmPartitionRequest) ValidateEnumValue added in v65.58.0 

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

type GetHsmPartitionResponse added in v65.58.0 

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"`
}

GetHsmPartitionResponse wrapper for the GetHsmPartition operation

func (GetHsmPartitionResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (GetHsmPartitionResponse) String added in v65.58.0 

func (response GetHsmPartitionResponse) String() string

type GetKeyRequest 

type GetKeyRequest struct {

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

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

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

GetKeyRequest wrapper for the GetKey operation

See also

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

func (GetKeyRequest) BinaryRequestBody 

func (request GetKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetKeyRequest) HTTPRequest 

func (request GetKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetKeyRequest) RetryPolicy 

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

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

func (GetKeyRequest) String 

func (request GetKeyRequest) String() string

func (GetKeyRequest) ValidateEnumValue 

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

type GetKeyResponse 

type GetKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetKeyResponse wrapper for the GetKey operation

func (GetKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetKeyResponse) String 

func (response GetKeyResponse) String() string

type GetKeyVersionRequest 

type GetKeyVersionRequest struct {

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

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

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

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

GetKeyVersionRequest wrapper for the GetKeyVersion operation

See also

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

func (GetKeyVersionRequest) BinaryRequestBody 

func (request GetKeyVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetKeyVersionRequest) HTTPRequest 

func (request GetKeyVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetKeyVersionRequest) RetryPolicy 

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

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

func (GetKeyVersionRequest) String 

func (request GetKeyVersionRequest) String() string

func (GetKeyVersionRequest) ValidateEnumValue 

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

type GetKeyVersionResponse 

type GetKeyVersionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetKeyVersionResponse wrapper for the GetKeyVersion operation

func (GetKeyVersionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetKeyVersionResponse) String 

func (response GetKeyVersionResponse) String() string

type GetPreCoUserCredentialsRequest added in v65.58.0 

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
}

GetPreCoUserCredentialsRequest wrapper for the GetPreCoUserCredentials operation

See also

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

func (GetPreCoUserCredentialsRequest) BinaryRequestBody added in v65.58.0 

func (request GetPreCoUserCredentialsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetPreCoUserCredentialsRequest) HTTPRequest added in v65.58.0 

func (request GetPreCoUserCredentialsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPreCoUserCredentialsRequest) RetryPolicy added in v65.58.0 

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

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

func (GetPreCoUserCredentialsRequest) String added in v65.58.0 

func (request GetPreCoUserCredentialsRequest) String() string

func (GetPreCoUserCredentialsRequest) ValidateEnumValue added in v65.58.0 

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

type GetPreCoUserCredentialsResponse added in v65.58.0 

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"`
}

GetPreCoUserCredentialsResponse wrapper for the GetPreCoUserCredentials operation

func (GetPreCoUserCredentialsResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (GetPreCoUserCredentialsResponse) String added in v65.58.0 

func (response GetPreCoUserCredentialsResponse) String() string

type 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
}

GetReplicationStatusRequest wrapper for the GetReplicationStatus operation

See also

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

func (GetReplicationStatusRequest) BinaryRequestBody 

func (request GetReplicationStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetReplicationStatusRequest) HTTPRequest 

func (request GetReplicationStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetReplicationStatusRequest) RetryPolicy 

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

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

func (GetReplicationStatusRequest) String 

func (request GetReplicationStatusRequest) String() string

func (GetReplicationStatusRequest) ValidateEnumValue 

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

type GetReplicationStatusResponse 

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"`
}

GetReplicationStatusResponse wrapper for the GetReplicationStatus operation

func (GetReplicationStatusResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetReplicationStatusResponse) String 

func (response GetReplicationStatusResponse) String() string

type GetVaultRequest 

type GetVaultRequest struct {

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

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

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

GetVaultRequest wrapper for the GetVault operation

See also

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

func (GetVaultRequest) BinaryRequestBody 

func (request GetVaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetVaultRequest) HTTPRequest 

func (request GetVaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVaultRequest) RetryPolicy 

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

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

func (GetVaultRequest) String 

func (request GetVaultRequest) String() string

func (GetVaultRequest) ValidateEnumValue 

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

type GetVaultResponse 

type GetVaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetVaultResponse wrapper for the GetVault operation

func (GetVaultResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetVaultResponse) String 

func (response GetVaultResponse) String() string

type GetVaultUsageRequest 

type GetVaultUsageRequest struct {

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

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

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

GetVaultUsageRequest wrapper for the GetVaultUsage operation

See also

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

func (GetVaultUsageRequest) BinaryRequestBody 

func (request GetVaultUsageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetVaultUsageRequest) HTTPRequest 

func (request GetVaultUsageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVaultUsageRequest) RetryPolicy 

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

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

func (GetVaultUsageRequest) String 

func (request GetVaultUsageRequest) String() string

func (GetVaultUsageRequest) ValidateEnumValue 

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

type GetVaultUsageResponse 

type GetVaultUsageResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

GetVaultUsageResponse wrapper for the GetVaultUsage operation

func (GetVaultUsageResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetVaultUsageResponse) String 

func (response GetVaultUsageResponse) String() string

type GetWrappingKeyRequest 

type GetWrappingKeyRequest struct {

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

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

GetWrappingKeyRequest wrapper for the GetWrappingKey operation

See also

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

func (GetWrappingKeyRequest) BinaryRequestBody 

func (request GetWrappingKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWrappingKeyRequest) HTTPRequest 

func (request GetWrappingKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWrappingKeyRequest) RetryPolicy 

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

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

func (GetWrappingKeyRequest) String 

func (request GetWrappingKeyRequest) String() string

func (GetWrappingKeyRequest) ValidateEnumValue 

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

type GetWrappingKeyResponse 

type GetWrappingKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetWrappingKeyResponse wrapper for the GetWrappingKey operation

func (GetWrappingKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetWrappingKeyResponse) String 

func (response GetWrappingKeyResponse) String() string

type HsmCluster added in v65.58.0 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

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

HsmCluster Dedicated KMS-HSM Cluster Management

func (HsmCluster) String added in v65.58.0 

func (m HsmCluster) String() string

func (HsmCluster) ValidateEnumValue added in v65.58.0 

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

type HsmClusterCollection added in v65.58.0 

type HsmClusterCollection struct {

	// List of HSM Cluster Summary Objects.
	Items []HsmClusterSummary `mandatory:"true" json:"items"`
}

HsmClusterCollection HsmClusterCollection object with page of HsmClusterSummary objects.

func (HsmClusterCollection) String added in v65.58.0 

func (m HsmClusterCollection) String() string

func (HsmClusterCollection) ValidateEnumValue added in v65.58.0 

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

type HsmClusterLifecycleStateEnum added in v65.58.0 

type HsmClusterLifecycleStateEnum string

HsmClusterLifecycleStateEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for HsmClusterLifecycleStateEnum

func GetHsmClusterLifecycleStateEnumValues added in v65.58.0 

func GetHsmClusterLifecycleStateEnumValues() []HsmClusterLifecycleStateEnum

GetHsmClusterLifecycleStateEnumValues Enumerates the set of values for HsmClusterLifecycleStateEnum

func GetMappingHsmClusterLifecycleStateEnum added in v65.58.0 

func GetMappingHsmClusterLifecycleStateEnum(val string) (HsmClusterLifecycleStateEnum, bool)

GetMappingHsmClusterLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type HsmClusterSummary added in v65.58.0 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

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

HsmClusterSummary An object which encapsulates the details of a given HSM Cluster.

func (HsmClusterSummary) String added in v65.58.0 

func (m HsmClusterSummary) String() string

func (HsmClusterSummary) ValidateEnumValue added in v65.58.0 

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

type HsmPartition added in v65.58.0 

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"`
}

HsmPartition Dedicated KMS-HSM Partition Management

func (HsmPartition) String added in v65.58.0 

func (m HsmPartition) String() string

func (HsmPartition) ValidateEnumValue added in v65.58.0 

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

type HsmPartitionCollection added in v65.58.0 

type HsmPartitionCollection struct {

	// List of HsmPartitionSummaries.
	Items []HsmPartitionSummary `mandatory:"true" json:"items"`
}

HsmPartitionCollection HsmPartitionCollection object with page of HsmPartitionSummary objects. A HsmPartitionSummary object contains details about the corresponding HSM.

func (HsmPartitionCollection) String added in v65.58.0 

func (m HsmPartitionCollection) String() string

func (HsmPartitionCollection) ValidateEnumValue added in v65.58.0 

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

type HsmPartitionLifecycleStateEnum added in v65.58.0 

type HsmPartitionLifecycleStateEnum string

HsmPartitionLifecycleStateEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for HsmPartitionLifecycleStateEnum

func GetHsmPartitionLifecycleStateEnumValues added in v65.58.0 

func GetHsmPartitionLifecycleStateEnumValues() []HsmPartitionLifecycleStateEnum

GetHsmPartitionLifecycleStateEnumValues Enumerates the set of values for HsmPartitionLifecycleStateEnum

func GetMappingHsmPartitionLifecycleStateEnum added in v65.58.0 

func GetMappingHsmPartitionLifecycleStateEnum(val string) (HsmPartitionLifecycleStateEnum, bool)

GetMappingHsmPartitionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type HsmPartitionSummary added in v65.58.0 

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"`
}

HsmPartitionSummary An object which encapsulates the details of a given HSM.

func (HsmPartitionSummary) String added in v65.58.0 

func (m HsmPartitionSummary) String() string

func (HsmPartitionSummary) ValidateEnumValue added in v65.58.0 

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

type ImportKeyDetails 

type ImportKeyDetails struct {

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

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

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

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

	// 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"`
}

ImportKeyDetails The details of the Key that you wish to import.

func (ImportKeyDetails) String 

func (m ImportKeyDetails) String() string

func (ImportKeyDetails) ValidateEnumValue 

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

type ImportKeyDetailsProtectionModeEnum 

type ImportKeyDetailsProtectionModeEnum string

ImportKeyDetailsProtectionModeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ImportKeyDetailsProtectionModeEnum

func GetImportKeyDetailsProtectionModeEnumValues 

func GetImportKeyDetailsProtectionModeEnumValues() []ImportKeyDetailsProtectionModeEnum

GetImportKeyDetailsProtectionModeEnumValues Enumerates the set of values for ImportKeyDetailsProtectionModeEnum

func GetMappingImportKeyDetailsProtectionModeEnum 

func GetMappingImportKeyDetailsProtectionModeEnum(val string) (ImportKeyDetailsProtectionModeEnum, bool)

GetMappingImportKeyDetailsProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum

type ImportKeyRequest 

type ImportKeyRequest struct {

	// ImportKeyDetails
	ImportKeyDetails `contributesTo:"body"`

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

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

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

ImportKeyRequest wrapper for the ImportKey operation

See also

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

func (ImportKeyRequest) BinaryRequestBody 

func (request ImportKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ImportKeyRequest) HTTPRequest 

func (request ImportKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ImportKeyRequest) RetryPolicy 

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

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

func (ImportKeyRequest) String 

func (request ImportKeyRequest) String() string

func (ImportKeyRequest) ValidateEnumValue 

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

type ImportKeyResponse 

type ImportKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ImportKeyResponse wrapper for the ImportKey operation

func (ImportKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ImportKeyResponse) String 

func (response ImportKeyResponse) String() string

type ImportKeyVersionDetails 

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

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

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

ImportKeyVersionDetails The details of the KeyVersion that you wish to import.

func (ImportKeyVersionDetails) String 

func (m ImportKeyVersionDetails) String() string

func (ImportKeyVersionDetails) ValidateEnumValue 

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

type ImportKeyVersionRequest 

type ImportKeyVersionRequest struct {

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

	// ImportKeyVersionDetails
	ImportKeyVersionDetails `contributesTo:"body"`

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

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

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

ImportKeyVersionRequest wrapper for the ImportKeyVersion operation

See also

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

func (ImportKeyVersionRequest) BinaryRequestBody 

func (request ImportKeyVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ImportKeyVersionRequest) HTTPRequest 

func (request ImportKeyVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ImportKeyVersionRequest) RetryPolicy 

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

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

func (ImportKeyVersionRequest) String 

func (request ImportKeyVersionRequest) String() string

func (ImportKeyVersionRequest) ValidateEnumValue 

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

type ImportKeyVersionResponse 

type ImportKeyVersionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ImportKeyVersionResponse wrapper for the ImportKeyVersion operation

func (ImportKeyVersionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ImportKeyVersionResponse) String 

func (response ImportKeyVersionResponse) String() string

type Key 

type Key struct {

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

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

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

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

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

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

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

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

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

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

	// The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
	// A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
	// the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists
	// on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default,
	// a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported.
	// 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"`
}

Key The logical entities that represent one or more key versions, each of which contains cryptographic material.

func (Key) String 

func (m Key) String() string

func (Key) ValidateEnumValue 

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

type KeyLifecycleStateEnum 

type KeyLifecycleStateEnum string

KeyLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeyLifecycleStateEnum

func GetKeyLifecycleStateEnumValues 

func GetKeyLifecycleStateEnumValues() []KeyLifecycleStateEnum

GetKeyLifecycleStateEnumValues Enumerates the set of values for KeyLifecycleStateEnum

func GetMappingKeyLifecycleStateEnum 

func GetMappingKeyLifecycleStateEnum(val string) (KeyLifecycleStateEnum, bool)

GetMappingKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type KeyProtectionModeEnum 

type KeyProtectionModeEnum string

KeyProtectionModeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeyProtectionModeEnum

func GetKeyProtectionModeEnumValues 

func GetKeyProtectionModeEnumValues() []KeyProtectionModeEnum

GetKeyProtectionModeEnumValues Enumerates the set of values for KeyProtectionModeEnum

func GetMappingKeyProtectionModeEnum 

func GetMappingKeyProtectionModeEnum(val string) (KeyProtectionModeEnum, bool)

GetMappingKeyProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum

type KeyReplicaDetails 

type KeyReplicaDetails struct {

	// ReplicationId associated with a key operation
	ReplicationId *string `mandatory:"false" json:"replicationId"`
}

KeyReplicaDetails Key replica details

func (KeyReplicaDetails) String 

func (m KeyReplicaDetails) String() string

func (KeyReplicaDetails) ValidateEnumValue 

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

type KeyShape 

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"`
}

KeyShape The cryptographic properties of a key.

func (KeyShape) String 

func (m KeyShape) String() string

func (KeyShape) ValidateEnumValue 

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

type KeyShapeAlgorithmEnum 

type KeyShapeAlgorithmEnum string

KeyShapeAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeyShapeAlgorithmEnum

func GetKeyShapeAlgorithmEnumValues 

func GetKeyShapeAlgorithmEnumValues() []KeyShapeAlgorithmEnum

GetKeyShapeAlgorithmEnumValues Enumerates the set of values for KeyShapeAlgorithmEnum

func GetMappingKeyShapeAlgorithmEnum 

func GetMappingKeyShapeAlgorithmEnum(val string) (KeyShapeAlgorithmEnum, bool)

GetMappingKeyShapeAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

type KeyShapeCurveIdEnum 

type KeyShapeCurveIdEnum string

KeyShapeCurveIdEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeyShapeCurveIdEnum

func GetKeyShapeCurveIdEnumValues 

func GetKeyShapeCurveIdEnumValues() []KeyShapeCurveIdEnum

GetKeyShapeCurveIdEnumValues Enumerates the set of values for KeyShapeCurveIdEnum

func GetMappingKeyShapeCurveIdEnum 

func GetMappingKeyShapeCurveIdEnum(val string) (KeyShapeCurveIdEnum, bool)

GetMappingKeyShapeCurveIdEnum performs case Insensitive comparison on enum value and return the desired enum

type KeySummary 

type KeySummary struct {

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

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

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

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

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

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

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

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

	// The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
	// A protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside
	// the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's RSA wrapping key which persists
	// on the HSM. All cryptographic operations that use a key with a protection mode of `SOFTWARE` are performed on the server. By default,
	// a key's protection mode is set to `HSM`. You can't change a key's protection mode after the key is created or imported.
	// 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"`
}

KeySummary The details of the Key.

func (KeySummary) String 

func (m KeySummary) String() string

func (KeySummary) ValidateEnumValue 

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

type KeySummaryAlgorithmEnum 

type KeySummaryAlgorithmEnum string

KeySummaryAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeySummaryAlgorithmEnum

func GetKeySummaryAlgorithmEnumValues 

func GetKeySummaryAlgorithmEnumValues() []KeySummaryAlgorithmEnum

GetKeySummaryAlgorithmEnumValues Enumerates the set of values for KeySummaryAlgorithmEnum

func GetMappingKeySummaryAlgorithmEnum 

func GetMappingKeySummaryAlgorithmEnum(val string) (KeySummaryAlgorithmEnum, bool)

GetMappingKeySummaryAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

type KeySummaryLifecycleStateEnum 

type KeySummaryLifecycleStateEnum string

KeySummaryLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeySummaryLifecycleStateEnum

func GetKeySummaryLifecycleStateEnumValues 

func GetKeySummaryLifecycleStateEnumValues() []KeySummaryLifecycleStateEnum

GetKeySummaryLifecycleStateEnumValues Enumerates the set of values for KeySummaryLifecycleStateEnum

func GetMappingKeySummaryLifecycleStateEnum 

func GetMappingKeySummaryLifecycleStateEnum(val string) (KeySummaryLifecycleStateEnum, bool)

GetMappingKeySummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type KeySummaryProtectionModeEnum 

type KeySummaryProtectionModeEnum string

KeySummaryProtectionModeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeySummaryProtectionModeEnum

func GetKeySummaryProtectionModeEnumValues 

func GetKeySummaryProtectionModeEnumValues() []KeySummaryProtectionModeEnum

GetKeySummaryProtectionModeEnumValues Enumerates the set of values for KeySummaryProtectionModeEnum

func GetMappingKeySummaryProtectionModeEnum 

func GetMappingKeySummaryProtectionModeEnum(val string) (KeySummaryProtectionModeEnum, bool)

GetMappingKeySummaryProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum

type KeyVersion 

type KeyVersion struct {

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

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

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

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

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

	// The public key in PEM format. (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"`
}

KeyVersion The details of the KeyVersion associated with the Key.

func (KeyVersion) String 

func (m KeyVersion) String() string

func (KeyVersion) ValidateEnumValue 

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

type KeyVersionLifecycleStateEnum 

type KeyVersionLifecycleStateEnum string

KeyVersionLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeyVersionLifecycleStateEnum

func GetKeyVersionLifecycleStateEnumValues 

func GetKeyVersionLifecycleStateEnumValues() []KeyVersionLifecycleStateEnum

GetKeyVersionLifecycleStateEnumValues Enumerates the set of values for KeyVersionLifecycleStateEnum

func GetMappingKeyVersionLifecycleStateEnum 

func GetMappingKeyVersionLifecycleStateEnum(val string) (KeyVersionLifecycleStateEnum, bool)

GetMappingKeyVersionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type KeyVersionOriginEnum 

type KeyVersionOriginEnum string

KeyVersionOriginEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeyVersionOriginEnum

func GetKeyVersionOriginEnumValues 

func GetKeyVersionOriginEnumValues() []KeyVersionOriginEnum

GetKeyVersionOriginEnumValues Enumerates the set of values for KeyVersionOriginEnum

func GetMappingKeyVersionOriginEnum 

func GetMappingKeyVersionOriginEnum(val string) (KeyVersionOriginEnum, bool)

GetMappingKeyVersionOriginEnum performs case Insensitive comparison on enum value and return the desired enum

type KeyVersionReplicaDetails 

type KeyVersionReplicaDetails struct {

	// ReplicationId associated with a key version operation
	ReplicationId *string `mandatory:"false" json:"replicationId"`
}

KeyVersionReplicaDetails KeyVersion replica details

func (KeyVersionReplicaDetails) String 

func (m KeyVersionReplicaDetails) String() string

func (KeyVersionReplicaDetails) ValidateEnumValue 

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

type KeyVersionSummary 

type KeyVersionSummary struct {

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

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

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

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

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

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

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

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

	ExternalKeyReferenceDetails *ExternalKeyReferenceDetails `mandatory:"false" json:"externalKeyReferenceDetails"`

	// An optional property indicating whether this keyversion is generated from auto rotatation.
	IsAutoRotated *bool `mandatory:"false" json:"isAutoRotated"`
}

KeyVersionSummary The details of the KeyVersion.

func (KeyVersionSummary) String 

func (m KeyVersionSummary) String() string

func (KeyVersionSummary) ValidateEnumValue 

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

type KeyVersionSummaryLifecycleStateEnum 

type KeyVersionSummaryLifecycleStateEnum string

KeyVersionSummaryLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeyVersionSummaryLifecycleStateEnum

func GetKeyVersionSummaryLifecycleStateEnumValues 

func GetKeyVersionSummaryLifecycleStateEnumValues() []KeyVersionSummaryLifecycleStateEnum

GetKeyVersionSummaryLifecycleStateEnumValues Enumerates the set of values for KeyVersionSummaryLifecycleStateEnum

func GetMappingKeyVersionSummaryLifecycleStateEnum 

func GetMappingKeyVersionSummaryLifecycleStateEnum(val string) (KeyVersionSummaryLifecycleStateEnum, bool)

GetMappingKeyVersionSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type KeyVersionSummaryOriginEnum 

type KeyVersionSummaryOriginEnum string

KeyVersionSummaryOriginEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeyVersionSummaryOriginEnum

func GetKeyVersionSummaryOriginEnumValues 

func GetKeyVersionSummaryOriginEnumValues() []KeyVersionSummaryOriginEnum

GetKeyVersionSummaryOriginEnumValues Enumerates the set of values for KeyVersionSummaryOriginEnum

func GetMappingKeyVersionSummaryOriginEnum 

func GetMappingKeyVersionSummaryOriginEnum(val string) (KeyVersionSummaryOriginEnum, bool)

GetMappingKeyVersionSummaryOriginEnum performs case Insensitive comparison on enum value and return the desired enum

type KmsCryptoClient 

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

KmsCryptoClient a client for KmsCrypto

func NewKmsCryptoClientWithConfigurationProvider 

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

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

func NewKmsCryptoClientWithOboToken 

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

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

func (*KmsCryptoClient) ConfigurationProvider 

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

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

func (KmsCryptoClient) Decrypt 

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

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

See also

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

func (KmsCryptoClient) Encrypt 

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

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

See also

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

func (KmsCryptoClient) ExportKey 

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

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

See also

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

func (KmsCryptoClient) GenerateDataEncryptionKey 

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

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

See also

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

func (KmsCryptoClient) Sign 

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

Sign Creates a digital signature for a message or message digest by using the private key of a public-private key pair, also known as an asymmetric key. To verify the generated signature, you can use the Verify (https://docs.cloud.oracle.com/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`.

See also

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

func (KmsCryptoClient) Verify 

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

Verify Verifies a digital signature that was generated by the Sign (https://docs.cloud.oracle.com/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`.

See also

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

type KmsHsmClusterClient added in v65.58.0 

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

KmsHsmClusterClient a client for KmsHsmCluster

func NewKmsHsmClusterClientWithConfigurationProvider added in v65.58.0 

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 added in v65.58.0 

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 (KmsHsmClusterClient) CancelHsmClusterDeletion added in v65.58.0 

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.

See also

Click https://docs.cloud.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 (KmsHsmClusterClient) ChangeHsmClusterCompartment added in v65.58.0 

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.

See also

Click https://docs.cloud.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 (*KmsHsmClusterClient) ConfigurationProvider added in v65.58.0 

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

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

func (KmsHsmClusterClient) CreateHsmCluster added in v65.58.0 

func (client KmsHsmClusterClient) CreateHsmCluster(ctx context.Context, request CreateHsmClusterRequest) (response CreateHsmClusterResponse, err error)

CreateHsmCluster Creates a new HSM cluster resource.

See also

Click https://docs.cloud.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 (KmsHsmClusterClient) DownloadCertificateSigningRequest added in v65.58.0 

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.

See also

Click https://docs.cloud.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 (KmsHsmClusterClient) GetHsmCluster added in v65.58.0 

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.

See also

Click https://docs.cloud.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 (KmsHsmClusterClient) GetHsmPartition added in v65.58.0 

func (client KmsHsmClusterClient) GetHsmPartition(ctx context.Context, request GetHsmPartitionRequest) (response GetHsmPartitionResponse, err error)

GetHsmPartition Retrieves HSM partition details for the specified HSM cluster.

See also

Click https://docs.cloud.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 (KmsHsmClusterClient) GetPreCoUserCredentials added in v65.58.0 

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.

See also

Click https://docs.cloud.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 (KmsHsmClusterClient) ListHsmClusters added in v65.58.0 

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.

See also

Click https://docs.cloud.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 (KmsHsmClusterClient) ListHsmPartitions added in v65.58.0 

func (client KmsHsmClusterClient) ListHsmPartitions(ctx context.Context, request ListHsmPartitionsRequest) (response ListHsmPartitionsResponse, err error)

ListHsmPartitions Lists all HSM partitions within the specified HSM Cluster resource.

See also

Click https://docs.cloud.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 (KmsHsmClusterClient) ScheduleHsmClusterDeletion added in v65.58.0 

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.

See also

Click https://docs.cloud.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 (*KmsHsmClusterClient) SetRegion added in v65.58.0 

func (client *KmsHsmClusterClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (KmsHsmClusterClient) UpdateHsmCluster added in v65.58.0 

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.

See also

Click https://docs.cloud.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 (KmsHsmClusterClient) UploadPartitionCertificates added in v65.58.0 

func (client KmsHsmClusterClient) UploadPartitionCertificates(ctx context.Context, request UploadPartitionCertificatesRequest) (response UploadPartitionCertificatesResponse, err error)

UploadPartitionCertificates Uploads the partition owner certificates to the HSM Cluster resource.

See also

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

type KmsManagementClient 

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

KmsManagementClient a client for KmsManagement

func NewKmsManagementClientWithConfigurationProvider 

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

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

func NewKmsManagementClientWithOboToken 

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

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

func (KmsManagementClient) BackupKey 

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

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

See also

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

func (KmsManagementClient) CancelKeyDeletion 

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

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

See also

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

func (KmsManagementClient) CancelKeyVersionDeletion 

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

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

See also

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

func (KmsManagementClient) ChangeKeyCompartment 

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

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

See also

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

func (*KmsManagementClient) ConfigurationProvider 

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

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

func (KmsManagementClient) CreateKey 

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

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

See also

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

func (KmsManagementClient) CreateKeyVersion 

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

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

See also

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

func (KmsManagementClient) DisableKey 

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

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

See also

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

func (KmsManagementClient) EnableKey 

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

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

See also

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

func (KmsManagementClient) GetKey 

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

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

See also

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

func (KmsManagementClient) GetKeyVersion 

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

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

See also

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

func (KmsManagementClient) GetReplicationStatus 

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.

See also

Click https://docs.cloud.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 (KmsManagementClient) GetWrappingKey 

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

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

See also

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

func (KmsManagementClient) ImportKey 

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

ImportKey Imports AES 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.

See also

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

func (KmsManagementClient) ImportKeyVersion 

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

ImportKeyVersion Imports AES key material to create a new key version 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.

See also

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

func (KmsManagementClient) ListKeyVersions 

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

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

See also

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

func (KmsManagementClient) ListKeys 

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

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

See also

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

func (KmsManagementClient) RestoreKeyFromFile 

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

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

See also

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

func (KmsManagementClient) RestoreKeyFromObjectStore 

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

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

See also

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

func (KmsManagementClient) ScheduleKeyDeletion 

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

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

See also

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

func (KmsManagementClient) ScheduleKeyVersionDeletion 

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

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

See also

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

func (KmsManagementClient) UpdateKey 

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

UpdateKey Updates the properties of a master encryption key. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, the key must 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.

See also

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

type KmsVaultClient 

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

KmsVaultClient a client for KmsVault

func NewKmsVaultClientWithConfigurationProvider 

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

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

func NewKmsVaultClientWithOboToken 

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

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

as well as reading the region

func (KmsVaultClient) BackupVault 

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

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

See also

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

func (KmsVaultClient) CancelVaultDeletion 

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

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

See also

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

func (KmsVaultClient) ChangeVaultCompartment 

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

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

See also

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

func (*KmsVaultClient) ConfigurationProvider 

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

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

func (KmsVaultClient) CreateVault 

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

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

See also

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

func (KmsVaultClient) CreateVaultReplica 

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.

See also

Click https://docs.cloud.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 (KmsVaultClient) DeleteVaultReplica 

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.

See also

Click https://docs.cloud.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 (KmsVaultClient) GetVault 

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

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

See also

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

func (KmsVaultClient) GetVaultUsage 

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

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

See also

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

func (KmsVaultClient) ListVaultReplicas 

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.

See also

Click https://docs.cloud.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 (KmsVaultClient) ListVaults 

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

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

See also

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

func (KmsVaultClient) RestoreVaultFromFile 

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

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

See also

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

func (KmsVaultClient) RestoreVaultFromObjectStore 

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

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

See also

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

func (KmsVaultClient) ScheduleVaultDeletion 

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

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

See also

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

func (*KmsVaultClient) SetRegion 

func (client *KmsVaultClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (KmsVaultClient) UpdateVault 

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

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

See also

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

type ListEkmsPrivateEndpointsRequest added in v65.49.2 

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
}

ListEkmsPrivateEndpointsRequest wrapper for the ListEkmsPrivateEndpoints operation

See also

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

func (ListEkmsPrivateEndpointsRequest) BinaryRequestBody added in v65.49.2 

func (request ListEkmsPrivateEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListEkmsPrivateEndpointsRequest) HTTPRequest added in v65.49.2 

func (request ListEkmsPrivateEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListEkmsPrivateEndpointsRequest) RetryPolicy added in v65.49.2 

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

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

func (ListEkmsPrivateEndpointsRequest) String added in v65.49.2 

func (request ListEkmsPrivateEndpointsRequest) String() string

func (ListEkmsPrivateEndpointsRequest) ValidateEnumValue added in v65.49.2 

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

type ListEkmsPrivateEndpointsResponse added in v65.49.2 

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.cloud.oracle.com/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"`
}

ListEkmsPrivateEndpointsResponse wrapper for the ListEkmsPrivateEndpoints operation

func (ListEkmsPrivateEndpointsResponse) HTTPResponse added in v65.49.2 

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

HTTPResponse implements the OCIResponse interface

func (ListEkmsPrivateEndpointsResponse) String added in v65.49.2 

func (response ListEkmsPrivateEndpointsResponse) String() string

type ListEkmsPrivateEndpointsSortByEnum added in v65.49.2 

type ListEkmsPrivateEndpointsSortByEnum string

ListEkmsPrivateEndpointsSortByEnum Enum with underlying type: string 

const (
	ListEkmsPrivateEndpointsSortByTimecreated ListEkmsPrivateEndpointsSortByEnum = "TIMECREATED"
	ListEkmsPrivateEndpointsSortByDisplayname ListEkmsPrivateEndpointsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListEkmsPrivateEndpointsSortByEnum

func GetListEkmsPrivateEndpointsSortByEnumValues added in v65.49.2 

func GetListEkmsPrivateEndpointsSortByEnumValues() []ListEkmsPrivateEndpointsSortByEnum

GetListEkmsPrivateEndpointsSortByEnumValues Enumerates the set of values for ListEkmsPrivateEndpointsSortByEnum

func GetMappingListEkmsPrivateEndpointsSortByEnum added in v65.49.2 

func GetMappingListEkmsPrivateEndpointsSortByEnum(val string) (ListEkmsPrivateEndpointsSortByEnum, bool)

GetMappingListEkmsPrivateEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListEkmsPrivateEndpointsSortOrderEnum added in v65.49.2 

type ListEkmsPrivateEndpointsSortOrderEnum string

ListEkmsPrivateEndpointsSortOrderEnum Enum with underlying type: string 

const (
	ListEkmsPrivateEndpointsSortOrderAsc  ListEkmsPrivateEndpointsSortOrderEnum = "ASC"
	ListEkmsPrivateEndpointsSortOrderDesc ListEkmsPrivateEndpointsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListEkmsPrivateEndpointsSortOrderEnum

func GetListEkmsPrivateEndpointsSortOrderEnumValues added in v65.49.2 

func GetListEkmsPrivateEndpointsSortOrderEnumValues() []ListEkmsPrivateEndpointsSortOrderEnum

GetListEkmsPrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListEkmsPrivateEndpointsSortOrderEnum

func GetMappingListEkmsPrivateEndpointsSortOrderEnum added in v65.49.2 

func GetMappingListEkmsPrivateEndpointsSortOrderEnum(val string) (ListEkmsPrivateEndpointsSortOrderEnum, bool)

GetMappingListEkmsPrivateEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListHsmClustersRequest added in v65.58.0 

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
}

ListHsmClustersRequest wrapper for the ListHsmClusters operation

See also

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

func (ListHsmClustersRequest) BinaryRequestBody added in v65.58.0 

func (request ListHsmClustersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListHsmClustersRequest) HTTPRequest added in v65.58.0 

func (request ListHsmClustersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListHsmClustersRequest) RetryPolicy added in v65.58.0 

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

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

func (ListHsmClustersRequest) String added in v65.58.0 

func (request ListHsmClustersRequest) String() string

func (ListHsmClustersRequest) ValidateEnumValue added in v65.58.0 

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

type ListHsmClustersResponse added in v65.58.0 

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.cloud.oracle.com/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"`
}

ListHsmClustersResponse wrapper for the ListHsmClusters operation

func (ListHsmClustersResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (ListHsmClustersResponse) String added in v65.58.0 

func (response ListHsmClustersResponse) String() string

type ListHsmClustersSortByEnum added in v65.58.0 

type ListHsmClustersSortByEnum string

ListHsmClustersSortByEnum Enum with underlying type: string 

const (
	ListHsmClustersSortByTimecreated ListHsmClustersSortByEnum = "TIMECREATED"
	ListHsmClustersSortByDisplayname ListHsmClustersSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListHsmClustersSortByEnum

func GetListHsmClustersSortByEnumValues added in v65.58.0 

func GetListHsmClustersSortByEnumValues() []ListHsmClustersSortByEnum

GetListHsmClustersSortByEnumValues Enumerates the set of values for ListHsmClustersSortByEnum

func GetMappingListHsmClustersSortByEnum added in v65.58.0 

func GetMappingListHsmClustersSortByEnum(val string) (ListHsmClustersSortByEnum, bool)

GetMappingListHsmClustersSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListHsmClustersSortOrderEnum added in v65.58.0 

type ListHsmClustersSortOrderEnum string

ListHsmClustersSortOrderEnum Enum with underlying type: string 

const (
	ListHsmClustersSortOrderAsc  ListHsmClustersSortOrderEnum = "ASC"
	ListHsmClustersSortOrderDesc ListHsmClustersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListHsmClustersSortOrderEnum

func GetListHsmClustersSortOrderEnumValues added in v65.58.0 

func GetListHsmClustersSortOrderEnumValues() []ListHsmClustersSortOrderEnum

GetListHsmClustersSortOrderEnumValues Enumerates the set of values for ListHsmClustersSortOrderEnum

func GetMappingListHsmClustersSortOrderEnum added in v65.58.0 

func GetMappingListHsmClustersSortOrderEnum(val string) (ListHsmClustersSortOrderEnum, bool)

GetMappingListHsmClustersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListHsmPartitionsRequest added in v65.58.0 

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
}

ListHsmPartitionsRequest wrapper for the ListHsmPartitions operation

See also

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

func (ListHsmPartitionsRequest) BinaryRequestBody added in v65.58.0 

func (request ListHsmPartitionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListHsmPartitionsRequest) HTTPRequest added in v65.58.0 

func (request ListHsmPartitionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListHsmPartitionsRequest) RetryPolicy added in v65.58.0 

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

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

func (ListHsmPartitionsRequest) String added in v65.58.0 

func (request ListHsmPartitionsRequest) String() string

func (ListHsmPartitionsRequest) ValidateEnumValue added in v65.58.0 

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

type ListHsmPartitionsResponse added in v65.58.0 

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.cloud.oracle.com/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"`
}

ListHsmPartitionsResponse wrapper for the ListHsmPartitions operation

func (ListHsmPartitionsResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (ListHsmPartitionsResponse) String added in v65.58.0 

func (response ListHsmPartitionsResponse) String() string

type ListHsmPartitionsSortByEnum added in v65.58.0 

type ListHsmPartitionsSortByEnum string

ListHsmPartitionsSortByEnum Enum with underlying type: string 

const (
	ListHsmPartitionsSortByTimecreated ListHsmPartitionsSortByEnum = "TIMECREATED"
	ListHsmPartitionsSortByDisplayname ListHsmPartitionsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListHsmPartitionsSortByEnum

func GetListHsmPartitionsSortByEnumValues added in v65.58.0 

func GetListHsmPartitionsSortByEnumValues() []ListHsmPartitionsSortByEnum

GetListHsmPartitionsSortByEnumValues Enumerates the set of values for ListHsmPartitionsSortByEnum

func GetMappingListHsmPartitionsSortByEnum added in v65.58.0 

func GetMappingListHsmPartitionsSortByEnum(val string) (ListHsmPartitionsSortByEnum, bool)

GetMappingListHsmPartitionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListHsmPartitionsSortOrderEnum added in v65.58.0 

type ListHsmPartitionsSortOrderEnum string

ListHsmPartitionsSortOrderEnum Enum with underlying type: string 

const (
	ListHsmPartitionsSortOrderAsc  ListHsmPartitionsSortOrderEnum = "ASC"
	ListHsmPartitionsSortOrderDesc ListHsmPartitionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListHsmPartitionsSortOrderEnum

func GetListHsmPartitionsSortOrderEnumValues added in v65.58.0 

func GetListHsmPartitionsSortOrderEnumValues() []ListHsmPartitionsSortOrderEnum

GetListHsmPartitionsSortOrderEnumValues Enumerates the set of values for ListHsmPartitionsSortOrderEnum

func GetMappingListHsmPartitionsSortOrderEnum added in v65.58.0 

func GetMappingListHsmPartitionsSortOrderEnum(val string) (ListHsmPartitionsSortOrderEnum, bool)

GetMappingListHsmPartitionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListKeyVersionsRequest 

type ListKeyVersionsRequest struct {

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

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

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

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

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

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

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

ListKeyVersionsRequest wrapper for the ListKeyVersions operation

See also

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

func (ListKeyVersionsRequest) BinaryRequestBody 

func (request ListKeyVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListKeyVersionsRequest) HTTPRequest 

func (request ListKeyVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListKeyVersionsRequest) RetryPolicy 

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

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

func (ListKeyVersionsRequest) String 

func (request ListKeyVersionsRequest) String() string

func (ListKeyVersionsRequest) ValidateEnumValue 

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

type ListKeyVersionsResponse 

type ListKeyVersionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then there are additional items still to get. Include this value as the `page` parameter for the
	// subsequent GET request. For information about pagination, see
	// List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#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"`
}

ListKeyVersionsResponse wrapper for the ListKeyVersions operation

func (ListKeyVersionsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListKeyVersionsResponse) String 

func (response ListKeyVersionsResponse) String() string

type ListKeyVersionsSortByEnum 

type ListKeyVersionsSortByEnum string

ListKeyVersionsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeyVersionsSortByEnum

func GetListKeyVersionsSortByEnumValues 

func GetListKeyVersionsSortByEnumValues() []ListKeyVersionsSortByEnum

GetListKeyVersionsSortByEnumValues Enumerates the set of values for ListKeyVersionsSortByEnum

func GetMappingListKeyVersionsSortByEnum 

func GetMappingListKeyVersionsSortByEnum(val string) (ListKeyVersionsSortByEnum, bool)

GetMappingListKeyVersionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListKeyVersionsSortOrderEnum 

type ListKeyVersionsSortOrderEnum string

ListKeyVersionsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeyVersionsSortOrderEnum

func GetListKeyVersionsSortOrderEnumValues 

func GetListKeyVersionsSortOrderEnumValues() []ListKeyVersionsSortOrderEnum

GetListKeyVersionsSortOrderEnumValues Enumerates the set of values for ListKeyVersionsSortOrderEnum

func GetMappingListKeyVersionsSortOrderEnum 

func GetMappingListKeyVersionsSortOrderEnum(val string) (ListKeyVersionsSortOrderEnum, bool)

GetMappingListKeyVersionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListKeysAlgorithmEnum 

type ListKeysAlgorithmEnum string

ListKeysAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeysAlgorithmEnum

func GetListKeysAlgorithmEnumValues 

func GetListKeysAlgorithmEnumValues() []ListKeysAlgorithmEnum

GetListKeysAlgorithmEnumValues Enumerates the set of values for ListKeysAlgorithmEnum

func GetMappingListKeysAlgorithmEnum 

func GetMappingListKeysAlgorithmEnum(val string) (ListKeysAlgorithmEnum, bool)

GetMappingListKeysAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

type ListKeysCurveIdEnum 

type ListKeysCurveIdEnum string

ListKeysCurveIdEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeysCurveIdEnum

func GetListKeysCurveIdEnumValues 

func GetListKeysCurveIdEnumValues() []ListKeysCurveIdEnum

GetListKeysCurveIdEnumValues Enumerates the set of values for ListKeysCurveIdEnum

func GetMappingListKeysCurveIdEnum 

func GetMappingListKeysCurveIdEnum(val string) (ListKeysCurveIdEnum, bool)

GetMappingListKeysCurveIdEnum performs case Insensitive comparison on enum value and return the desired enum

type ListKeysProtectionModeEnum 

type ListKeysProtectionModeEnum string

ListKeysProtectionModeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeysProtectionModeEnum

func GetListKeysProtectionModeEnumValues 

func GetListKeysProtectionModeEnumValues() []ListKeysProtectionModeEnum

GetListKeysProtectionModeEnumValues Enumerates the set of values for ListKeysProtectionModeEnum

func GetMappingListKeysProtectionModeEnum 

func GetMappingListKeysProtectionModeEnum(val string) (ListKeysProtectionModeEnum, bool)

GetMappingListKeysProtectionModeEnum performs case Insensitive comparison on enum value and return the desired enum

type ListKeysRequest 

type ListKeysRequest struct {

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

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

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

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

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

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

	// A key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A
	// protection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are
	// performed inside the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's
	// RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of
	// `SOFTWARE` are performed on the server.
	// 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
}

ListKeysRequest wrapper for the ListKeys operation

See also

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

func (ListKeysRequest) BinaryRequestBody 

func (request ListKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListKeysRequest) HTTPRequest 

func (request ListKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListKeysRequest) RetryPolicy 

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

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

func (ListKeysRequest) String 

func (request ListKeysRequest) String() string

func (ListKeysRequest) ValidateEnumValue 

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

type ListKeysResponse 

type ListKeysResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then there are additional items still to get. Include this value as the `page` parameter for the
	// subsequent GET request. For information about pagination, see
	// List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#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"`
}

ListKeysResponse wrapper for the ListKeys operation

func (ListKeysResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListKeysResponse) String 

func (response ListKeysResponse) String() string

type ListKeysSortByEnum 

type ListKeysSortByEnum string

ListKeysSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeysSortByEnum

func GetListKeysSortByEnumValues 

func GetListKeysSortByEnumValues() []ListKeysSortByEnum

GetListKeysSortByEnumValues Enumerates the set of values for ListKeysSortByEnum

func GetMappingListKeysSortByEnum 

func GetMappingListKeysSortByEnum(val string) (ListKeysSortByEnum, bool)

GetMappingListKeysSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListKeysSortOrderEnum 

type ListKeysSortOrderEnum string

ListKeysSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeysSortOrderEnum

func GetListKeysSortOrderEnumValues 

func GetListKeysSortOrderEnumValues() []ListKeysSortOrderEnum

GetListKeysSortOrderEnumValues Enumerates the set of values for ListKeysSortOrderEnum

func GetMappingListKeysSortOrderEnum 

func GetMappingListKeysSortOrderEnum(val string) (ListKeysSortOrderEnum, bool)

GetMappingListKeysSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListVaultReplicasRequest wrapper for the ListVaultReplicas operation

See also

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

func (ListVaultReplicasRequest) BinaryRequestBody 

func (request ListVaultReplicasRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListVaultReplicasRequest) HTTPRequest 

func (request ListVaultReplicasRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVaultReplicasRequest) RetryPolicy 

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

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

func (ListVaultReplicasRequest) String 

func (request ListVaultReplicasRequest) String() string

func (ListVaultReplicasRequest) ValidateEnumValue 

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

type ListVaultReplicasResponse 

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.cloud.oracle.com/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"`
}

ListVaultReplicasResponse wrapper for the ListVaultReplicas operation

func (ListVaultReplicasResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListVaultReplicasResponse) String 

func (response ListVaultReplicasResponse) String() string

type ListVaultReplicasSortByEnum 

type ListVaultReplicasSortByEnum string

ListVaultReplicasSortByEnum Enum with underlying type: string 

const (
	ListVaultReplicasSortByTimecreated ListVaultReplicasSortByEnum = "TIMECREATED"
	ListVaultReplicasSortByDisplayname ListVaultReplicasSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListVaultReplicasSortByEnum

func GetListVaultReplicasSortByEnumValues 

func GetListVaultReplicasSortByEnumValues() []ListVaultReplicasSortByEnum

GetListVaultReplicasSortByEnumValues Enumerates the set of values for ListVaultReplicasSortByEnum

func GetMappingListVaultReplicasSortByEnum 

func GetMappingListVaultReplicasSortByEnum(val string) (ListVaultReplicasSortByEnum, bool)

GetMappingListVaultReplicasSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListVaultReplicasSortOrderEnum 

type ListVaultReplicasSortOrderEnum string

ListVaultReplicasSortOrderEnum Enum with underlying type: string 

const (
	ListVaultReplicasSortOrderAsc  ListVaultReplicasSortOrderEnum = "ASC"
	ListVaultReplicasSortOrderDesc ListVaultReplicasSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListVaultReplicasSortOrderEnum

func GetListVaultReplicasSortOrderEnumValues 

func GetListVaultReplicasSortOrderEnumValues() []ListVaultReplicasSortOrderEnum

GetListVaultReplicasSortOrderEnumValues Enumerates the set of values for ListVaultReplicasSortOrderEnum

func GetMappingListVaultReplicasSortOrderEnum 

func GetMappingListVaultReplicasSortOrderEnum(val string) (ListVaultReplicasSortOrderEnum, bool)

GetMappingListVaultReplicasSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListVaultsRequest 

type ListVaultsRequest struct {

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

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

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

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

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

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

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

ListVaultsRequest wrapper for the ListVaults operation

See also

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

func (ListVaultsRequest) BinaryRequestBody 

func (request ListVaultsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListVaultsRequest) HTTPRequest 

func (request ListVaultsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVaultsRequest) RetryPolicy 

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

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

func (ListVaultsRequest) String 

func (request ListVaultsRequest) String() string

func (ListVaultsRequest) ValidateEnumValue 

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

type ListVaultsResponse 

type ListVaultsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then there are additional items still to get. Include this value as the `page` parameter for the
	// subsequent GET request. For information about pagination, see
	// List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#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"`
}

ListVaultsResponse wrapper for the ListVaults operation

func (ListVaultsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListVaultsResponse) String 

func (response ListVaultsResponse) String() string

type ListVaultsSortByEnum 

type ListVaultsSortByEnum string

ListVaultsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListVaultsSortByEnum

func GetListVaultsSortByEnumValues 

func GetListVaultsSortByEnumValues() []ListVaultsSortByEnum

GetListVaultsSortByEnumValues Enumerates the set of values for ListVaultsSortByEnum

func GetMappingListVaultsSortByEnum 

func GetMappingListVaultsSortByEnum(val string) (ListVaultsSortByEnum, bool)

GetMappingListVaultsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListVaultsSortOrderEnum 

type ListVaultsSortOrderEnum string

ListVaultsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListVaultsSortOrderEnum

func GetListVaultsSortOrderEnumValues 

func GetListVaultsSortOrderEnumValues() []ListVaultsSortOrderEnum

GetListVaultsSortOrderEnumValues Enumerates the set of values for ListVaultsSortOrderEnum

func GetMappingListVaultsSortOrderEnum 

func GetMappingListVaultsSortOrderEnum(val string) (ListVaultsSortOrderEnum, bool)

GetMappingListVaultsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type OauthMetadata added in v65.49.2 

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"`
}

OauthMetadata Authorization details required to get access token from IDP for accessing protected resources.

func (OauthMetadata) String added in v65.49.2 

func (m OauthMetadata) String() string

func (OauthMetadata) ValidateEnumValue added in v65.49.2 

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

type OauthMetadataSummary added in v65.49.2 

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"`
}

OauthMetadataSummary Summary about authorization to be returned to the customer as a response.

func (OauthMetadataSummary) String added in v65.49.2 

func (m OauthMetadataSummary) String() string

func (OauthMetadataSummary) ValidateEnumValue added in v65.49.2 

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

type PortInformation added in v65.58.0 

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"`
}

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)

func (PortInformation) String added in v65.58.0 

func (m PortInformation) String() string

func (PortInformation) ValidateEnumValue added in v65.58.0 

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

type PortInformationPortTypeEnum added in v65.58.0 

type PortInformationPortTypeEnum string

PortInformationPortTypeEnum Enum with underlying type: string 

const (
	PortInformationPortTypeClientutility     PortInformationPortTypeEnum = "CLIENTUTILITY"
	PortInformationPortTypeManagementutility PortInformationPortTypeEnum = "MANAGEMENTUTILITY"
)

Set of constants representing the allowable values for PortInformationPortTypeEnum

func GetMappingPortInformationPortTypeEnum added in v65.58.0 

func GetMappingPortInformationPortTypeEnum(val string) (PortInformationPortTypeEnum, bool)

GetMappingPortInformationPortTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetPortInformationPortTypeEnumValues added in v65.58.0 

func GetPortInformationPortTypeEnumValues() []PortInformationPortTypeEnum

GetPortInformationPortTypeEnumValues Enumerates the set of values for PortInformationPortTypeEnum

type PreCoUserCredentials added in v65.58.0 

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"`
}

PreCoUserCredentials Pre Crypto officer user credentials.

func (PreCoUserCredentials) String added in v65.58.0 

func (m PreCoUserCredentials) String() string

func (PreCoUserCredentials) ValidateEnumValue added in v65.58.0 

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

type ReplicaDetails 

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"`
}

ReplicaDetails Details of replication status

func (ReplicaDetails) String 

func (m ReplicaDetails) String() string

func (ReplicaDetails) ValidateEnumValue 

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

type ReplicaDetailsStatusEnum 

type ReplicaDetailsStatusEnum string

ReplicaDetailsStatusEnum Enum with underlying type: string 

const (
	ReplicaDetailsStatusReplicating ReplicaDetailsStatusEnum = "REPLICATING"
	ReplicaDetailsStatusReplicated  ReplicaDetailsStatusEnum = "REPLICATED"
)

Set of constants representing the allowable values for ReplicaDetailsStatusEnum

func GetMappingReplicaDetailsStatusEnum 

func GetMappingReplicaDetailsStatusEnum(val string) (ReplicaDetailsStatusEnum, bool)

GetMappingReplicaDetailsStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetReplicaDetailsStatusEnumValues 

func GetReplicaDetailsStatusEnumValues() []ReplicaDetailsStatusEnum

GetReplicaDetailsStatusEnumValues Enumerates the set of values for ReplicaDetailsStatusEnum

type ReplicationStatusDetails 

type ReplicationStatusDetails struct {

	// Replica Details.
	ReplicaDetails []ReplicaDetails `mandatory:"false" json:"replicaDetails"`
}

ReplicationStatusDetails Details of replication status across all replica regions

func (ReplicationStatusDetails) String 

func (m ReplicationStatusDetails) String() string

func (ReplicationStatusDetails) ValidateEnumValue 

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

type RestoreKeyFromFileRequest 

type RestoreKeyFromFileRequest struct {

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

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

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

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

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

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

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

RestoreKeyFromFileRequest wrapper for the RestoreKeyFromFile operation

See also

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

func (RestoreKeyFromFileRequest) BinaryRequestBody 

func (request RestoreKeyFromFileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RestoreKeyFromFileRequest) HTTPRequest 

func (request RestoreKeyFromFileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreKeyFromFileRequest) RetryPolicy 

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

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

func (RestoreKeyFromFileRequest) String 

func (request RestoreKeyFromFileRequest) String() string

func (RestoreKeyFromFileRequest) ValidateEnumValue 

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

type RestoreKeyFromFileResponse 

type RestoreKeyFromFileResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

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

RestoreKeyFromFileResponse wrapper for the RestoreKeyFromFile operation

func (RestoreKeyFromFileResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RestoreKeyFromFileResponse) String 

func (response RestoreKeyFromFileResponse) String() string

type RestoreKeyFromObjectStoreDetails 

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

RestoreKeyFromObjectStoreDetails The details of the backup location from which you want to restore the Key.

func (RestoreKeyFromObjectStoreDetails) String 

func (m RestoreKeyFromObjectStoreDetails) String() string

func (*RestoreKeyFromObjectStoreDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (RestoreKeyFromObjectStoreDetails) ValidateEnumValue 

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

type RestoreKeyFromObjectStoreRequest 

type RestoreKeyFromObjectStoreRequest struct {

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

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

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

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

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

RestoreKeyFromObjectStoreRequest wrapper for the RestoreKeyFromObjectStore operation

See also

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

func (RestoreKeyFromObjectStoreRequest) BinaryRequestBody 

func (request RestoreKeyFromObjectStoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RestoreKeyFromObjectStoreRequest) HTTPRequest 

func (request RestoreKeyFromObjectStoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreKeyFromObjectStoreRequest) RetryPolicy 

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

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

func (RestoreKeyFromObjectStoreRequest) String 

func (request RestoreKeyFromObjectStoreRequest) String() string

func (RestoreKeyFromObjectStoreRequest) ValidateEnumValue 

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

type RestoreKeyFromObjectStoreResponse 

type RestoreKeyFromObjectStoreResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

RestoreKeyFromObjectStoreResponse wrapper for the RestoreKeyFromObjectStore operation

func (RestoreKeyFromObjectStoreResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RestoreKeyFromObjectStoreResponse) String 

func (response RestoreKeyFromObjectStoreResponse) String() string

type RestoreVaultFromFileRequest 

type RestoreVaultFromFileRequest struct {

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

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

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

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

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

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

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

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

RestoreVaultFromFileRequest wrapper for the RestoreVaultFromFile operation

See also

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

func (RestoreVaultFromFileRequest) BinaryRequestBody 

func (request RestoreVaultFromFileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RestoreVaultFromFileRequest) HTTPRequest 

func (request RestoreVaultFromFileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreVaultFromFileRequest) RetryPolicy 

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

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

func (RestoreVaultFromFileRequest) String 

func (request RestoreVaultFromFileRequest) String() string

func (RestoreVaultFromFileRequest) ValidateEnumValue 

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

type RestoreVaultFromFileResponse 

type RestoreVaultFromFileResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

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

RestoreVaultFromFileResponse wrapper for the RestoreVaultFromFile operation

func (RestoreVaultFromFileResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RestoreVaultFromFileResponse) String 

func (response RestoreVaultFromFileResponse) String() string

type RestoreVaultFromObjectStoreDetails 

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

RestoreVaultFromObjectStoreDetails The details of the backup location from which you want to restore the Vault.

func (RestoreVaultFromObjectStoreDetails) String 

func (m RestoreVaultFromObjectStoreDetails) String() string

func (*RestoreVaultFromObjectStoreDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (RestoreVaultFromObjectStoreDetails) ValidateEnumValue 

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

type RestoreVaultFromObjectStoreRequest 

type RestoreVaultFromObjectStoreRequest struct {

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

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

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

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

	// RestoreVaultFromObjectStoreDetails
	RestoreVaultFromObjectStoreDetails `contributesTo:"body"`

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

RestoreVaultFromObjectStoreRequest wrapper for the RestoreVaultFromObjectStore operation

See also

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

func (RestoreVaultFromObjectStoreRequest) BinaryRequestBody 

func (request RestoreVaultFromObjectStoreRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RestoreVaultFromObjectStoreRequest) HTTPRequest 

func (request RestoreVaultFromObjectStoreRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestoreVaultFromObjectStoreRequest) RetryPolicy 

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

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

func (RestoreVaultFromObjectStoreRequest) String 

func (request RestoreVaultFromObjectStoreRequest) String() string

func (RestoreVaultFromObjectStoreRequest) ValidateEnumValue 

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

type RestoreVaultFromObjectStoreResponse 

type RestoreVaultFromObjectStoreResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

RestoreVaultFromObjectStoreResponse wrapper for the RestoreVaultFromObjectStore operation

func (RestoreVaultFromObjectStoreResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RestoreVaultFromObjectStoreResponse) String 

func (response RestoreVaultFromObjectStoreResponse) String() string

type ScheduleHsmClusterDeletionDetails added in v65.58.0 

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"`
}

ScheduleHsmClusterDeletionDetails Details for scheduling HSM resource deletion.

func (ScheduleHsmClusterDeletionDetails) String added in v65.58.0 

func (m ScheduleHsmClusterDeletionDetails) String() string

func (ScheduleHsmClusterDeletionDetails) ValidateEnumValue added in v65.58.0 

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

type ScheduleHsmClusterDeletionRequest added in v65.58.0 

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
}

ScheduleHsmClusterDeletionRequest wrapper for the ScheduleHsmClusterDeletion operation

See also

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

func (ScheduleHsmClusterDeletionRequest) BinaryRequestBody added in v65.58.0 

func (request ScheduleHsmClusterDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ScheduleHsmClusterDeletionRequest) HTTPRequest added in v65.58.0 

func (request ScheduleHsmClusterDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScheduleHsmClusterDeletionRequest) RetryPolicy added in v65.58.0 

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

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

func (ScheduleHsmClusterDeletionRequest) String added in v65.58.0 

func (request ScheduleHsmClusterDeletionRequest) String() string

func (ScheduleHsmClusterDeletionRequest) ValidateEnumValue added in v65.58.0 

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

type ScheduleHsmClusterDeletionResponse added in v65.58.0 

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"`
}

ScheduleHsmClusterDeletionResponse wrapper for the ScheduleHsmClusterDeletion operation

func (ScheduleHsmClusterDeletionResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (ScheduleHsmClusterDeletionResponse) String added in v65.58.0 

func (response ScheduleHsmClusterDeletionResponse) String() string

type ScheduleKeyDeletionDetails 

type ScheduleKeyDeletionDetails struct {

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

ScheduleKeyDeletionDetails Details for scheduling key deletion.

func (ScheduleKeyDeletionDetails) String 

func (m ScheduleKeyDeletionDetails) String() string

func (ScheduleKeyDeletionDetails) ValidateEnumValue 

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

type ScheduleKeyDeletionRequest 

type ScheduleKeyDeletionRequest struct {

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

	// ScheduleKeyDeletionDetails
	ScheduleKeyDeletionDetails `contributesTo:"body"`

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

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

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

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

ScheduleKeyDeletionRequest wrapper for the ScheduleKeyDeletion operation

See also

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

func (ScheduleKeyDeletionRequest) BinaryRequestBody 

func (request ScheduleKeyDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ScheduleKeyDeletionRequest) HTTPRequest 

func (request ScheduleKeyDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScheduleKeyDeletionRequest) RetryPolicy 

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

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

func (ScheduleKeyDeletionRequest) String 

func (request ScheduleKeyDeletionRequest) String() string

func (ScheduleKeyDeletionRequest) ValidateEnumValue 

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

type ScheduleKeyDeletionResponse 

type ScheduleKeyDeletionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ScheduleKeyDeletionResponse wrapper for the ScheduleKeyDeletion operation

func (ScheduleKeyDeletionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ScheduleKeyDeletionResponse) String 

func (response ScheduleKeyDeletionResponse) String() string

type ScheduleKeyVersionDeletionDetails 

type ScheduleKeyVersionDeletionDetails struct {

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

ScheduleKeyVersionDeletionDetails Details for scheduling key version deletion.

func (ScheduleKeyVersionDeletionDetails) String 

func (m ScheduleKeyVersionDeletionDetails) String() string

func (ScheduleKeyVersionDeletionDetails) ValidateEnumValue 

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

type ScheduleKeyVersionDeletionRequest 

type ScheduleKeyVersionDeletionRequest struct {

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

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

	// ScheduleKeyVersionDeletionDetails
	ScheduleKeyVersionDeletionDetails `contributesTo:"body"`

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

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

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

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

ScheduleKeyVersionDeletionRequest wrapper for the ScheduleKeyVersionDeletion operation

See also

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

func (ScheduleKeyVersionDeletionRequest) BinaryRequestBody 

func (request ScheduleKeyVersionDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ScheduleKeyVersionDeletionRequest) HTTPRequest 

func (request ScheduleKeyVersionDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScheduleKeyVersionDeletionRequest) RetryPolicy 

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

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

func (ScheduleKeyVersionDeletionRequest) String 

func (request ScheduleKeyVersionDeletionRequest) String() string

func (ScheduleKeyVersionDeletionRequest) ValidateEnumValue 

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

type ScheduleKeyVersionDeletionResponse 

type ScheduleKeyVersionDeletionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ScheduleKeyVersionDeletionResponse wrapper for the ScheduleKeyVersionDeletion operation

func (ScheduleKeyVersionDeletionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ScheduleKeyVersionDeletionResponse) String 

func (response ScheduleKeyVersionDeletionResponse) String() string

type ScheduleVaultDeletionDetails 

type ScheduleVaultDeletionDetails struct {

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

ScheduleVaultDeletionDetails Details for scheduling vault deletion.

func (ScheduleVaultDeletionDetails) String 

func (m ScheduleVaultDeletionDetails) String() string

func (ScheduleVaultDeletionDetails) ValidateEnumValue 

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

type ScheduleVaultDeletionRequest 

type ScheduleVaultDeletionRequest struct {

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

	// ScheduleVaultDeletionDetails
	ScheduleVaultDeletionDetails `contributesTo:"body"`

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

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

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

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

ScheduleVaultDeletionRequest wrapper for the ScheduleVaultDeletion operation

See also

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

func (ScheduleVaultDeletionRequest) BinaryRequestBody 

func (request ScheduleVaultDeletionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ScheduleVaultDeletionRequest) HTTPRequest 

func (request ScheduleVaultDeletionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ScheduleVaultDeletionRequest) RetryPolicy 

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

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

func (ScheduleVaultDeletionRequest) String 

func (request ScheduleVaultDeletionRequest) String() string

func (ScheduleVaultDeletionRequest) ValidateEnumValue 

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

type ScheduleVaultDeletionResponse 

type ScheduleVaultDeletionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ScheduleVaultDeletionResponse wrapper for the ScheduleVaultDeletion operation

func (ScheduleVaultDeletionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ScheduleVaultDeletionResponse) String 

func (response ScheduleVaultDeletionResponse) String() string

type SignDataDetails 

type SignDataDetails struct {

	// The base64-encoded binary data object denoting the message or message digest to 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"`
}

SignDataDetails The details of the message that you want to sign.

func (SignDataDetails) String 

func (m SignDataDetails) String() string

func (SignDataDetails) ValidateEnumValue 

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

type SignDataDetailsMessageTypeEnum 

type SignDataDetailsMessageTypeEnum string

SignDataDetailsMessageTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for SignDataDetailsMessageTypeEnum

func GetMappingSignDataDetailsMessageTypeEnum 

func GetMappingSignDataDetailsMessageTypeEnum(val string) (SignDataDetailsMessageTypeEnum, bool)

GetMappingSignDataDetailsMessageTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSignDataDetailsMessageTypeEnumValues 

func GetSignDataDetailsMessageTypeEnumValues() []SignDataDetailsMessageTypeEnum

GetSignDataDetailsMessageTypeEnumValues Enumerates the set of values for SignDataDetailsMessageTypeEnum

type SignDataDetailsSigningAlgorithmEnum 

type SignDataDetailsSigningAlgorithmEnum string

SignDataDetailsSigningAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for SignDataDetailsSigningAlgorithmEnum

func GetMappingSignDataDetailsSigningAlgorithmEnum 

func GetMappingSignDataDetailsSigningAlgorithmEnum(val string) (SignDataDetailsSigningAlgorithmEnum, bool)

GetMappingSignDataDetailsSigningAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSignDataDetailsSigningAlgorithmEnumValues 

func GetSignDataDetailsSigningAlgorithmEnumValues() []SignDataDetailsSigningAlgorithmEnum

GetSignDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for SignDataDetailsSigningAlgorithmEnum

type SignRequest 

type SignRequest struct {

	// SignDataDetails
	SignDataDetails `contributesTo:"body"`

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

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

SignRequest wrapper for the Sign operation

See also

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

func (SignRequest) BinaryRequestBody 

func (request SignRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (SignRequest) HTTPRequest 

func (request SignRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (SignRequest) RetryPolicy 

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

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

func (SignRequest) String 

func (request SignRequest) String() string

func (SignRequest) ValidateEnumValue 

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

type SignResponse 

type SignResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

SignResponse wrapper for the Sign operation

func (SignResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (SignResponse) String 

func (response SignResponse) String() string

type SignedData 

type SignedData struct {

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

	// The OCID of the 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"`
}

SignedData The response to a request to sign the message.

func (SignedData) String 

func (m SignedData) String() string

func (SignedData) ValidateEnumValue 

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

type SignedDataSigningAlgorithmEnum 

type SignedDataSigningAlgorithmEnum string

SignedDataSigningAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for SignedDataSigningAlgorithmEnum

func GetMappingSignedDataSigningAlgorithmEnum 

func GetMappingSignedDataSigningAlgorithmEnum(val string) (SignedDataSigningAlgorithmEnum, bool)

GetMappingSignedDataSigningAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSignedDataSigningAlgorithmEnumValues 

func GetSignedDataSigningAlgorithmEnumValues() []SignedDataSigningAlgorithmEnum

GetSignedDataSigningAlgorithmEnumValues Enumerates the set of values for SignedDataSigningAlgorithmEnum

type UpdateEkmsPrivateEndpointDetails added in v65.49.2 

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"`
}

UpdateEkmsPrivateEndpointDetails Information needed to modify EKMS private endpoint resource

func (UpdateEkmsPrivateEndpointDetails) String added in v65.49.2 

func (m UpdateEkmsPrivateEndpointDetails) String() string

func (UpdateEkmsPrivateEndpointDetails) ValidateEnumValue added in v65.49.2 

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

type UpdateEkmsPrivateEndpointRequest added in v65.49.2 

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
}

UpdateEkmsPrivateEndpointRequest wrapper for the UpdateEkmsPrivateEndpoint operation

See also

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

func (UpdateEkmsPrivateEndpointRequest) BinaryRequestBody added in v65.49.2 

func (request UpdateEkmsPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateEkmsPrivateEndpointRequest) HTTPRequest added in v65.49.2 

func (request UpdateEkmsPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateEkmsPrivateEndpointRequest) RetryPolicy added in v65.49.2 

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

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

func (UpdateEkmsPrivateEndpointRequest) String added in v65.49.2 

func (request UpdateEkmsPrivateEndpointRequest) String() string

func (UpdateEkmsPrivateEndpointRequest) ValidateEnumValue added in v65.49.2 

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

type UpdateEkmsPrivateEndpointResponse added in v65.49.2 

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"`
}

UpdateEkmsPrivateEndpointResponse wrapper for the UpdateEkmsPrivateEndpoint operation

func (UpdateEkmsPrivateEndpointResponse) HTTPResponse added in v65.49.2 

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

HTTPResponse implements the OCIResponse interface

func (UpdateEkmsPrivateEndpointResponse) String added in v65.49.2 

func (response UpdateEkmsPrivateEndpointResponse) String() string

type UpdateHsmClusterDetails added in v65.58.0 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the 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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateHsmClusterDetails The details of the HsmCluster resource that you wish to update.

func (UpdateHsmClusterDetails) String added in v65.58.0 

func (m UpdateHsmClusterDetails) String() string

func (UpdateHsmClusterDetails) ValidateEnumValue added in v65.58.0 

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

type UpdateHsmClusterRequest added in v65.58.0 

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
}

UpdateHsmClusterRequest wrapper for the UpdateHsmCluster operation

See also

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

func (UpdateHsmClusterRequest) BinaryRequestBody added in v65.58.0 

func (request UpdateHsmClusterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateHsmClusterRequest) HTTPRequest added in v65.58.0 

func (request UpdateHsmClusterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateHsmClusterRequest) RetryPolicy added in v65.58.0 

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

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

func (UpdateHsmClusterRequest) String added in v65.58.0 

func (request UpdateHsmClusterRequest) String() string

func (UpdateHsmClusterRequest) ValidateEnumValue added in v65.58.0 

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

type UpdateHsmClusterResponse added in v65.58.0 

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"`
}

UpdateHsmClusterResponse wrapper for the UpdateHsmCluster operation

func (UpdateHsmClusterResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateHsmClusterResponse) String added in v65.58.0 

func (response UpdateHsmClusterResponse) String() string

type UpdateKeyDetails 

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

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

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

UpdateKeyDetails The details of the Key that you wish to update.

func (UpdateKeyDetails) String 

func (m UpdateKeyDetails) String() string

func (UpdateKeyDetails) ValidateEnumValue 

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

type UpdateKeyRequest 

type UpdateKeyRequest struct {

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

	// UpdateKeyDetails
	UpdateKeyDetails `contributesTo:"body"`

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

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

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

UpdateKeyRequest wrapper for the UpdateKey operation

See also

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

func (UpdateKeyRequest) BinaryRequestBody 

func (request UpdateKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateKeyRequest) HTTPRequest 

func (request UpdateKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateKeyRequest) RetryPolicy 

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

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

func (UpdateKeyRequest) String 

func (request UpdateKeyRequest) String() string

func (UpdateKeyRequest) ValidateEnumValue 

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

type UpdateKeyResponse 

type UpdateKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateKeyResponse wrapper for the UpdateKey operation

func (UpdateKeyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateKeyResponse) String 

func (response UpdateKeyResponse) String() string

type UpdateVaultDetails 

type UpdateVaultDetails struct {

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

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

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

UpdateVaultDetails The details of the Vault that you wish to update.

func (UpdateVaultDetails) String 

func (m UpdateVaultDetails) String() string

func (UpdateVaultDetails) ValidateEnumValue 

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

type UpdateVaultRequest 

type UpdateVaultRequest struct {

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

	// UpdateVaultDetails
	UpdateVaultDetails `contributesTo:"body"`

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

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

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

UpdateVaultRequest wrapper for the UpdateVault operation

See also

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

func (UpdateVaultRequest) BinaryRequestBody 

func (request UpdateVaultRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateVaultRequest) HTTPRequest 

func (request UpdateVaultRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVaultRequest) RetryPolicy 

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

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

func (UpdateVaultRequest) String 

func (request UpdateVaultRequest) String() string

func (UpdateVaultRequest) ValidateEnumValue 

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

type UpdateVaultResponse 

type UpdateVaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateVaultResponse wrapper for the UpdateVault operation

func (UpdateVaultResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateVaultResponse) String 

func (response UpdateVaultResponse) String() string

type UploadPartitionCertificatesDetails added in v65.58.0 

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"`
}

UploadPartitionCertificatesDetails An object that encapsulates the necessary partition certificates.

func (UploadPartitionCertificatesDetails) String added in v65.58.0 

func (m UploadPartitionCertificatesDetails) String() string

func (UploadPartitionCertificatesDetails) ValidateEnumValue added in v65.58.0 

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

type UploadPartitionCertificatesRequest added in v65.58.0 

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
}

UploadPartitionCertificatesRequest wrapper for the UploadPartitionCertificates operation

See also

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

func (UploadPartitionCertificatesRequest) BinaryRequestBody added in v65.58.0 

func (request UploadPartitionCertificatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UploadPartitionCertificatesRequest) HTTPRequest added in v65.58.0 

func (request UploadPartitionCertificatesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UploadPartitionCertificatesRequest) RetryPolicy added in v65.58.0 

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

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

func (UploadPartitionCertificatesRequest) String added in v65.58.0 

func (request UploadPartitionCertificatesRequest) String() string

func (UploadPartitionCertificatesRequest) ValidateEnumValue added in v65.58.0 

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

type UploadPartitionCertificatesResponse added in v65.58.0 

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"`
}

UploadPartitionCertificatesResponse wrapper for the UploadPartitionCertificates operation

func (UploadPartitionCertificatesResponse) HTTPResponse added in v65.58.0 

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

HTTPResponse implements the OCIResponse interface

func (UploadPartitionCertificatesResponse) String added in v65.58.0 

func (response UploadPartitionCertificatesResponse) String() string

type Vault 

type Vault struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

	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"`
}

Vault The logical entity where the Vault service creates and durably stores keys.

func (Vault) String 

func (m Vault) String() string

func (Vault) ValidateEnumValue 

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

type VaultLifecycleStateEnum 

type VaultLifecycleStateEnum string

VaultLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for VaultLifecycleStateEnum

func GetMappingVaultLifecycleStateEnum 

func GetMappingVaultLifecycleStateEnum(val string) (VaultLifecycleStateEnum, bool)

GetMappingVaultLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetVaultLifecycleStateEnumValues 

func GetVaultLifecycleStateEnumValues() []VaultLifecycleStateEnum

GetVaultLifecycleStateEnumValues Enumerates the set of values for VaultLifecycleStateEnum

type VaultReplicaDetails 

type VaultReplicaDetails struct {

	// ReplicationId associated with a vault operation
	ReplicationId *string `mandatory:"false" json:"replicationId"`
}

VaultReplicaDetails Vault replica details

func (VaultReplicaDetails) String 

func (m VaultReplicaDetails) String() string

func (VaultReplicaDetails) ValidateEnumValue 

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

type VaultReplicaSummary 

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"`
}

VaultReplicaSummary Summary of vault replicas

func (VaultReplicaSummary) String 

func (m VaultReplicaSummary) String() string

func (VaultReplicaSummary) ValidateEnumValue 

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

type VaultReplicaSummaryStatusEnum 

type VaultReplicaSummaryStatusEnum string

VaultReplicaSummaryStatusEnum Enum with underlying type: string 

const (
	VaultReplicaSummaryStatusCreating VaultReplicaSummaryStatusEnum = "CREATING"
	VaultReplicaSummaryStatusCreated  VaultReplicaSummaryStatusEnum = "CREATED"
	VaultReplicaSummaryStatusDeleting VaultReplicaSummaryStatusEnum = "DELETING"
	VaultReplicaSummaryStatusDeleted  VaultReplicaSummaryStatusEnum = "DELETED"
)

Set of constants representing the allowable values for VaultReplicaSummaryStatusEnum

func GetMappingVaultReplicaSummaryStatusEnum 

func GetMappingVaultReplicaSummaryStatusEnum(val string) (VaultReplicaSummaryStatusEnum, bool)

GetMappingVaultReplicaSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetVaultReplicaSummaryStatusEnumValues 

func GetVaultReplicaSummaryStatusEnumValues() []VaultReplicaSummaryStatusEnum

GetVaultReplicaSummaryStatusEnumValues Enumerates the set of values for VaultReplicaSummaryStatusEnum

type VaultSummary 

type VaultSummary struct {

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

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

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

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

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

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

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

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

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

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

	ExternalKeyManagerMetadataSummary *ExternalKeyManagerMetadataSummary `mandatory:"false" json:"externalKeyManagerMetadataSummary"`
}

VaultSummary The details of the Vault.

func (VaultSummary) String 

func (m VaultSummary) String() string

func (VaultSummary) ValidateEnumValue 

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

type VaultSummaryLifecycleStateEnum 

type VaultSummaryLifecycleStateEnum string

VaultSummaryLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for VaultSummaryLifecycleStateEnum

func GetMappingVaultSummaryLifecycleStateEnum 

func GetMappingVaultSummaryLifecycleStateEnum(val string) (VaultSummaryLifecycleStateEnum, bool)

GetMappingVaultSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetVaultSummaryLifecycleStateEnumValues 

func GetVaultSummaryLifecycleStateEnumValues() []VaultSummaryLifecycleStateEnum

GetVaultSummaryLifecycleStateEnumValues Enumerates the set of values for VaultSummaryLifecycleStateEnum

type VaultSummaryVaultTypeEnum 

type VaultSummaryVaultTypeEnum string

VaultSummaryVaultTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for VaultSummaryVaultTypeEnum

func GetMappingVaultSummaryVaultTypeEnum 

func GetMappingVaultSummaryVaultTypeEnum(val string) (VaultSummaryVaultTypeEnum, bool)

GetMappingVaultSummaryVaultTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetVaultSummaryVaultTypeEnumValues 

func GetVaultSummaryVaultTypeEnumValues() []VaultSummaryVaultTypeEnum

GetVaultSummaryVaultTypeEnumValues Enumerates the set of values for VaultSummaryVaultTypeEnum

type VaultUsage 

type VaultUsage struct {

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

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

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

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

VaultUsage The details of the number of Keys and KeyVersions usage in a Vault.

func (VaultUsage) String 

func (m VaultUsage) String() string

func (VaultUsage) ValidateEnumValue 

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

type VaultVaultTypeEnum 

type VaultVaultTypeEnum string

VaultVaultTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for VaultVaultTypeEnum

func GetMappingVaultVaultTypeEnum 

func GetMappingVaultVaultTypeEnum(val string) (VaultVaultTypeEnum, bool)

GetMappingVaultVaultTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetVaultVaultTypeEnumValues 

func GetVaultVaultTypeEnumValues() []VaultVaultTypeEnum

GetVaultVaultTypeEnumValues Enumerates the set of values for VaultVaultTypeEnum

type VerifiedData 

type VerifiedData struct {

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

VerifiedData The response to a request to verify the message.

func (VerifiedData) String 

func (m VerifiedData) String() string

func (VerifiedData) ValidateEnumValue 

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

type VerifyDataDetails 

type VerifyDataDetails struct {

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

	// The OCID of the 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"`
}

VerifyDataDetails The details of the message that you want to verify.

func (VerifyDataDetails) String 

func (m VerifyDataDetails) String() string

func (VerifyDataDetails) ValidateEnumValue 

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

type VerifyDataDetailsMessageTypeEnum 

type VerifyDataDetailsMessageTypeEnum string

VerifyDataDetailsMessageTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for VerifyDataDetailsMessageTypeEnum

func GetMappingVerifyDataDetailsMessageTypeEnum 

func GetMappingVerifyDataDetailsMessageTypeEnum(val string) (VerifyDataDetailsMessageTypeEnum, bool)

GetMappingVerifyDataDetailsMessageTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetVerifyDataDetailsMessageTypeEnumValues 

func GetVerifyDataDetailsMessageTypeEnumValues() []VerifyDataDetailsMessageTypeEnum

GetVerifyDataDetailsMessageTypeEnumValues Enumerates the set of values for VerifyDataDetailsMessageTypeEnum

type VerifyDataDetailsSigningAlgorithmEnum 

type VerifyDataDetailsSigningAlgorithmEnum string

VerifyDataDetailsSigningAlgorithmEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for VerifyDataDetailsSigningAlgorithmEnum

func GetMappingVerifyDataDetailsSigningAlgorithmEnum 

func GetMappingVerifyDataDetailsSigningAlgorithmEnum(val string) (VerifyDataDetailsSigningAlgorithmEnum, bool)

GetMappingVerifyDataDetailsSigningAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

func GetVerifyDataDetailsSigningAlgorithmEnumValues 

func GetVerifyDataDetailsSigningAlgorithmEnumValues() []VerifyDataDetailsSigningAlgorithmEnum

GetVerifyDataDetailsSigningAlgorithmEnumValues Enumerates the set of values for VerifyDataDetailsSigningAlgorithmEnum

type VerifyRequest 

type VerifyRequest struct {

	// VerifyDataDetails
	VerifyDataDetails `contributesTo:"body"`

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

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

VerifyRequest wrapper for the Verify operation

See also

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

func (VerifyRequest) BinaryRequestBody 

func (request VerifyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (VerifyRequest) HTTPRequest 

func (request VerifyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (VerifyRequest) RetryPolicy 

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

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

func (VerifyRequest) String 

func (request VerifyRequest) String() string

func (VerifyRequest) ValidateEnumValue 

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

type VerifyResponse 

type VerifyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

VerifyResponse wrapper for the Verify operation

func (VerifyResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (VerifyResponse) String 

func (response VerifyResponse) String() string

type WrappedImportKey 

type WrappedImportKey struct {

	// The key material to import, wrapped by the vault's 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"`
}

WrappedImportKey The details of the wrapped import Key.

func (WrappedImportKey) String 

func (m WrappedImportKey) String() string

func (WrappedImportKey) ValidateEnumValue 

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

type WrappedImportKeyWrappingAlgorithmEnum 

type WrappedImportKeyWrappingAlgorithmEnum string

WrappedImportKeyWrappingAlgorithmEnum Enum with underlying type: string 

const (
	WrappedImportKeyWrappingAlgorithmSha256    WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_SHA256"
	WrappedImportKeyWrappingAlgorithmAesSha256 WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_AES_SHA256"
)

Set of constants representing the allowable values for WrappedImportKeyWrappingAlgorithmEnum

func GetMappingWrappedImportKeyWrappingAlgorithmEnum 

func GetMappingWrappedImportKeyWrappingAlgorithmEnum(val string) (WrappedImportKeyWrappingAlgorithmEnum, bool)

GetMappingWrappedImportKeyWrappingAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWrappedImportKeyWrappingAlgorithmEnumValues 

func GetWrappedImportKeyWrappingAlgorithmEnumValues() []WrappedImportKeyWrappingAlgorithmEnum

GetWrappedImportKeyWrappingAlgorithmEnumValues Enumerates the set of values for WrappedImportKeyWrappingAlgorithmEnum

type WrappingKey 

type WrappingKey struct {

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

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

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

	// The public key, in PEM format, to use to wrap the key material before importing it.
	PublicKey *string `mandatory:"true" json:"publicKey"`

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

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

WrappingKey The public RSA wrapping key associated with the vault

func (WrappingKey) String 

func (m WrappingKey) String() string

func (WrappingKey) ValidateEnumValue 

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

type WrappingKeyLifecycleStateEnum 

type WrappingKeyLifecycleStateEnum string

WrappingKeyLifecycleStateEnum Enum with underlying type: string 

const (
	WrappingKeyLifecycleStateCreating           WrappingKeyLifecycleStateEnum = "CREATING"
	WrappingKeyLifecycleStateEnabling           WrappingKeyLifecycleStateEnum = "ENABLING"
	WrappingKeyLifecycleStateEnabled            WrappingKeyLifecycleStateEnum = "ENABLED"
	WrappingKeyLifecycleStateDisabling          WrappingKeyLifecycleStateEnum = "DISABLING"
	WrappingKeyLifecycleStateDisabled           WrappingKeyLifecycleStateEnum = "DISABLED"
	WrappingKeyLifecycleStateDeleting           WrappingKeyLifecycleStateEnum = "DELETING"
	WrappingKeyLifecycleStateDeleted            WrappingKeyLifecycleStateEnum = "DELETED"
	WrappingKeyLifecycleStatePendingDeletion    WrappingKeyLifecycleStateEnum = "PENDING_DELETION"
	WrappingKeyLifecycleStateSchedulingDeletion WrappingKeyLifecycleStateEnum = "SCHEDULING_DELETION"
	WrappingKeyLifecycleStateCancellingDeletion WrappingKeyLifecycleStateEnum = "CANCELLING_DELETION"
	WrappingKeyLifecycleStateUpdating           WrappingKeyLifecycleStateEnum = "UPDATING"
	WrappingKeyLifecycleStateBackupInProgress   WrappingKeyLifecycleStateEnum = "BACKUP_IN_PROGRESS"
	WrappingKeyLifecycleStateRestoring          WrappingKeyLifecycleStateEnum = "RESTORING"
)

Set of constants representing the allowable values for WrappingKeyLifecycleStateEnum

func GetMappingWrappingKeyLifecycleStateEnum 

func GetMappingWrappingKeyLifecycleStateEnum(val string) (WrappingKeyLifecycleStateEnum, bool)

GetMappingWrappingKeyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWrappingKeyLifecycleStateEnumValues 

func GetWrappingKeyLifecycleStateEnumValues() []WrappingKeyLifecycleStateEnum

GetWrappingKeyLifecycleStateEnumValues Enumerates the set of values for WrappingKeyLifecycleStateEnum

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.