oci-go-sdk: github.com/oracle/oci-go-sdk/keymanagement Index | Files

package keymanagement

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

Index

Package Files

cancel_key_deletion_request_response.go cancel_key_version_deletion_request_response.go cancel_vault_deletion_request_response.go change_key_compartment_details.go change_key_compartment_request_response.go change_vault_compartment_details.go change_vault_compartment_request_response.go create_key_details.go create_key_request_response.go create_key_version_request_response.go create_vault_details.go create_vault_request_response.go decrypt_data_details.go decrypt_request_response.go decrypted_data.go disable_key_request_response.go enable_key_request_response.go encrypt_data_details.go encrypt_request_response.go encrypted_data.go generate_data_encryption_key_request_response.go generate_key_details.go generated_key.go get_key_request_response.go get_key_version_request_response.go get_vault_request_response.go get_wrapping_key_request_response.go import_key_details.go import_key_request_response.go import_key_version_details.go import_key_version_request_response.go key.go key_shape.go key_summary.go key_version.go key_version_summary.go keymanagement_kmscrypto_client.go keymanagement_kmsmanagement_client.go keymanagement_kmsvault_client.go list_key_versions_request_response.go list_keys_request_response.go list_vaults_request_response.go schedule_key_deletion_details.go schedule_key_deletion_request_response.go schedule_key_version_deletion_details.go schedule_key_version_deletion_request_response.go schedule_vault_deletion_details.go schedule_vault_deletion_request_response.go update_key_details.go update_key_request_response.go update_vault_details.go update_vault_request_response.go vault.go vault_summary.go wrapped_import_key.go wrapping_key.go

type CancelKeyDeletionRequest Uses

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

func (CancelKeyDeletionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CancelKeyDeletionRequest) RetryPolicy Uses

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

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

func (CancelKeyDeletionRequest) String Uses

func (request CancelKeyDeletionRequest) String() string

type CancelKeyDeletionResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (CancelKeyDeletionResponse) String Uses

func (response CancelKeyDeletionResponse) String() string

type CancelKeyVersionDeletionRequest Uses

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

func (CancelKeyVersionDeletionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CancelKeyVersionDeletionRequest) RetryPolicy Uses

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

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

func (CancelKeyVersionDeletionRequest) String Uses

func (request CancelKeyVersionDeletionRequest) String() string

type CancelKeyVersionDeletionResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (CancelKeyVersionDeletionResponse) String Uses

func (response CancelKeyVersionDeletionResponse) String() string

type CancelVaultDeletionRequest Uses

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

func (CancelVaultDeletionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CancelVaultDeletionRequest) RetryPolicy Uses

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

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

func (CancelVaultDeletionRequest) String Uses

func (request CancelVaultDeletionRequest) String() string

type CancelVaultDeletionResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (CancelVaultDeletionResponse) String Uses

func (response CancelVaultDeletionResponse) String() string

type ChangeKeyCompartmentDetails Uses

