keymanagement

package
v5.10.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jun 11, 2019 License: Apache-2.0, UPL-1.0 Imports: 4 Imported by: 0

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CancelVaultDeletionRequest ¶ 

type CancelVaultDeletionRequest struct {

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

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

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

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

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

CancelVaultDeletionRequest wrapper for the CancelVaultDeletion operation

func (CancelVaultDeletionRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (CancelVaultDeletionRequest) RetryPolicy ¶ 

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

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

func (CancelVaultDeletionRequest) String ¶ 

func (request CancelVaultDeletionRequest) String() string

type CancelVaultDeletionResponse ¶ 

type CancelVaultDeletionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CancelVaultDeletionResponse wrapper for the CancelVaultDeletion operation

func (CancelVaultDeletionResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (CancelVaultDeletionResponse) String ¶ 

func (response CancelVaultDeletionResponse) String() string

type CreateKeyDetails ¶ 

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

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

CreateKeyDetails The representation of CreateKeyDetails

func (CreateKeyDetails) String ¶ 

func (m CreateKeyDetails) String() string

type CreateKeyRequest ¶ 

type CreateKeyRequest struct {

	// CreateKeyDetails
	CreateKeyDetails `contributesTo:"body"`

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

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

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

CreateKeyRequest wrapper for the CreateKey operation

func (CreateKeyRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (CreateKeyRequest) RetryPolicy ¶ 

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

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

func (CreateKeyRequest) String ¶ 

func (request CreateKeyRequest) String() string

type CreateKeyResponse ¶ 

type CreateKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateKeyResponse wrapper for the CreateKey operation

func (CreateKeyResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (CreateKeyResponse) String ¶ 

func (response CreateKeyResponse) String() string

type CreateKeyVersionRequest ¶ 

type CreateKeyVersionRequest struct {

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

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

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

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

CreateKeyVersionRequest wrapper for the CreateKeyVersion operation

func (CreateKeyVersionRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (CreateKeyVersionRequest) RetryPolicy ¶ 

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

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

func (CreateKeyVersionRequest) String ¶ 

func (request CreateKeyVersionRequest) String() string

type CreateKeyVersionResponse ¶ 

type CreateKeyVersionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateKeyVersionResponse wrapper for the CreateKeyVersion operation

func (CreateKeyVersionResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (CreateKeyVersionResponse) String ¶ 

func (response CreateKeyVersionResponse) String() string

type CreateVaultDetails ¶ 

type CreateVaultDetails struct {

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

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

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

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

CreateVaultDetails The representation of CreateVaultDetails

func (CreateVaultDetails) String ¶ 

func (m CreateVaultDetails) String() string

type CreateVaultDetailsVaultTypeEnum ¶ 

type CreateVaultDetailsVaultTypeEnum string

CreateVaultDetailsVaultTypeEnum Enum with underlying type: string 

const (
	CreateVaultDetailsVaultTypePrivate CreateVaultDetailsVaultTypeEnum = "VIRTUAL_PRIVATE"
)

Set of constants representing the allowable values for CreateVaultDetailsVaultTypeEnum

func GetCreateVaultDetailsVaultTypeEnumValues ¶ 

func GetCreateVaultDetailsVaultTypeEnumValues() []CreateVaultDetailsVaultTypeEnum

GetCreateVaultDetailsVaultTypeEnumValues Enumerates the set of values for CreateVaultDetailsVaultTypeEnum

type CreateVaultRequest ¶ 

type CreateVaultRequest struct {

	// CreateVaultDetails
	CreateVaultDetails `contributesTo:"body"`

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

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

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

CreateVaultRequest wrapper for the CreateVault operation

func (CreateVaultRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (CreateVaultRequest) RetryPolicy ¶ 

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

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

func (CreateVaultRequest) String ¶ 

func (request CreateVaultRequest) String() string

type CreateVaultResponse ¶ 

type CreateVaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

CreateVaultResponse wrapper for the CreateVault operation

func (CreateVaultResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (CreateVaultResponse) String ¶ 

func (response CreateVaultResponse) String() string

type DecryptDataDetails ¶ 

type DecryptDataDetails struct {

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

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

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

	// Information that can be used to provide context for audit logging. It is a map that contains any addtional
	// data the users may have and will be added to the audit logs (if audit logging is enabled)
	LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`
}

DecryptDataDetails The representation of DecryptDataDetails

func (DecryptDataDetails) String ¶ 

func (m DecryptDataDetails) String() string

type DecryptRequest ¶ 

type DecryptRequest struct {

	// DecryptDataDetails
	DecryptDataDetails `contributesTo:"body"`

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

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

DecryptRequest wrapper for the Decrypt operation

func (DecryptRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (DecryptRequest) RetryPolicy ¶ 

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

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

func (DecryptRequest) String ¶ 

func (request DecryptRequest) String() string

type DecryptResponse ¶ 

type DecryptResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

DecryptResponse wrapper for the Decrypt operation

func (DecryptResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (DecryptResponse) String ¶ 

func (response DecryptResponse) String() string

type DecryptedData ¶ 

type DecryptedData struct {

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

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

DecryptedData The representation of DecryptedData

func (DecryptedData) String ¶ 

func (m DecryptedData) String() string

type DisableKeyRequest ¶ 

type DisableKeyRequest struct {

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

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

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

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

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

DisableKeyRequest wrapper for the DisableKey operation

func (DisableKeyRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (DisableKeyRequest) RetryPolicy ¶ 

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

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

func (DisableKeyRequest) String ¶ 

func (request DisableKeyRequest) String() string

type DisableKeyResponse ¶ 

type DisableKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

DisableKeyResponse wrapper for the DisableKey operation

func (DisableKeyResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (DisableKeyResponse) String ¶ 

func (response DisableKeyResponse) String() string

type EnableKeyRequest ¶ 

type EnableKeyRequest struct {

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

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

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

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

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

EnableKeyRequest wrapper for the EnableKey operation

func (EnableKeyRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (EnableKeyRequest) RetryPolicy ¶ 

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

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

func (EnableKeyRequest) String ¶ 

func (request EnableKeyRequest) String() string

type EnableKeyResponse ¶ 

type EnableKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

EnableKeyResponse wrapper for the EnableKey operation

func (EnableKeyResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (EnableKeyResponse) String ¶ 

func (response EnableKeyResponse) String() string

type EncryptDataDetails ¶ 

type EncryptDataDetails struct {

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

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

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

	// Information that can be used to provide context for audit logging. It is a map that contains any addtional
	// data the users may have and will be added to the audit logs (if audit logging is enabled)
	LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`
}

EncryptDataDetails The representation of EncryptDataDetails

func (EncryptDataDetails) String ¶ 

func (m EncryptDataDetails) String() string

type EncryptRequest ¶ 

type EncryptRequest struct {

	// EncryptDataDetails
	EncryptDataDetails `contributesTo:"body"`

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

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

EncryptRequest wrapper for the Encrypt operation

func (EncryptRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (EncryptRequest) RetryPolicy ¶ 

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

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

func (EncryptRequest) String ¶ 

func (request EncryptRequest) String() string

type EncryptResponse ¶ 

type EncryptResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

EncryptResponse wrapper for the Encrypt operation

func (EncryptResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (EncryptResponse) String ¶ 

func (response EncryptResponse) String() string

type EncryptedData ¶ 

type EncryptedData struct {

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

EncryptedData The representation of EncryptedData

func (EncryptedData) String ¶ 

func (m EncryptedData) String() string

type GenerateDataEncryptionKeyRequest ¶ 

type GenerateDataEncryptionKeyRequest struct {

	// GenerateKeyDetails
	GenerateKeyDetails `contributesTo:"body"`

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

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

GenerateDataEncryptionKeyRequest wrapper for the GenerateDataEncryptionKey operation

func (GenerateDataEncryptionKeyRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (GenerateDataEncryptionKeyRequest) RetryPolicy ¶ 

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

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

func (GenerateDataEncryptionKeyRequest) String ¶ 

func (request GenerateDataEncryptionKeyRequest) String() string

type GenerateDataEncryptionKeyResponse ¶ 

type GenerateDataEncryptionKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

GenerateDataEncryptionKeyResponse wrapper for the GenerateDataEncryptionKey operation

func (GenerateDataEncryptionKeyResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (GenerateDataEncryptionKeyResponse) String ¶ 

func (response GenerateDataEncryptionKeyResponse) String() string

type GenerateKeyDetails ¶ 

type GenerateKeyDetails struct {

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

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

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

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

	// Information that can be used to provide context for audit logging. It is a map that contains any addtional
	// data the users may have and will be added to the audit logs (if audit logging is enabled)
	LoggingContext map[string]string `mandatory:"false" json:"loggingContext"`
}

GenerateKeyDetails The representation of GenerateKeyDetails

func (GenerateKeyDetails) String ¶ 

func (m GenerateKeyDetails) String() string

type GeneratedKey ¶ 

type GeneratedKey struct {

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

	// The plaintext generated data encryption key, a base64-encoded
	// sequence of random bytes, which is included if the
	// GenerateDataEncryptionKey request includes the "includePlaintextKey"
	// parameter and sets its value to 'true'.
	Plaintext *string `mandatory:"false" json:"plaintext"`

	// The checksum of the plaintext generated data encryption key, which
	// is included if the GenerateDataEncryptionKey request includes the
	// "includePlaintextKey parameter and sets its value to 'true'.
	PlaintextChecksum *string `mandatory:"false" json:"plaintextChecksum"`
}

GeneratedKey The representation of GeneratedKey

func (GeneratedKey) String ¶ 

func (m GeneratedKey) String() string

type GetKeyRequest ¶ 

type GetKeyRequest struct {

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

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

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

GetKeyRequest wrapper for the GetKey operation

func (GetKeyRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (GetKeyRequest) RetryPolicy ¶ 

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

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

func (GetKeyRequest) String ¶ 

func (request GetKeyRequest) String() string

type GetKeyResponse ¶ 

type GetKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetKeyResponse wrapper for the GetKey operation

func (GetKeyResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (GetKeyResponse) String ¶ 

func (response GetKeyResponse) String() string

type GetKeyVersionRequest ¶ 

type GetKeyVersionRequest struct {

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

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

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

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

GetKeyVersionRequest wrapper for the GetKeyVersion operation

func (GetKeyVersionRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (GetKeyVersionRequest) RetryPolicy ¶ 

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

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

func (GetKeyVersionRequest) String ¶ 

func (request GetKeyVersionRequest) String() string

type GetKeyVersionResponse ¶ 

type GetKeyVersionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetKeyVersionResponse wrapper for the GetKeyVersion operation

func (GetKeyVersionResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (GetKeyVersionResponse) String ¶ 

func (response GetKeyVersionResponse) String() string

type GetVaultRequest ¶ 

type GetVaultRequest struct {

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

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

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

GetVaultRequest wrapper for the GetVault operation

func (GetVaultRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (GetVaultRequest) RetryPolicy ¶ 

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

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

func (GetVaultRequest) String ¶ 

func (request GetVaultRequest) String() string

type GetVaultResponse ¶ 

type GetVaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetVaultResponse wrapper for the GetVault operation

func (GetVaultResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (GetVaultResponse) String ¶ 

func (response GetVaultResponse) String() string

type Key ¶ 

type Key struct {

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

	// The OCID of the KeyVersion resource used in cryptographic operations. During key rotation, service might be in a transitional state
	// where this or a newer KeyVersion are used intermittently. The currentKeyVersion field is updated when the service is guaranteed to
	// use the new KeyVersion 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"`

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

Key The representation of Key

func (Key) String ¶ 

func (m Key) String() string

type KeyLifecycleStateEnum ¶ 

type KeyLifecycleStateEnum string

KeyLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeyLifecycleStateEnum

func GetKeyLifecycleStateEnumValues ¶ 

func GetKeyLifecycleStateEnumValues() []KeyLifecycleStateEnum

GetKeyLifecycleStateEnumValues Enumerates the set of values for KeyLifecycleStateEnum

type KeyShape ¶ 

type KeyShape struct {

	// The algorithm used by a key's KeyVersions 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 ¶ 

func (m KeyShape) String() string

type KeyShapeAlgorithmEnum ¶ 

type KeyShapeAlgorithmEnum string

KeyShapeAlgorithmEnum Enum with underlying type: string 

const (
	KeyShapeAlgorithmAes KeyShapeAlgorithmEnum = "AES"
)

Set of constants representing the allowable values for KeyShapeAlgorithmEnum

func GetKeyShapeAlgorithmEnumValues ¶ 

func GetKeyShapeAlgorithmEnumValues() []KeyShapeAlgorithmEnum

GetKeyShapeAlgorithmEnumValues Enumerates the set of values for KeyShapeAlgorithmEnum

type KeySummary ¶ 

type KeySummary struct {

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

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

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

	// The key's current 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"`

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

KeySummary The representation of KeySummary

func (KeySummary) String ¶ 

func (m KeySummary) String() string

type KeySummaryLifecycleStateEnum ¶ 

type KeySummaryLifecycleStateEnum string

KeySummaryLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for KeySummaryLifecycleStateEnum

func GetKeySummaryLifecycleStateEnumValues ¶ 

func GetKeySummaryLifecycleStateEnumValues() []KeySummaryLifecycleStateEnum

GetKeySummaryLifecycleStateEnumValues Enumerates the set of values for KeySummaryLifecycleStateEnum

type KeyVersion ¶ 

type KeyVersion struct {

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

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

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

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

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

KeyVersion The representation of KeyVersion

func (KeyVersion) String ¶ 

func (m KeyVersion) String() string

type KeyVersionSummary ¶ 

type KeyVersionSummary struct {

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

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

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

KeyVersionSummary The representation of KeyVersionSummary

func (KeyVersionSummary) String ¶ 

func (m KeyVersionSummary) String() string

type KmsCryptoClient ¶ 

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

KmsCryptoClient a client for KmsCrypto

func NewKmsCryptoClientWithConfigurationProvider ¶ 

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

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

func (*KmsCryptoClient) ConfigurationProvider ¶ 

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

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

func (KmsCryptoClient) Decrypt ¶ 

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

Decrypt Decrypts data using the given DecryptDataDetails resource.

func (KmsCryptoClient) Encrypt ¶ 

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

Encrypt Encrypts data using the given EncryptDataDetails resource. Plaintext included in the example request is a base64-encoded value of a UTF-8 string.

func (KmsCryptoClient) GenerateDataEncryptionKey ¶ 

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

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

type KmsManagementClient ¶ 

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

KmsManagementClient a client for KmsManagement

func NewKmsManagementClientWithConfigurationProvider ¶ 

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

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

func (*KmsManagementClient) ConfigurationProvider ¶ 

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

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

func (KmsManagementClient) CreateKey ¶ 

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

CreateKey Creates a new key.

func (KmsManagementClient) CreateKeyVersion ¶ 

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

CreateKeyVersion Generates new cryptographic material for a key. The key must be in an `ENABLED` state to be rotated.

func (KmsManagementClient) DisableKey ¶ 

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

DisableKey Disables a key to make it unavailable for encryption or decryption.

func (KmsManagementClient) EnableKey ¶ 

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

EnableKey Enables a key to make it available for encryption or decryption.

func (KmsManagementClient) GetKey ¶ 

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

GetKey Gets information about the specified key.

func (KmsManagementClient) GetKeyVersion ¶ 

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

GetKeyVersion Gets information about the specified key version.

func (KmsManagementClient) ListKeyVersions ¶ 

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

ListKeyVersions Lists all key versions for the specified key.

func (KmsManagementClient) ListKeys ¶ 

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

ListKeys Lists the keys in the specified vault and compartment.

func (KmsManagementClient) UpdateKey ¶ 

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

UpdateKey Updates the properties of a key. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, the key must in an `ACTIVE` or `CREATING` state to be updated.

type KmsVaultClient ¶ 

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

KmsVaultClient a client for KmsVault

func NewKmsVaultClientWithConfigurationProvider ¶ 

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

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

func (KmsVaultClient) CancelVaultDeletion ¶ 

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

CancelVaultDeletion Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion restores the vault and all keys in it to the respective states they were in before the deletion was scheduled.

func (*KmsVaultClient) ConfigurationProvider ¶ 

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

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

func (KmsVaultClient) CreateVault ¶ 

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

CreateVault Creates a new vault. The type of vault you create determines key placement, pricing, and available options. Options include storage isolation, a dedicated service endpoint instead of a shared service endpoint for API calls, and a dedicated hardware security module (HSM) or a multitenant HSM.

func (KmsVaultClient) GetVault ¶ 

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

GetVault Gets the specified vault's configuration information.

func (KmsVaultClient) ListVaults ¶ 

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

ListVaults Lists the vaults in the specified compartment.

func (KmsVaultClient) ScheduleVaultDeletion ¶ 

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

ScheduleVaultDeletion Schedules the deletion of the specified vault. This sets the state of the vault and all keys in it to `PENDING_DELETION` and then deletes them after the retention period ends.

func (*KmsVaultClient) SetRegion ¶ 

func (client *KmsVaultClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (KmsVaultClient) UpdateVault ¶ 

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

UpdateVault Updates the properties of a vault. Specifically, you can update the `displayName`, `freeformTags`, and `definedTags` properties. Furthermore, the vault must be in an `ACTIVE` or `CREATING` state to be updated.

type ListKeyVersionsRequest ¶ 

type ListKeyVersionsRequest struct {

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

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

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

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

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

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

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

ListKeyVersionsRequest wrapper for the ListKeyVersions operation

func (ListKeyVersionsRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ListKeyVersionsRequest) RetryPolicy ¶ 

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

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

func (ListKeyVersionsRequest) String ¶ 

func (request ListKeyVersionsRequest) String() string

type ListKeyVersionsResponse ¶ 

type ListKeyVersionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListKeyVersionsResponse wrapper for the ListKeyVersions operation

func (ListKeyVersionsResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ListKeyVersionsResponse) String ¶ 

func (response ListKeyVersionsResponse) String() string

type ListKeyVersionsSortByEnum ¶ 

type ListKeyVersionsSortByEnum string

ListKeyVersionsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeyVersionsSortByEnum

func GetListKeyVersionsSortByEnumValues ¶ 

func GetListKeyVersionsSortByEnumValues() []ListKeyVersionsSortByEnum

GetListKeyVersionsSortByEnumValues Enumerates the set of values for ListKeyVersionsSortByEnum

type ListKeyVersionsSortOrderEnum ¶ 

type ListKeyVersionsSortOrderEnum string

ListKeyVersionsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeyVersionsSortOrderEnum

func GetListKeyVersionsSortOrderEnumValues ¶ 

func GetListKeyVersionsSortOrderEnumValues() []ListKeyVersionsSortOrderEnum

GetListKeyVersionsSortOrderEnumValues Enumerates the set of values for ListKeyVersionsSortOrderEnum

type ListKeysRequest ¶ 

type ListKeysRequest struct {

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

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

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

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

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

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

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

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

HTTPRequest implements the OCIRequest interface

func (ListKeysRequest) RetryPolicy ¶ 

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

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

func (ListKeysRequest) String ¶ 

func (request ListKeysRequest) String() string

type ListKeysResponse ¶ 

type ListKeysResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListKeysResponse wrapper for the ListKeys operation

func (ListKeysResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ListKeysResponse) String ¶ 

func (response ListKeysResponse) String() string

type ListKeysSortByEnum ¶ 

type ListKeysSortByEnum string

ListKeysSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeysSortByEnum

func GetListKeysSortByEnumValues ¶ 

func GetListKeysSortByEnumValues() []ListKeysSortByEnum

GetListKeysSortByEnumValues Enumerates the set of values for ListKeysSortByEnum

type ListKeysSortOrderEnum ¶ 

type ListKeysSortOrderEnum string

ListKeysSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListKeysSortOrderEnum

func GetListKeysSortOrderEnumValues ¶ 

func GetListKeysSortOrderEnumValues() []ListKeysSortOrderEnum

GetListKeysSortOrderEnumValues Enumerates the set of values for ListKeysSortOrderEnum

type ListVaultsRequest ¶ 

type ListVaultsRequest struct {

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

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

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

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

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

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

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

ListVaultsRequest wrapper for the ListVaults operation

func (ListVaultsRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ListVaultsRequest) RetryPolicy ¶ 

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

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

func (ListVaultsRequest) String ¶ 

func (request ListVaultsRequest) String() string

type ListVaultsResponse ¶ 

type ListVaultsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ListVaultsResponse wrapper for the ListVaults operation

func (ListVaultsResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ListVaultsResponse) String ¶ 

func (response ListVaultsResponse) String() string

type ListVaultsSortByEnum ¶ 

type ListVaultsSortByEnum string

ListVaultsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListVaultsSortByEnum

func GetListVaultsSortByEnumValues ¶ 

func GetListVaultsSortByEnumValues() []ListVaultsSortByEnum

GetListVaultsSortByEnumValues Enumerates the set of values for ListVaultsSortByEnum

type ListVaultsSortOrderEnum ¶ 

type ListVaultsSortOrderEnum string

ListVaultsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListVaultsSortOrderEnum

func GetListVaultsSortOrderEnumValues ¶ 

func GetListVaultsSortOrderEnumValues() []ListVaultsSortOrderEnum

GetListVaultsSortOrderEnumValues Enumerates the set of values for ListVaultsSortOrderEnum

type ScheduleVaultDeletionDetails ¶ 

type ScheduleVaultDeletionDetails struct {

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

ScheduleVaultDeletionDetails Details for scheduling vault deletion

func (ScheduleVaultDeletionDetails) String ¶ 

func (m ScheduleVaultDeletionDetails) String() string

type ScheduleVaultDeletionRequest ¶ 

type ScheduleVaultDeletionRequest struct {

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

	// ScheduleVaultDeletionDetails
	ScheduleVaultDeletionDetails `contributesTo:"body"`

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

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

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

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

ScheduleVaultDeletionRequest wrapper for the ScheduleVaultDeletion operation

func (ScheduleVaultDeletionRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (ScheduleVaultDeletionRequest) RetryPolicy ¶ 

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

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

func (ScheduleVaultDeletionRequest) String ¶ 

func (request ScheduleVaultDeletionRequest) String() string

type ScheduleVaultDeletionResponse ¶ 

type ScheduleVaultDeletionResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

ScheduleVaultDeletionResponse wrapper for the ScheduleVaultDeletion operation

func (ScheduleVaultDeletionResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (ScheduleVaultDeletionResponse) String ¶ 

func (response ScheduleVaultDeletionResponse) String() string

type UpdateKeyDetails ¶ 

type UpdateKeyDetails struct {

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

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

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

UpdateKeyDetails The representation of UpdateKeyDetails

func (UpdateKeyDetails) String ¶ 

func (m UpdateKeyDetails) String() string

type UpdateKeyRequest ¶ 

type UpdateKeyRequest struct {

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

	// UpdateKeyDetails
	UpdateKeyDetails `contributesTo:"body"`

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

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

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

UpdateKeyRequest wrapper for the UpdateKey operation

func (UpdateKeyRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (UpdateKeyRequest) RetryPolicy ¶ 

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

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

func (UpdateKeyRequest) String ¶ 

func (request UpdateKeyRequest) String() string

type UpdateKeyResponse ¶ 

type UpdateKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateKeyResponse wrapper for the UpdateKey operation

func (UpdateKeyResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (UpdateKeyResponse) String ¶ 

func (response UpdateKeyResponse) String() string

type UpdateVaultDetails ¶ 

type UpdateVaultDetails struct {

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

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

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

UpdateVaultDetails The representation of UpdateVaultDetails

func (UpdateVaultDetails) String ¶ 

func (m UpdateVaultDetails) String() string

type UpdateVaultRequest ¶ 

type UpdateVaultRequest struct {

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

	// UpdateVaultDetails
	UpdateVaultDetails `contributesTo:"body"`

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

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

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

UpdateVaultRequest wrapper for the UpdateVault operation

func (UpdateVaultRequest) HTTPRequest ¶ 

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

HTTPRequest implements the OCIRequest interface

func (UpdateVaultRequest) RetryPolicy ¶ 

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

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

func (UpdateVaultRequest) String ¶ 

func (request UpdateVaultRequest) String() string

type UpdateVaultResponse ¶ 

type UpdateVaultResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

UpdateVaultResponse wrapper for the UpdateVault operation

func (UpdateVaultResponse) HTTPResponse ¶ 

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

HTTPResponse implements the OCIResponse interface

func (UpdateVaultResponse) String ¶ 

func (response UpdateVaultResponse) String() string

type Vault ¶ 

type Vault struct {

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

	// The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and '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"`

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

	// An optional property for the deletion time of 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 ¶ 

func (m Vault) String() string

type VaultLifecycleStateEnum ¶ 

type VaultLifecycleStateEnum string

VaultLifecycleStateEnum Enum with underlying type: string 

const (
	VaultLifecycleStateCreating           VaultLifecycleStateEnum = "CREATING"
	VaultLifecycleStateActive             VaultLifecycleStateEnum = "ACTIVE"
	VaultLifecycleStateDeleting           VaultLifecycleStateEnum = "DELETING"
	VaultLifecycleStateDeleted            VaultLifecycleStateEnum = "DELETED"
	VaultLifecycleStatePendingDeletion    VaultLifecycleStateEnum = "PENDING_DELETION"
	VaultLifecycleStateSchedulingDeletion VaultLifecycleStateEnum = "SCHEDULING_DELETION"
	VaultLifecycleStateCancellingDeletion VaultLifecycleStateEnum = "CANCELLING_DELETION"
)

Set of constants representing the allowable values for VaultLifecycleStateEnum

func GetVaultLifecycleStateEnumValues ¶ 

func GetVaultLifecycleStateEnumValues() []VaultLifecycleStateEnum

GetVaultLifecycleStateEnumValues Enumerates the set of values for VaultLifecycleStateEnum

type VaultSummary ¶ 

type VaultSummary struct {

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

	// The service endpoint to perform cryptographic operations against. Cryptographic operations include 'Encrypt,' 'Decrypt,' and '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"`

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

VaultSummary The representation of VaultSummary

func (VaultSummary) String ¶ 

func (m VaultSummary) String() string

type VaultSummaryLifecycleStateEnum ¶ 

type VaultSummaryLifecycleStateEnum string

VaultSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	VaultSummaryLifecycleStateCreating           VaultSummaryLifecycleStateEnum = "CREATING"
	VaultSummaryLifecycleStateActive             VaultSummaryLifecycleStateEnum = "ACTIVE"
	VaultSummaryLifecycleStateDeleting           VaultSummaryLifecycleStateEnum = "DELETING"
	VaultSummaryLifecycleStateDeleted            VaultSummaryLifecycleStateEnum = "DELETED"
	VaultSummaryLifecycleStatePendingDeletion    VaultSummaryLifecycleStateEnum = "PENDING_DELETION"
	VaultSummaryLifecycleStateSchedulingDeletion VaultSummaryLifecycleStateEnum = "SCHEDULING_DELETION"
	VaultSummaryLifecycleStateCancellingDeletion VaultSummaryLifecycleStateEnum = "CANCELLING_DELETION"
)

Set of constants representing the allowable values for VaultSummaryLifecycleStateEnum

func GetVaultSummaryLifecycleStateEnumValues ¶ 

func GetVaultSummaryLifecycleStateEnumValues() []VaultSummaryLifecycleStateEnum

GetVaultSummaryLifecycleStateEnumValues Enumerates the set of values for VaultSummaryLifecycleStateEnum

type VaultSummaryVaultTypeEnum ¶ 

type VaultSummaryVaultTypeEnum string

VaultSummaryVaultTypeEnum Enum with underlying type: string 

const (
	VaultSummaryVaultTypePrivate VaultSummaryVaultTypeEnum = "VIRTUAL_PRIVATE"
)

Set of constants representing the allowable values for VaultSummaryVaultTypeEnum

func GetVaultSummaryVaultTypeEnumValues ¶ 

func GetVaultSummaryVaultTypeEnumValues() []VaultSummaryVaultTypeEnum

GetVaultSummaryVaultTypeEnumValues Enumerates the set of values for VaultSummaryVaultTypeEnum

type VaultVaultTypeEnum ¶ 

type VaultVaultTypeEnum string

VaultVaultTypeEnum Enum with underlying type: string 

const (
	VaultVaultTypePrivate VaultVaultTypeEnum = "VIRTUAL_PRIVATE"
)

Set of constants representing the allowable values for VaultVaultTypeEnum

func GetVaultVaultTypeEnumValues ¶ 

func GetVaultVaultTypeEnumValues() []VaultVaultTypeEnum

GetVaultVaultTypeEnumValues Enumerates the set of values for VaultVaultTypeEnum

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.