class OCI::KeyManagement::Models::Vault

Vault model.

Constants

LIFECYCLE_STATE_ENUM
VAULT_TYPE_ENUM

Attributes

compartment_id[RW]

[Required] The OCID of the compartment that contains this vault. @return [String]

crypto_endpoint[RW]

[Required] The service endpoint to perform cryptographic operations against. Cryptographic operations include [Encrypt](docs.cloud.oracle.com/api/#/en/key/latest/EncryptedData/Encrypt), [Decrypt](docs.cloud.oracle.com/api/#/en/key/latest/DecryptedData/Decrypt), and [GenerateDataEncryptionKey](docs.cloud.oracle.com/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations.

@return [String]

defined_tags[RW]

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

@return [Hash<String, Hash<String, Object>>]

display_name[RW]

[Required] A user-friendly name for the vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.

@return [String]

freeform_tags[RW]

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

@return [Hash<String, String>]

id[RW]

[Required] The OCID of the vault. @return [String]

is_primary[RW]

@return [BOOLEAN]

lifecycle_state[R]

[Required] The vault's current lifecycle state.

Example: `DELETED`

@return [String]

management_endpoint[RW]

[Required] The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.

@return [String]

replica_details[RW]

@return [OCI::KeyManagement::Models::VaultReplicaDetails]

restored_from_vault_id[RW]

The OCID of the vault from which this vault was restored, if it was restored from a backup file. If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.

@return [String]

time_created[RW]

[Required] The date and time this vault was created, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format.

Example: `2018-04-03T21:10:29.600Z`

@return [DateTime]

time_of_deletion[RW]

An optional property to indicate when to delete the vault, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z`

@return [DateTime]

vault_type[R]

[Required] The type of vault. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

@return [String]

wrappingkey_id[RW]

[Required] The OCID of the vault's wrapping key. @return [String]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/key_management/models/vault.rb, line 115
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'crypto_endpoint': :'cryptoEndpoint',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'management_endpoint': :'managementEndpoint',
    'time_created': :'timeCreated',
    'time_of_deletion': :'timeOfDeletion',
    'vault_type': :'vaultType',
    'restored_from_vault_id': :'restoredFromVaultId',
    'wrappingkey_id': :'wrappingkeyId',
    'replica_details': :'replicaDetails',
    'is_primary': :'isPrimary'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :crypto_endpoint The value to assign to the {#crypto_endpoint} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :management_endpoint The value to assign to the {#management_endpoint} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_of_deletion The value to assign to the {#time_of_deletion} property @option attributes [String] :vault_type The value to assign to the {#vault_type} property @option attributes [String] :restored_from_vault_id The value to assign to the {#restored_from_vault_id} property @option attributes [String] :wrappingkey_id The value to assign to the {#wrappingkey_id} property @option attributes [OCI::KeyManagement::Models::VaultReplicaDetails] :replica_details The value to assign to the {#replica_details} property @option attributes [BOOLEAN] :is_primary The value to assign to the {#is_primary} property

# File lib/oci/key_management/models/vault.rb, line 181
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.crypto_endpoint = attributes[:'cryptoEndpoint'] if attributes[:'cryptoEndpoint']

  raise 'You cannot provide both :cryptoEndpoint and :crypto_endpoint' if attributes.key?(:'cryptoEndpoint') && attributes.key?(:'crypto_endpoint')

  self.crypto_endpoint = attributes[:'crypto_endpoint'] if attributes[:'crypto_endpoint']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.id = attributes[:'id'] if attributes[:'id']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.management_endpoint = attributes[:'managementEndpoint'] if attributes[:'managementEndpoint']

  raise 'You cannot provide both :managementEndpoint and :management_endpoint' if attributes.key?(:'managementEndpoint') && attributes.key?(:'management_endpoint')

  self.management_endpoint = attributes[:'management_endpoint'] if attributes[:'management_endpoint']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_of_deletion = attributes[:'timeOfDeletion'] if attributes[:'timeOfDeletion']

  raise 'You cannot provide both :timeOfDeletion and :time_of_deletion' if attributes.key?(:'timeOfDeletion') && attributes.key?(:'time_of_deletion')

  self.time_of_deletion = attributes[:'time_of_deletion'] if attributes[:'time_of_deletion']

  self.vault_type = attributes[:'vaultType'] if attributes[:'vaultType']

  raise 'You cannot provide both :vaultType and :vault_type' if attributes.key?(:'vaultType') && attributes.key?(:'vault_type')

  self.vault_type = attributes[:'vault_type'] if attributes[:'vault_type']

  self.restored_from_vault_id = attributes[:'restoredFromVaultId'] if attributes[:'restoredFromVaultId']

  raise 'You cannot provide both :restoredFromVaultId and :restored_from_vault_id' if attributes.key?(:'restoredFromVaultId') && attributes.key?(:'restored_from_vault_id')

  self.restored_from_vault_id = attributes[:'restored_from_vault_id'] if attributes[:'restored_from_vault_id']

  self.wrappingkey_id = attributes[:'wrappingkeyId'] if attributes[:'wrappingkeyId']

  raise 'You cannot provide both :wrappingkeyId and :wrappingkey_id' if attributes.key?(:'wrappingkeyId') && attributes.key?(:'wrappingkey_id')

  self.wrappingkey_id = attributes[:'wrappingkey_id'] if attributes[:'wrappingkey_id']

  self.replica_details = attributes[:'replicaDetails'] if attributes[:'replicaDetails']

  raise 'You cannot provide both :replicaDetails and :replica_details' if attributes.key?(:'replicaDetails') && attributes.key?(:'replica_details')

  self.replica_details = attributes[:'replica_details'] if attributes[:'replica_details']

  self.is_primary = attributes[:'isPrimary'] unless attributes[:'isPrimary'].nil?

  raise 'You cannot provide both :isPrimary and :is_primary' if attributes.key?(:'isPrimary') && attributes.key?(:'is_primary')

  self.is_primary = attributes[:'is_primary'] unless attributes[:'is_primary'].nil?
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/key_management/models/vault.rb, line 138
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'crypto_endpoint': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'lifecycle_state': :'String',
    'management_endpoint': :'String',
    'time_created': :'DateTime',
    'time_of_deletion': :'DateTime',
    'vault_type': :'String',
    'restored_from_vault_id': :'String',
    'wrappingkey_id': :'String',
    'replica_details': :'OCI::KeyManagement::Models::VaultReplicaDetails',
    'is_primary': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/key_management/models/vault.rb, line 307
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    crypto_endpoint == other.crypto_endpoint &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    management_endpoint == other.management_endpoint &&
    time_created == other.time_created &&
    time_of_deletion == other.time_of_deletion &&
    vault_type == other.vault_type &&
    restored_from_vault_id == other.restored_from_vault_id &&
    wrappingkey_id == other.wrappingkey_id &&
    replica_details == other.replica_details &&
    is_primary == other.is_primary
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/key_management/models/vault.rb, line 351
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/key_management/models/vault.rb, line 331
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/key_management/models/vault.rb, line 340
def hash
  [compartment_id, crypto_endpoint, defined_tags, display_name, freeform_tags, id, lifecycle_state, management_endpoint, time_created, time_of_deletion, vault_type, restored_from_vault_id, wrappingkey_id, replica_details, is_primary].hash
end
lifecycle_state=(lifecycle_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state Object to be assigned

# File lib/oci/key_management/models/vault.rb, line 278
def lifecycle_state=(lifecycle_state)
  # rubocop:disable Style/ConditionalAssignment
  if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
    OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
  else
    @lifecycle_state = lifecycle_state
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/key_management/models/vault.rb, line 384
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/key_management/models/vault.rb, line 378
def to_s
  to_hash.to_s
end
vault_type=(vault_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] vault_type Object to be assigned

# File lib/oci/key_management/models/vault.rb, line 291
def vault_type=(vault_type)
  # rubocop:disable Style/ConditionalAssignment
  if vault_type && !VAULT_TYPE_ENUM.include?(vault_type)
    OCI.logger.debug("Unknown value for 'vault_type' [" + vault_type + "]. Mapping to 'VAULT_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @vault_type = VAULT_TYPE_UNKNOWN_ENUM_VALUE
  else
    @vault_type = vault_type
  end
  # rubocop:enable Style/ConditionalAssignment
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/key_management/models/vault.rb, line 401
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end