Package com.ibm.cloud.ibm_key_protect_api.v2.model

Interface Summary

Interface	Description
ActionOnKeyOptions.Action	The action to perform on the specified key.
ActionOnKeyOptions.Prefer	Alters server behavior for POST or DELETE operations.
CollectionMetadata.CollectionType	The type of resources in the resource array.
CollectionMetadataWithTotalCount.CollectionType	The type of resources in the resource array.
CreateKeyOptions.Prefer	Alters server behavior for POST or DELETE operations.
DeleteKeyOptions.Prefer	Alters server behavior for POST or DELETE operations.
GetInstancePoliciesOneOfGetInstancePolicyAllowedNetworkResourcesItemPolicyDataAttributes.AllowedNetwork	If set to `public-and-private`, Key Protect allows the instance to be accessible through public and private endpoints.
GetInstancePoliciesOneOfResourcesItemPolicyDataAttributes.AllowedNetwork	If set to `public-and-private`, Key Protect allows the instance to be accessible through public and private endpoints.
GetInstancePolicyOptions.Policy	The type of policy that is associated with the specified instance.
GetKeyPoliciesOneOfGetKeyPolicyDualAuthDeleteResourcesItem.Type	Specifies the MIME type that represents the policy resource.
GetKeyPoliciesOneOfResourcesItem.Type	Specifies the MIME type that represents the policy resource.
GetKeyPolicyRotationResourcesItem.Type	Specifies the MIME type that represents the policy resource.
GetMultipleKeyPoliciesResource.Type	Specifies the MIME type that represents the policy resource.
GetPolicyOptions.Policy	The type of policy that is associated with the specified key.
InstancePolicyAllAttributes.AllowedNetwork	If set to `public-and-private`, Key Protect allows the instance to be accessible through public and private endpoints.
InstancePolicyAllowedNetworkPolicyDataAttributes.AllowedNetwork	If set to `public-and-private`, Key Protect allows the instance to be accessible through public and private endpoints.
KeyFullRepresentation.AlgorithmMode	The encryption scheme used to generate the key.
KeyFullRepresentation.AlgorithmType	The algorithm type used to generate the key.
KeyFullRepresentationAlgorithmMetadata.Mode	The encryption scheme used to generate the key.
KeyPolicyDualAuthDelete.Type	Specifies the MIME type that represents the policy resource.
KeyPolicyRotation.Type	Specifies the MIME type that represents the policy resource.
KeyRepresentation.AlgorithmMode	The encryption scheme used to generate the key.
KeyRepresentation.AlgorithmType	The algorithm type used to generate the key.
KeyRepresentationAlgorithmMetadata.Mode	The encryption scheme used to generate the key.
KeyWithPayload.AlgorithmMode	The encryption scheme used to generate the key.
KeyWithPayload.AlgorithmType	The algorithm type used to generate the key.
KeyWithPayloadAlgorithmMetadata.Mode	The encryption scheme used to generate the key.
NetworkPolicyAttribute.AllowedNetwork	If set to `public-and-private`, Key Protect allows the instance to be accessible through public and private endpoints.
PurgeKeyOptions.Prefer	Alters server behavior for POST or DELETE operations.
PutInstancePolicyOptions.Policy	The type of policy that is associated with the specified instance.
PutPolicyOptions.Policy	The type of policy that is associated with the specified key.
RestoreKeyOptions.Prefer	Alters server behavior for POST or DELETE operations.
RotateKeyOptions.Prefer	Alters server behavior for POST or DELETE operations.
SetInstancePoliciesOneOfResourcesItem.PolicyType	The type of policy to be set.
SetInstancePoliciesOneOfSetInstancePolicyAllowedIPResourcesItem.PolicyType	The type of policy to be set.
SetInstancePoliciesOneOfSetInstancePolicyAllowedNetworkResourcesItem.PolicyType	The type of policy to be set.
SetInstancePoliciesOneOfSetInstancePolicyKeyCreateImportAccessResourcesItem.PolicyType	The type of policy to be set.
SetInstancePoliciesOneOfSetInstancePolicyMetricsResourcesItem.PolicyType	The type of policy to be set.
SetInstancePolicyDualAuthDeleteResourcesItem.PolicyType	The type of policy to be set.
SetMultipleInstancePoliciesResourcesItem.PolicyType	The type of policy to be set.
SetMultipleInstancePoliciesResourcesItemPolicyDataAttributes.AllowedNetwork	If set to `public-and-private`, Key Protect allows the instance to be accessible through public and private endpoints.
SetMultipleKeyPoliciesResource.Type	Specifies the MIME type that represents the policy resource.
SetMultipleKeyPoliciesResourcesItem.Type	Specifies the MIME type that represents the policy resource.