type ChangeKeyCompartmentDetails struct {

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

ChangeKeyCompartmentDetails The representation of ChangeKeyCompartmentDetails

func (ChangeKeyCompartmentDetails) String Uses

func (m ChangeKeyCompartmentDetails) String() string

type ChangeKeyCompartmentRequest Uses

type ChangeKeyCompartmentRequest struct {

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

    ChangeKeyCompartmentDetails `contributesTo:"body"`

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

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

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

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

ChangeKeyCompartmentRequest wrapper for the ChangeKeyCompartment operation

func (ChangeKeyCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeKeyCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeKeyCompartmentRequest) String Uses

func (request ChangeKeyCompartmentRequest) String() string

type ChangeKeyCompartmentResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeKeyCompartmentResponse) String Uses

func (response ChangeKeyCompartmentResponse) String() string

type ChangeVaultCompartmentDetails Uses

type ChangeVaultCompartmentDetails struct {

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

ChangeVaultCompartmentDetails The representation of ChangeVaultCompartmentDetails

func (ChangeVaultCompartmentDetails) String Uses

func (m ChangeVaultCompartmentDetails) String() string

type ChangeVaultCompartmentRequest Uses

type ChangeVaultCompartmentRequest struct {

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

    ChangeVaultCompartmentDetails `contributesTo:"body"`

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

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

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

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

ChangeVaultCompartmentRequest wrapper for the ChangeVaultCompartment operation

func (ChangeVaultCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeVaultCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeVaultCompartmentRequest) String Uses

func (request ChangeVaultCompartmentRequest) String() string

type ChangeVaultCompartmentResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeVaultCompartmentResponse) String Uses

func (response ChangeVaultCompartmentResponse) String() string

type CreateKeyDetails Uses

type CreateKeyDetails struct {

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

CreateKeyDetails The representation of CreateKeyDetails

func (CreateKeyDetails) String Uses

func (m CreateKeyDetails) String() string

type CreateKeyRequest Uses

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

func (CreateKeyRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateKeyRequest) RetryPolicy Uses

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

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

func (CreateKeyRequest) String Uses

func (request CreateKeyRequest) String() string

type CreateKeyResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateKeyResponse) String Uses

func (response CreateKeyResponse) String() string

type CreateKeyVersionRequest Uses

type CreateKeyVersionRequest struct {

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

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

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

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

CreateKeyVersionRequest wrapper for the CreateKeyVersion operation

func (CreateKeyVersionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateKeyVersionRequest) RetryPolicy Uses

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

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

func (CreateKeyVersionRequest) String Uses

func (request CreateKeyVersionRequest) String() string

type CreateKeyVersionResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateKeyVersionResponse) String Uses

func (response CreateKeyVersionResponse) String() string

type CreateVaultDetails Uses

type CreateVaultDetails struct {

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

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

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

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

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

CreateVaultDetails The representation of CreateVaultDetails

func (CreateVaultDetails) String Uses

func (m CreateVaultDetails) String() string

type CreateVaultDetailsVaultTypeEnum Uses

type CreateVaultDetailsVaultTypeEnum string

CreateVaultDetailsVaultTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for CreateVaultDetailsVaultTypeEnum

func GetCreateVaultDetailsVaultTypeEnumValues Uses

func GetCreateVaultDetailsVaultTypeEnumValues() []CreateVaultDetailsVaultTypeEnum

GetCreateVaultDetailsVaultTypeEnumValues Enumerates the set of values for CreateVaultDetailsVaultTypeEnum

type CreateVaultRequest Uses

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

func (CreateVaultRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateVaultRequest) RetryPolicy Uses

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

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

func (CreateVaultRequest) String Uses

func (request CreateVaultRequest) String() string

type CreateVaultResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateVaultResponse) String Uses

func (response CreateVaultResponse) String() string

type DecryptDataDetails Uses

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

DecryptDataDetails The representation of DecryptDataDetails

func (DecryptDataDetails) String Uses

func (m DecryptDataDetails) String() string

type DecryptRequest Uses

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

func (DecryptRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DecryptRequest) RetryPolicy Uses

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

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

func (DecryptRequest) String Uses

func (request DecryptRequest) String() string

type DecryptResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (DecryptResponse) String Uses

func (response DecryptResponse) String() string

type DecryptedData Uses

type DecryptedData struct {

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

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

DecryptedData The representation of DecryptedData

func (DecryptedData) String Uses

func (m DecryptedData) String() string

type DisableKeyRequest Uses

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

func (DisableKeyRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DisableKeyRequest) RetryPolicy Uses

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

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

func (DisableKeyRequest) String Uses

func (request DisableKeyRequest) String() string

type DisableKeyResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (DisableKeyResponse) String Uses

func (response DisableKeyResponse) String() string

type EnableKeyRequest Uses

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

func (EnableKeyRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (EnableKeyRequest) RetryPolicy Uses

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

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

func (EnableKeyRequest) String Uses

func (request EnableKeyRequest) String() string

type EnableKeyResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (EnableKeyResponse) String Uses

func (response EnableKeyResponse) String() string

type EncryptDataDetails Uses

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

EncryptDataDetails The representation of EncryptDataDetails

func (EncryptDataDetails) String Uses

func (m EncryptDataDetails) String() string

type EncryptRequest Uses

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

func (EncryptRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (EncryptRequest) RetryPolicy Uses

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

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

func (EncryptRequest) String Uses

func (request EncryptRequest) String() string

type EncryptResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (EncryptResponse) String Uses

func (response EncryptResponse) String() string

type EncryptedData Uses

type EncryptedData struct {

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

EncryptedData The representation of EncryptedData

func (EncryptedData) String Uses

func (m EncryptedData) String() string

type GenerateDataEncryptionKeyRequest Uses

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

func (GenerateDataEncryptionKeyRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GenerateDataEncryptionKeyRequest) RetryPolicy Uses

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

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

func (GenerateDataEncryptionKeyRequest) String Uses

func (request GenerateDataEncryptionKeyRequest) String() string

type GenerateDataEncryptionKeyResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (GenerateDataEncryptionKeyResponse) String Uses

func (response GenerateDataEncryptionKeyResponse) String() string

type GenerateKeyDetails Uses

type GenerateKeyDetails struct {

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

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

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

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

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

GenerateKeyDetails The representation of GenerateKeyDetails

func (GenerateKeyDetails) String Uses

func (m GenerateKeyDetails) String() string

type GeneratedKey Uses

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/release/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/release/GeneratedKey/GenerateDataEncryptionKey)
    // request includes the `includePlaintextKey` parameter and sets its value to "true".
    PlaintextChecksum *string `mandatory:"false" json:"plaintextChecksum"`
}

GeneratedKey The representation of GeneratedKey

func (GeneratedKey) String Uses

func (m GeneratedKey) String() string

type GetKeyRequest Uses

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

func (GetKeyRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetKeyRequest) RetryPolicy Uses

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

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

func (GetKeyRequest) String Uses

func (request GetKeyRequest) String() string

type GetKeyResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (GetKeyResponse) String Uses

func (response GetKeyResponse) String() string

type GetKeyVersionRequest Uses

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

func (GetKeyVersionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetKeyVersionRequest) RetryPolicy Uses

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

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

func (GetKeyVersionRequest) String Uses

func (request GetKeyVersionRequest) String() string

type GetKeyVersionResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (GetKeyVersionResponse) String Uses

func (response GetKeyVersionResponse) String() string

type GetVaultRequest Uses

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

func (GetVaultRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetVaultRequest) RetryPolicy Uses

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

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

func (GetVaultRequest) String Uses

func (request GetVaultRequest) String() string

type GetVaultResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (GetVaultResponse) String Uses

func (response GetVaultResponse) String() string

type GetWrappingKeyRequest Uses

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

func (GetWrappingKeyRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetWrappingKeyRequest) RetryPolicy Uses

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

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

func (GetWrappingKeyRequest) String Uses

func (request GetWrappingKeyRequest) String() string

type GetWrappingKeyResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (GetWrappingKeyResponse) String Uses

func (response GetWrappingKeyResponse) String() string

type ImportKeyDetails Uses

type ImportKeyDetails struct {

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

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

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

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

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

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

ImportKeyDetails The representation of ImportKeyDetails

func (ImportKeyDetails) String Uses

func (m ImportKeyDetails) String() string

type ImportKeyRequest Uses

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

func (ImportKeyRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ImportKeyRequest) RetryPolicy Uses

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

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

func (ImportKeyRequest) String Uses

func (request ImportKeyRequest) String() string

type ImportKeyResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (ImportKeyResponse) String Uses

func (response ImportKeyResponse) String() string

type ImportKeyVersionDetails Uses

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

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

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

ImportKeyVersionDetails The representation of ImportKeyVersionDetails

func (ImportKeyVersionDetails) String Uses

func (m ImportKeyVersionDetails) String() string

type ImportKeyVersionRequest Uses

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

func (ImportKeyVersionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ImportKeyVersionRequest) RetryPolicy Uses

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

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

func (ImportKeyVersionRequest) String Uses

func (request ImportKeyVersionRequest) String() string

type ImportKeyVersionResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (ImportKeyVersionResponse) String Uses

func (response ImportKeyVersionResponse) String() string

type Key Uses

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

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

Key The representation of Key

func (Key) String Uses

func (m Key) String() string

type KeyLifecycleStateEnum Uses

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

Set of constants representing the allowable values for KeyLifecycleStateEnum

func GetKeyLifecycleStateEnumValues Uses

func GetKeyLifecycleStateEnumValues() []KeyLifecycleStateEnum

GetKeyLifecycleStateEnumValues Enumerates the set of values for KeyLifecycleStateEnum

type KeyShape Uses

type KeyShape struct {

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

    // The length of the key, expressed as an integer. Values of 16, 24, or 32 are supported.
    Length *int `mandatory:"true" json:"length"`
}

KeyShape The cryptographic properties of a key.

func (KeyShape) String Uses

func (m KeyShape) String() string

type KeyShapeAlgorithmEnum Uses

type KeyShapeAlgorithmEnum string

KeyShapeAlgorithmEnum Enum with underlying type: string

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

Set of constants representing the allowable values for KeyShapeAlgorithmEnum

func GetKeyShapeAlgorithmEnumValues Uses

func GetKeyShapeAlgorithmEnumValues() []KeyShapeAlgorithmEnum

GetKeyShapeAlgorithmEnumValues Enumerates the set of values for KeyShapeAlgorithmEnum

type KeySummary Uses

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

KeySummary The representation of KeySummary

func (KeySummary) String Uses

func (m KeySummary) String() string

type KeySummaryLifecycleStateEnum Uses

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

Set of constants representing the allowable values for KeySummaryLifecycleStateEnum

func GetKeySummaryLifecycleStateEnumValues Uses

func GetKeySummaryLifecycleStateEnumValues() []KeySummaryLifecycleStateEnum

GetKeySummaryLifecycleStateEnumValues Enumerates the set of values for KeySummaryLifecycleStateEnum

type KeyVersion Uses

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 key version's current state.
    // Example: `ENABLED`
    LifecycleState KeyVersionLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // The source of the key material. When this value is INTERNAL, OCI KMS created the key material. When this value is EXTERNAL, the key material was imported
    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"`
}

KeyVersion The representation of KeyVersion

func (KeyVersion) String Uses

func (m KeyVersion) String() string

type KeyVersionLifecycleStateEnum Uses

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 Uses

func GetKeyVersionLifecycleStateEnumValues() []KeyVersionLifecycleStateEnum

GetKeyVersionLifecycleStateEnumValues Enumerates the set of values for KeyVersionLifecycleStateEnum

type KeyVersionOriginEnum Uses

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 Uses

func GetKeyVersionOriginEnumValues() []KeyVersionOriginEnum

GetKeyVersionOriginEnumValues Enumerates the set of values for KeyVersionOriginEnum

type KeyVersionSummary Uses

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, OCI KMS created the key material. When this value is EXTERNAL, the key material was imported
    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 state.
    // Example: `ENABLED`
    LifecycleState KeyVersionSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

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

KeyVersionSummary The representation of KeyVersionSummary

func (KeyVersionSummary) String Uses

func (m KeyVersionSummary) String() string

type KeyVersionSummaryLifecycleStateEnum Uses

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 Uses

func GetKeyVersionSummaryLifecycleStateEnumValues() []KeyVersionSummaryLifecycleStateEnum

GetKeyVersionSummaryLifecycleStateEnumValues Enumerates the set of values for KeyVersionSummaryLifecycleStateEnum

type KeyVersionSummaryOriginEnum Uses

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 Uses

func GetKeyVersionSummaryOriginEnumValues() []KeyVersionSummaryOriginEnum

GetKeyVersionSummaryOriginEnumValues Enumerates the set of values for KeyVersionSummaryOriginEnum

type KmsCryptoClient Uses

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

KmsCryptoClient a client for KmsCrypto

func NewKmsCryptoClientWithConfigurationProvider Uses

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 Uses

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 Uses

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

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

func (KmsCryptoClient) Decrypt Uses

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/release/datatypes/DecryptDataDetails) resource.

func (KmsCryptoClient) Encrypt Uses

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/release/datatypes/EncryptDataDetails) resource. Plaintext included in the example request is a base64-encoded value of a UTF-8 string.

func (KmsCryptoClient) GenerateDataEncryptionKey Uses

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.

type KmsManagementClient Uses

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

KmsManagementClient a client for KmsManagement

func NewKmsManagementClientWithConfigurationProvider Uses

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 Uses

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) CancelKeyDeletion Uses

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.

func (KmsManagementClient) CancelKeyVersionDeletion Uses

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.

func (KmsManagementClient) ChangeKeyCompartment Uses

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.

func (*KmsManagementClient) ConfigurationProvider Uses

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

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

func (KmsManagementClient) CreateKey Uses

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.

func (KmsManagementClient) CreateKeyVersion Uses

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/release/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.

func (KmsManagementClient) DisableKey Uses

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.

func (KmsManagementClient) EnableKey Uses

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.

func (KmsManagementClient) GetKey Uses

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.

func (KmsManagementClient) GetKeyVersion Uses

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.

func (KmsManagementClient) GetWrappingKey Uses

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

GetWrappingKey Returns the RSA wrapping key associated with the vault in the endpoint.

func (KmsManagementClient) ImportKey Uses

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

ImportKey Imports the given wrapped/encrypted AES key.

func (KmsManagementClient) ImportKeyVersion Uses

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

ImportKeyVersion Imports the given key version.

func (KmsManagementClient) ListKeyVersions Uses

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/release/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.

func (KmsManagementClient) ListKeys Uses

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.

func (KmsManagementClient) ScheduleKeyDeletion Uses

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.

func (KmsManagementClient) ScheduleKeyVersionDeletion Uses

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.

func (KmsManagementClient) UpdateKey Uses

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

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

type KmsVaultClient Uses

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

KmsVaultClient a client for KmsVault

func NewKmsVaultClientWithConfigurationProvider Uses

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 Uses

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) CancelVaultDeletion Uses

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.

func (KmsVaultClient) ChangeVaultCompartment Uses

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.

func (*KmsVaultClient) ConfigurationProvider Uses

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

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

func (KmsVaultClient) CreateVault Uses

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.

func (KmsVaultClient) GetVault Uses

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.

func (KmsVaultClient) ListVaults Uses

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.

func (KmsVaultClient) ScheduleVaultDeletion Uses

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.

func (*KmsVaultClient) SetRegion Uses

func (client *KmsVaultClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (KmsVaultClient) UpdateVault Uses

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.

type ListKeyVersionsRequest Uses

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

func (ListKeyVersionsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListKeyVersionsRequest) RetryPolicy Uses

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

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

func (ListKeyVersionsRequest) String Uses

func (request ListKeyVersionsRequest) String() string

type ListKeyVersionsResponse Uses

type ListKeyVersionsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

ListKeyVersionsResponse wrapper for the ListKeyVersions operation

func (ListKeyVersionsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListKeyVersionsResponse) String Uses

func (response ListKeyVersionsResponse) String() string

type ListKeyVersionsSortByEnum Uses

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 Uses

func GetListKeyVersionsSortByEnumValues() []ListKeyVersionsSortByEnum

GetListKeyVersionsSortByEnumValues Enumerates the set of values for ListKeyVersionsSortByEnum

type ListKeyVersionsSortOrderEnum Uses

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 Uses

func GetListKeyVersionsSortOrderEnumValues() []ListKeyVersionsSortOrderEnum

GetListKeyVersionsSortOrderEnumValues Enumerates the set of values for ListKeyVersionsSortOrderEnum

type ListKeysRequest Uses

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

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

func (ListKeysRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListKeysRequest) RetryPolicy Uses

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

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

func (ListKeysRequest) String Uses

func (request ListKeysRequest) String() string

type ListKeysResponse Uses

type ListKeysResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

ListKeysResponse wrapper for the ListKeys operation

func (ListKeysResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListKeysResponse) String Uses

func (response ListKeysResponse) String() string

type ListKeysSortByEnum Uses

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 Uses

func GetListKeysSortByEnumValues() []ListKeysSortByEnum

GetListKeysSortByEnumValues Enumerates the set of values for ListKeysSortByEnum

type ListKeysSortOrderEnum Uses

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 Uses

func GetListKeysSortOrderEnumValues() []ListKeysSortOrderEnum

GetListKeysSortOrderEnumValues Enumerates the set of values for ListKeysSortOrderEnum

type ListVaultsRequest Uses

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

func (ListVaultsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListVaultsRequest) RetryPolicy Uses

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

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

func (ListVaultsRequest) String Uses

func (request ListVaultsRequest) String() string

type ListVaultsResponse Uses

type ListVaultsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

ListVaultsResponse wrapper for the ListVaults operation

func (ListVaultsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListVaultsResponse) String Uses

func (response ListVaultsResponse) String() string

type ListVaultsSortByEnum Uses

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 Uses

func GetListVaultsSortByEnumValues() []ListVaultsSortByEnum

GetListVaultsSortByEnumValues Enumerates the set of values for ListVaultsSortByEnum

type ListVaultsSortOrderEnum Uses

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 Uses

func GetListVaultsSortOrderEnumValues() []ListVaultsSortOrderEnum

GetListVaultsSortOrderEnumValues Enumerates the set of values for ListVaultsSortOrderEnum

type ScheduleKeyDeletionDetails Uses

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 Uses

func (m ScheduleKeyDeletionDetails) String() string

type ScheduleKeyDeletionRequest Uses

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

func (ScheduleKeyDeletionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ScheduleKeyDeletionRequest) RetryPolicy Uses

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

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

func (ScheduleKeyDeletionRequest) String Uses

func (request ScheduleKeyDeletionRequest) String() string

type ScheduleKeyDeletionResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (ScheduleKeyDeletionResponse) String Uses

func (response ScheduleKeyDeletionResponse) String() string

type ScheduleKeyVersionDeletionDetails Uses

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 Uses

func (m ScheduleKeyVersionDeletionDetails) String() string

type ScheduleKeyVersionDeletionRequest Uses

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

func (ScheduleKeyVersionDeletionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ScheduleKeyVersionDeletionRequest) RetryPolicy Uses

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

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

func (ScheduleKeyVersionDeletionRequest) String Uses

func (request ScheduleKeyVersionDeletionRequest) String() string

type ScheduleKeyVersionDeletionResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (ScheduleKeyVersionDeletionResponse) String Uses

func (response ScheduleKeyVersionDeletionResponse) String() string

type ScheduleVaultDeletionDetails Uses

type ScheduleVaultDeletionDetails 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 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 Uses

func (m ScheduleVaultDeletionDetails) String() string

type ScheduleVaultDeletionRequest Uses

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

func (ScheduleVaultDeletionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ScheduleVaultDeletionRequest) RetryPolicy Uses

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

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

func (ScheduleVaultDeletionRequest) String Uses

func (request ScheduleVaultDeletionRequest) String() string

type ScheduleVaultDeletionResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (ScheduleVaultDeletionResponse) String Uses

func (response ScheduleVaultDeletionResponse) String() string

type UpdateKeyDetails Uses

type UpdateKeyDetails struct {

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

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

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

UpdateKeyDetails The representation of UpdateKeyDetails

func (UpdateKeyDetails) String Uses

func (m UpdateKeyDetails) String() string

type UpdateKeyRequest Uses

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

func (UpdateKeyRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateKeyRequest) RetryPolicy Uses

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

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

func (UpdateKeyRequest) String Uses

func (request UpdateKeyRequest) String() string

type UpdateKeyResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateKeyResponse) String Uses

func (response UpdateKeyResponse) String() string

type UpdateVaultDetails Uses

type UpdateVaultDetails struct {

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

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

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

UpdateVaultDetails The representation of UpdateVaultDetails

func (UpdateVaultDetails) String Uses

func (m UpdateVaultDetails) String() string

type UpdateVaultRequest Uses

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

func (UpdateVaultRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateVaultRequest) RetryPolicy Uses

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

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

func (UpdateVaultRequest) String Uses

func (request UpdateVaultRequest) String() string

type UpdateVaultResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateVaultResponse) String Uses

func (response UpdateVaultResponse) String() string

type Vault Uses

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/release/EncryptedData/Encrypt), Decrypt (https://docs.cloud.oracle.com/api/#/en/key/release/DecryptedData/Decrypt),
    // and GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/release/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 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 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"`
}

Vault The representation of Vault

func (Vault) String Uses

func (m Vault) String() string

type VaultLifecycleStateEnum Uses

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

Set of constants representing the allowable values for VaultLifecycleStateEnum

func GetVaultLifecycleStateEnumValues Uses

func GetVaultLifecycleStateEnumValues() []VaultLifecycleStateEnum

GetVaultLifecycleStateEnumValues Enumerates the set of values for VaultLifecycleStateEnum

type VaultSummary Uses

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/release/EncryptedData/Encrypt), Decrypt (https://docs.cloud.oracle.com/api/#/en/key/release/DecryptedData/Decrypt),
    // and GenerateDataEncryptionKey (https://docs.cloud.oracle.com/api/#/en/key/release/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 state.
    // Example: `ACTIVE`
    LifecycleState VaultSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

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

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

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

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

VaultSummary The representation of VaultSummary

func (VaultSummary) String Uses

func (m VaultSummary) String() string

type VaultSummaryLifecycleStateEnum Uses

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

Set of constants representing the allowable values for VaultSummaryLifecycleStateEnum

func GetVaultSummaryLifecycleStateEnumValues Uses

func GetVaultSummaryLifecycleStateEnumValues() []VaultSummaryLifecycleStateEnum

GetVaultSummaryLifecycleStateEnumValues Enumerates the set of values for VaultSummaryLifecycleStateEnum

type VaultSummaryVaultTypeEnum Uses

type VaultSummaryVaultTypeEnum string

VaultSummaryVaultTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for VaultSummaryVaultTypeEnum

func GetVaultSummaryVaultTypeEnumValues Uses

func GetVaultSummaryVaultTypeEnumValues() []VaultSummaryVaultTypeEnum

GetVaultSummaryVaultTypeEnumValues Enumerates the set of values for VaultSummaryVaultTypeEnum

type VaultVaultTypeEnum Uses

type VaultVaultTypeEnum string

VaultVaultTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for VaultVaultTypeEnum

func GetVaultVaultTypeEnumValues Uses

func GetVaultVaultTypeEnumValues() []VaultVaultTypeEnum

GetVaultVaultTypeEnumValues Enumerates the set of values for VaultVaultTypeEnum

type WrappedImportKey Uses

type WrappedImportKey struct {

    // The wrapped/encrypted key material to import. It is encrypted using RSA wrapped key and Base64 encoded.
    KeyMaterial *string `mandatory:"true" json:"keyMaterial"`

    // The wrapping mechanism to be used during key import
    WrappingAlgorithm WrappedImportKeyWrappingAlgorithmEnum `mandatory:"true" json:"wrappingAlgorithm"`
}

WrappedImportKey The representation of WrappedImportKey

func (WrappedImportKey) String Uses

func (m WrappedImportKey) String() string

type WrappedImportKeyWrappingAlgorithmEnum Uses

type WrappedImportKeyWrappingAlgorithmEnum string

WrappedImportKeyWrappingAlgorithmEnum Enum with underlying type: string

const (
    WrappedImportKeyWrappingAlgorithmRsaOaepSha256 WrappedImportKeyWrappingAlgorithmEnum = "RSA_OAEP_SHA256"
)

Set of constants representing the allowable values for WrappedImportKeyWrappingAlgorithmEnum

func GetWrappedImportKeyWrappingAlgorithmEnumValues Uses

func GetWrappedImportKeyWrappingAlgorithmEnumValues() []WrappedImportKeyWrappingAlgorithmEnum

GetWrappedImportKeyWrappingAlgorithmEnumValues Enumerates the set of values for WrappedImportKeyWrappingAlgorithmEnum

type WrappingKey Uses

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 state.
    // Example: `ENABLED`
    LifecycleState WrappingKeyLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The public key in PEM format to encrypt the key material before importing it with ImportKey/ImportKeyVersion.
    PublicKey *string `mandatory:"true" json:"publicKey"`

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

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

WrappingKey The representation of WrappingKey

func (WrappingKey) String Uses

func (m WrappingKey) String() string

type WrappingKeyLifecycleStateEnum Uses

type WrappingKeyLifecycleStateEnum string

WrappingKeyLifecycleStateEnum Enum with underlying type: string

const (
    WrappingKeyLifecycleStateCreating WrappingKeyLifecycleStateEnum = "CREATING"
    WrappingKeyLifecycleStateEnabled  WrappingKeyLifecycleStateEnum = "ENABLED"
    WrappingKeyLifecycleStateDeleting WrappingKeyLifecycleStateEnum = "DELETING"
    WrappingKeyLifecycleStateDeleted  WrappingKeyLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for WrappingKeyLifecycleStateEnum

func GetWrappingKeyLifecycleStateEnumValues Uses

func GetWrappingKeyLifecycleStateEnumValues() []WrappingKeyLifecycleStateEnum

GetWrappingKeyLifecycleStateEnumValues Enumerates the set of values for WrappingKeyLifecycleStateEnum

Package keymanagement imports 4 packages (graph) and is imported by 4 packages. Updated 2020-04-06. Refresh now. Tools for package owners.