open-vault/vendor/github.com/oracle/oci-go-sdk/keymanagement/key.go

104 lines
4.3 KiB
Go

// Copyright (c) 2016, 2018, 2019, Oracle and/or its affiliates. All rights reserved.
// Code generated. DO NOT EDIT.
// Key Management Service API
//
// API for managing and performing operations with keys and vaults.
//
package keymanagement
import (
"github.com/oracle/oci-go-sdk/common"
)
// Key The representation of 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"`
// An optional property for the deletion time of the key, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2019-04-03T21:10:29.600Z`
TimeOfDeletion *common.SDKTime `mandatory:"false" json:"timeOfDeletion"`
}
func (m Key) String() string {
return common.PointerString(m)
}
// KeyLifecycleStateEnum Enum with underlying type: string
type KeyLifecycleStateEnum string
// Set of constants representing the allowable values for KeyLifecycleStateEnum
const (
KeyLifecycleStateCreating KeyLifecycleStateEnum = "CREATING"
KeyLifecycleStateEnabling KeyLifecycleStateEnum = "ENABLING"
KeyLifecycleStateEnabled KeyLifecycleStateEnum = "ENABLED"
KeyLifecycleStateDisabling KeyLifecycleStateEnum = "DISABLING"
KeyLifecycleStateDisabled KeyLifecycleStateEnum = "DISABLED"
KeyLifecycleStateDeleting KeyLifecycleStateEnum = "DELETING"
KeyLifecycleStateDeleted KeyLifecycleStateEnum = "DELETED"
KeyLifecycleStatePendingDeletion KeyLifecycleStateEnum = "PENDING_DELETION"
KeyLifecycleStateSchedulingDeletion KeyLifecycleStateEnum = "SCHEDULING_DELETION"
KeyLifecycleStateCancellingDeletion KeyLifecycleStateEnum = "CANCELLING_DELETION"
KeyLifecycleStateUpdating KeyLifecycleStateEnum = "UPDATING"
)
var mappingKeyLifecycleState = map[string]KeyLifecycleStateEnum{
"CREATING": KeyLifecycleStateCreating,
"ENABLING": KeyLifecycleStateEnabling,
"ENABLED": KeyLifecycleStateEnabled,
"DISABLING": KeyLifecycleStateDisabling,
"DISABLED": KeyLifecycleStateDisabled,
"DELETING": KeyLifecycleStateDeleting,
"DELETED": KeyLifecycleStateDeleted,
"PENDING_DELETION": KeyLifecycleStatePendingDeletion,
"SCHEDULING_DELETION": KeyLifecycleStateSchedulingDeletion,
"CANCELLING_DELETION": KeyLifecycleStateCancellingDeletion,
"UPDATING": KeyLifecycleStateUpdating,
}
// GetKeyLifecycleStateEnumValues Enumerates the set of values for KeyLifecycleStateEnum
func GetKeyLifecycleStateEnumValues() []KeyLifecycleStateEnum {
values := make([]KeyLifecycleStateEnum, 0)
for _, v := range mappingKeyLifecycleState {
values = append(values, v)
}
return values
}