Class Summary

Class	Description
ActionOnKeyOptions	The actionOnKey options.
ActionOnKeyOptions.Builder	Builder.
AddHeaderInterceptor
AllowedIPPort	Properties associated with the port associated with an instance with an allowed IP policy.
AllowedIPPortResource	Metadata of the port associated with an instance with an allowed IP policy.
AllowedIPProperties	Data associated with the policy type `allowedIP`.
AllowedIPProperties.Builder	Builder.
CloudResourceName	The object that contains information about the Cloud Resource Name.
CloudResourceName.Builder	Builder.
CollectionMetadata	The metadata that describes the resource array.
CollectionMetadata.Builder	Builder.
CollectionMetadataWithTotalCount	The metadata that describes the resource array.
CreateKeyAliasOptions	The createKeyAlias options.
CreateKeyAliasOptions.Builder	Builder.
CreateKeyOptions	The createKey options.
CreateKeyOptions.Builder	Builder.
CreateKeyRingOptions	The createKeyRing options.
CreateKeyRingOptions.Builder	Builder.
DeleteKey	The base schema for deleting keys.
DeleteKeyAliasOptions	The deleteKeyAlias options.
DeleteKeyAliasOptions.Builder	Builder.
DeleteKeyOptions	The deleteKey options.
DeleteKeyOptions.Builder	Builder.
DeleteKeyRingOptions	The deleteKeyRing options.
DeleteKeyRingOptions.Builder	Builder.
DisableKeyOptions	The disableKey options.
DisableKeyOptions.Builder	Builder.
DualAuthDeleteProperties	User defined metadata that is associated with the `dualAuthDelete` instance policy type.
DualAuthDeleteProperties.Builder	Builder.
DualAuthKeyMetadata	Metadata that indicates the status of a dual authorization policy on the key.
EnableKeyOptions	The enableKey options.
EnableKeyOptions.Builder	Builder.
EventAcknowledgeOptions	The eventAcknowledge options.
EventAcknowledgeOptions.Builder	Builder.
GetAllowedIPPortOptions	The getAllowedIPPort options.
GetAllowedIPPortOptions.Builder	Builder.
GetImportToken	The base schema for retrieving an import token.
GetImportTokenOptions	The getImportToken options.
GetImportTokenOptions.Builder	Builder.
GetInstancePoliciesOneOf	GetInstancePoliciesOneOf.
GetInstancePoliciesOneOfGetInstancePolicyAllowedIP	Properties that are associated with retrieving an instance level allowed IP policy.
GetInstancePoliciesOneOfGetInstancePolicyAllowedNetwork	Properties that are associated with retrieving an instance level allowed network policy.
GetInstancePoliciesOneOfGetInstancePolicyAllowedNetworkResourcesItem	GetInstancePoliciesOneOfGetInstancePolicyAllowedNetworkResourcesItem.
GetInstancePoliciesOneOfGetInstancePolicyAllowedNetworkResourcesItemPolicyData	User defined metadata that is associated with the `allowedNetwork` instance policy type.
GetInstancePoliciesOneOfGetInstancePolicyAllowedNetworkResourcesItemPolicyDataAttributes	Data associated with the policy type `allowed_network`.
GetInstancePoliciesOneOfGetInstancePolicyDualAuthDelete	Properties that are associated with retrieving an instance level dual authorization delete policy.
GetInstancePoliciesOneOfGetInstancePolicyKeyCreateImportAccess	Properties that are associated with retrieving an instance level key create and import access policy.
GetInstancePoliciesOneOfGetInstancePolicyKeyCreateImportAccessResourcesItem	GetInstancePoliciesOneOfGetInstancePolicyKeyCreateImportAccessResourcesItem.
GetInstancePoliciesOneOfGetInstancePolicyKeyCreateImportAccessResourcesItemPolicyData	User defined metadata that is associated with the `keyCreateImportAccess` instance policy type.
GetInstancePoliciesOneOfGetInstancePolicyKeyCreateImportAccessResourcesItemPolicyDataAttributes	Data associated with the policy type `keyCreateImportAccess`.
GetInstancePoliciesOneOfGetInstancePolicyMetrics	Properties that are associated with retrieving an instance level metrics policy.
GetInstancePoliciesOneOfGetMultipleInstancePolicies	Properties that are associated with the instance level policies.
GetInstancePoliciesOneOfResourcesItem	GetInstancePoliciesOneOfResourcesItem.
GetInstancePoliciesOneOfResourcesItemPolicyData	User defined metadata that is associated with the `allowedNetwork` instance policy type.
GetInstancePoliciesOneOfResourcesItemPolicyDataAttributes	Data associated with the policy type `allowed_network`.
GetInstancePolicyAllowedIPResourcesItem	GetInstancePolicyAllowedIPResourcesItem.
GetInstancePolicyAllowedIPResourcesItemPolicyData	User defined metadata that is associated with the `allowedIP` instance policy type.
GetInstancePolicyAllowedIPResourcesItemPolicyDataAttributes	Data associated with the policy type `allowedIP`.
GetInstancePolicyDualAuthDeleteResourcesItem	GetInstancePolicyDualAuthDeleteResourcesItem.
GetInstancePolicyMetricsResourcesItem	GetInstancePolicyMetricsResourcesItem.
GetInstancePolicyOptions	The getInstancePolicy options.
GetInstancePolicyOptions.Builder	Builder.
GetKey	The base schema for retrieving keys.
GetKeyCollectionMetadataOptions	The getKeyCollectionMetadata options.
GetKeyCollectionMetadataOptions.Builder	Builder.
GetKeyMetadata	The base schema for retrieving key metadata.
GetKeyMetadataOptions	The getKeyMetadata options.
GetKeyMetadataOptions.Builder	Builder.
GetKeyOptions	The getKey options.
GetKeyOptions.Builder	Builder.
GetKeyPoliciesOneOf	GetKeyPoliciesOneOf.
GetKeyPoliciesOneOfGetKeyPolicyDualAuthDelete	The base schema for retrieving a dual authorization key policy.
GetKeyPoliciesOneOfGetKeyPolicyDualAuthDeleteResourcesItem	Properties that are associated with key level dual authorization delete policy.
GetKeyPoliciesOneOfGetKeyPolicyRotation	The base schema for retrieving a dual authorization key policy.
GetKeyPoliciesOneOfGetMultipleKeyPolicies	The base schema for retrieving all key policies.
GetKeyPoliciesOneOfResourcesItem	Properties that are associated with key level dual authorization delete policy.
GetKeyPoliciesOneOfResourcesItemDualAuthDelete	Data associated with the dual authorization delete policy.
GetKeyPoliciesOneOfResourcesItemRotation	Data associated with the dual authorization delete policy.
GetKeyPolicyRotationResourcesItem	Properties that are associated with rotation policy.
GetKeyPolicyRotationResourcesItemRotation	Specifies the key rotation time interval in months, with a minimum of 1, and a maximum of 12.
GetKeysOptions	The getKeys options.
GetKeysOptions.Builder	Builder.
GetKeyVersionsOptions	The getKeyVersions options.
GetKeyVersionsOptions.Builder	Builder.
GetMultipleKeyPoliciesResource	Properties that are associated with rotation policy.
GetMultipleKeyPoliciesResourceDualAuthDelete	Data associated with the dual authorization delete policy.
GetPolicyOptions	The getPolicy options.
GetPolicyOptions.Builder	Builder.
GetRegistrationsAllKeysOptions	The getRegistrationsAllKeys options.
GetRegistrationsAllKeysOptions.Builder	Builder.
GetRegistrationsOptions	The getRegistrations options.
GetRegistrationsOptions.Builder	Builder.
ImportToken	Properties that are associated with import tokens.
ImportToken.Builder	Builder.
InstancePolicyAllAttributes	All possible attributes for any instance policy type.
InstancePolicyAllowedIPPolicyData	User defined metadata that is associated with the `allowedIP` instance policy type.
InstancePolicyAllowedIPPolicyData.Builder	Builder.
InstancePolicyAllowedIPPolicyDataAttributes	Attributes of an `allowedIP` instance policy.
InstancePolicyAllowedIPPolicyDataAttributes.Builder	Builder.
InstancePolicyAllowedNetworkPolicyData	User defined metadata that is associated with the `allowedNetwork` instance policy type.
InstancePolicyAllowedNetworkPolicyData.Builder	Builder.
InstancePolicyAllowedNetworkPolicyDataAttributes	Attributes of an `allowedNetwork` instance policy.
InstancePolicyAllowedNetworkPolicyDataAttributes.Builder	Builder.
InstancePolicyKeyCreateImportAccessPolicyData	User defined metadata that is associated with the `keyCreateImportAccess` instance policy type.
InstancePolicyKeyCreateImportAccessPolicyData.Builder	Builder.
InstancePolicyKeyCreateImportAccessPolicyDataAttributes	Attributes of a `keyCreateImportAccess` instance policy.
InstancePolicyKeyCreateImportAccessPolicyDataAttributes.Builder	Builder.
InstancePolicyProperties	User defined metadata that is associated with any instance policy.
InstancePolicyResource	InstancePolicyResource.
InstancePolicyResourceAllowedNetworkPolicy	Properties that are associated with an allowed network policy.
Key	Properties associated with a key response.
KeyActionOneOfResponse	KeyActionOneOfResponse.
KeyActionOneOfResponseRewrapKeyResponseBody	Properties that are associated with the response body of an rewrap action.
KeyActionOneOfResponseUnwrapKeyResponseBody	Properties that are associated with the response body of an unwrap action.
KeyActionOneOfResponseWrapKeyResponseBody	Properties that are associated with the response body of a wrap action.
KeyAlias	Properties associated with a specific key alias.
KeyAliasResource	Properties associated with an alias.
KeyCreateImportAccessProperties	Data associated with the policy type `keyCreateImportAccess`.
KeyCreateImportAccessProperties.Builder	Builder.
KeyFullRepresentation	Properties returned only for DELETE.
KeyFullRepresentationAlgorithmMetadata	The metadata for the key algorithm.
KeyPolicyDualAuthDelete	Properties that are associated with key level dual authorization delete policy.
KeyPolicyDualAuthDelete.Builder	Builder.
KeyPolicyDualAuthDeleteDualAuthDelete	Data associated with the dual authorization delete policy.
KeyPolicyDualAuthDeleteDualAuthDelete.Builder	Builder.
KeyPolicyRotation	KeyPolicyRotation.
KeyPolicyRotation.Builder	Builder.
KeyPolicyRotationNonRequiredRotation	Specifies the key rotation time interval in months, with a minimum of 1, and a maximum of 12.
KeyPolicyRotationRotation	Specifies the key rotation time interval in months, with a minimum of 1, and a maximum of 12.
KeyPolicyRotationRotation.Builder	Builder.
KeyRepresentation	Additional properties that describe a key.
KeyRepresentationAlgorithmMetadata	The metadata for the key algorithm.
KeyRing	Base properties of an instance key ring.
KeyVersion	Properties associated with a specific key version.
KeyWithPayload	Properties returned only for DELETE.
KeyWithPayloadAlgorithmMetadata	The metadata for the key algorithm.
ListKeyRings	The base schema for listing key rings.
ListKeyRingsOptions	The listKeyRings options.
ListKeyRingsOptions.Builder	Builder.
ListKeys	The base schema for listing keys.
ListKeyVersions	Properties associated with a registration response.
MetricsProperties	User defined metadata that is associated with the `metrics` instance policy type.
MetricsProperties.Builder	Builder.
ModifiableRegistrationResourceBody	The base schema for the resource in the body of a create registration.
ModifiableRegistrationResourceBody.Builder	Builder.
NetworkPolicyAttribute	Properties that are associated with the policy type `allowedNetwork`.
NetworkPolicyAttribute.Builder	Builder.
NetworkPolicyProperties	Properties that are associated with the policy type `allowedNetwork`.
NetworkPolicyProperties.Builder	Builder.
PatchKeyOptions	The patchKey options.
PatchKeyOptions.Builder	Builder.
PatchKeyResponseBody	The base schema for patch key response body.
PostImportTokenOptions	The postImportToken options.
PostImportTokenOptions.Builder	Builder.
PurgeKey	The base schema for purged key.
PurgeKeyOptions	The purgeKey options.
PurgeKeyOptions.Builder	Builder.
PutInstancePolicyOptions	The putInstancePolicy options.
PutInstancePolicyOptions.Builder	Builder.
PutPolicyOptions	The putPolicy options.
PutPolicyOptions.Builder	Builder.
Registration	Properties associated with a registration response.
RegistrationResource	Properties associated with a registration.
RegistrationWithTotalCount	Properties associated with a list registration response which may include total registration count.
RestoreKeyOptions	The restoreKey options.
RestoreKeyOptions.Builder	Builder.
RetryInterceptor
RetryPolicy	Retry Policy to retry failed Http requests for particular response codes.
RewrapKeyOptions	The rewrapKey options.
RewrapKeyOptions.Builder	Builder.
RewrapKeyResponseBody	Properties that are associated with the response body of an rewrap action.
RotateKeyOptions	The rotateKey options.
RotateKeyOptions.Builder	Builder.
SetInstancePoliciesOneOf<T>	SetInstancePoliciesOneOf.
SetInstancePoliciesOneOfResourcesItem	SetInstancePoliciesOneOfResourcesItem.
SetInstancePoliciesOneOfResourcesItem.Builder	Builder.
SetInstancePoliciesOneOfSetInstancePolicyAllowedIP	Properties that are associated with setting an instance level allowed IP policy.
SetInstancePoliciesOneOfSetInstancePolicyAllowedIP.Builder	Builder.
SetInstancePoliciesOneOfSetInstancePolicyAllowedIPResourcesItem	SetInstancePoliciesOneOfSetInstancePolicyAllowedIPResourcesItem.
SetInstancePoliciesOneOfSetInstancePolicyAllowedIPResourcesItem.Builder	Builder.
SetInstancePoliciesOneOfSetInstancePolicyAllowedNetwork	Properties that are associated with setting an instance level allowed network policy.
SetInstancePoliciesOneOfSetInstancePolicyAllowedNetwork.Builder	Builder.
SetInstancePoliciesOneOfSetInstancePolicyAllowedNetworkResourcesItem	SetInstancePoliciesOneOfSetInstancePolicyAllowedNetworkResourcesItem.
SetInstancePoliciesOneOfSetInstancePolicyAllowedNetworkResourcesItem.Builder	Builder.
SetInstancePoliciesOneOfSetInstancePolicyDualAuthDelete	Properties that are associated with setting a dual authorization delete instance policy.
SetInstancePoliciesOneOfSetInstancePolicyDualAuthDelete.Builder	Builder.
SetInstancePoliciesOneOfSetInstancePolicyKeyCreateImportAccess	Properties that are associated with setting an instance level key create and import access policy.
SetInstancePoliciesOneOfSetInstancePolicyKeyCreateImportAccess.Builder	Builder.
SetInstancePoliciesOneOfSetInstancePolicyKeyCreateImportAccessResourcesItem	SetInstancePoliciesOneOfSetInstancePolicyKeyCreateImportAccessResourcesItem.
SetInstancePoliciesOneOfSetInstancePolicyKeyCreateImportAccessResourcesItem.Builder	Builder.
SetInstancePoliciesOneOfSetInstancePolicyMetrics	Properties that are associated with setting a metrics instance policy.
SetInstancePoliciesOneOfSetInstancePolicyMetrics.Builder	Builder.
SetInstancePoliciesOneOfSetInstancePolicyMetricsResourcesItem	SetInstancePoliciesOneOfSetInstancePolicyMetricsResourcesItem.
SetInstancePoliciesOneOfSetInstancePolicyMetricsResourcesItem.Builder	Builder.
SetInstancePoliciesOneOfSetMultipleInstancePolicies	Properties that are associated with setting any type of instance level policy.
SetInstancePoliciesOneOfSetMultipleInstancePolicies.Builder	Builder.
SetInstancePolicyDualAuthDeleteResourcesItem	SetInstancePolicyDualAuthDeleteResourcesItem.
SetInstancePolicyDualAuthDeleteResourcesItem.Builder	Builder.
SetKeyForDeletionOptions	The setKeyForDeletion options.
SetKeyForDeletionOptions.Builder	Builder.
SetKeyPoliciesOneOf<T>	SetKeyPoliciesOneOf.
SetKeyPoliciesOneOfSetKeyPolicyDualAuthDelete	Base schema for request of create/update of key level dual authorization delete policy.
SetKeyPoliciesOneOfSetKeyPolicyDualAuthDelete.Builder	Builder.
SetKeyPoliciesOneOfSetKeyPolicyRotation	Base schema for request of create/update of key level rotation policy.
SetKeyPoliciesOneOfSetKeyPolicyRotation.Builder	Builder.
SetKeyPoliciesOneOfSetMultipleKeyPolicies	Properties that are associated with key.
SetKeyPoliciesOneOfSetMultipleKeyPolicies.Builder	Builder.
SetMultipleInstancePoliciesResourcesItem	SetMultipleInstancePoliciesResourcesItem.
SetMultipleInstancePoliciesResourcesItem.Builder	Builder.
SetMultipleInstancePoliciesResourcesItemPolicyData	User defined metadata that is associated with any instance policy.
SetMultipleInstancePoliciesResourcesItemPolicyData.Builder	Builder.
SetMultipleInstancePoliciesResourcesItemPolicyDataAttributes	Attributes associated with any instance policy type.
SetMultipleInstancePoliciesResourcesItemPolicyDataAttributes.Builder	Builder.
SetMultipleKeyPoliciesResource	Properties that are associated with key level dual authorization delete policy.
SetMultipleKeyPoliciesResource.Builder	Builder.
SetMultipleKeyPoliciesResourceDualAuthDelete	Data associated with the dual authorization delete policy.
SetMultipleKeyPoliciesResourceDualAuthDelete.Builder	Builder.
SetMultipleKeyPoliciesResourceRotation	Specifies the key rotation time interval in months, with a minimum of 1, and a maximum of 12.
SetMultipleKeyPoliciesResourceRotation.Builder	Builder.
SetMultipleKeyPoliciesResourcesItem	SetMultipleKeyPoliciesResourcesItem.
SetMultipleKeyPoliciesResourcesItem.Builder	Builder.
SyncAssociatedResourcesOptions	The syncAssociatedResources options.
SyncAssociatedResourcesOptions.Builder	Builder.
UnsetKeyForDeletionOptions	The unsetKeyForDeletion options.
UnsetKeyForDeletionOptions.Builder	Builder.
UnwrapKeyOptions	The unwrapKey options.
UnwrapKeyOptions.Builder	Builder.
UnwrapKeyResponseBody	Properties that are associated with the response body of an unwrap action.
WrapKeyOptions	The wrapKey options.
WrapKeyOptions.Builder	Builder.
WrapKeyResponseBody	Properties that are associated with the response body of a wrap action.

Exception Summary

Exception	Description
KeyProtectException