Class: OCI::KeyManagement::Models::VaultSummary
- Inherits:
-
Object
- Object
- OCI::KeyManagement::Models::VaultSummary
- Defined in:
- lib/oci/key_management/models/vault_summary.rb
Overview
VaultSummary model.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'.freeze, LIFECYCLE_STATE_SCHEDULING_DELETION = 'SCHEDULING_DELETION'.freeze, LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- VAULT_TYPE_ENUM =
[ VAULT_TYPE_VIRTUAL_PRIVATE = 'VIRTUAL_PRIVATE'.freeze, VAULT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains a particular vault.
-
#crypto_endpoint ⇒ String
[Required] The service endpoint to perform cryptographic operations against.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys.
-
#display_name ⇒ String
[Required] A user-friendly name for a vault.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type, or scope.
-
#id ⇒ String
[Required] The OCID of a vault.
-
#lifecycle_state ⇒ String
[Required] A vault’s current state.
-
#management_endpoint ⇒ String
[Required] The service endpoint to perform management operations against.
-
#time_created ⇒ DateTime
[Required] The date and time a vault was created, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format.
-
#vault_type ⇒ String
[Required] The type of vault.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ VaultSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ VaultSummary
Initializes the object
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 134 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. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = 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.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'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains a particular vault.
29 30 31 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 29 def compartment_id @compartment_id end |
#crypto_endpoint ⇒ String
[Required] The service endpoint to perform cryptographic operations against. Cryptographic operations include ‘Encrypt,’ ‘Decrypt,’ and ‘GenerateDataEncryptionKey’ operations.
34 35 36 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 34 def crypto_endpoint @crypto_endpoint end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: ‘{"bar-key": "foo-value"}`
40 41 42 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 40 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name for a vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.
46 47 48 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 46 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: ‘"value"`
53 54 55 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 53 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of a vault.
57 58 59 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 57 def id @id end |
#lifecycle_state ⇒ String
[Required] A vault’s current state.
Example: ‘ACTIVE`
64 65 66 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 64 def lifecycle_state @lifecycle_state end |
#management_endpoint ⇒ String
[Required] The service endpoint to perform management operations against. Management operations include ‘Create,’ ‘Update,’ ‘List,’ ‘Get,’ and ‘Delete’ operations.
69 70 71 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 69 def management_endpoint @management_endpoint end |
#time_created ⇒ DateTime
[Required] The date and time a vault was created, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format.
Example: ‘2018-04-03T21:10:29.600Z`
76 77 78 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 76 def time_created @time_created end |
#vault_type ⇒ String
[Required] The type of vault. Each type of vault stores keys with different degrees of isolation and has different options and pricing.
80 81 82 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 80 def vault_type @vault_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 83 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', 'vault_type': :'vaultType' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 101 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', 'vault_type': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 230 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && crypto_endpoint == other.crypto_endpoint && == other. && display_name == other.display_name && == other. && id == other.id && lifecycle_state == other.lifecycle_state && management_endpoint == other.management_endpoint && time_created == other.time_created && vault_type == other.vault_type end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 269 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) ⇒ Boolean
249 250 251 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 249 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
258 259 260 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 258 def hash [compartment_id, crypto_endpoint, , display_name, , id, lifecycle_state, management_endpoint, time_created, vault_type].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
302 303 304 305 306 307 308 309 310 311 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 302 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 ⇒ String
Returns the string representation of the object
296 297 298 |
# File 'lib/oci/key_management/models/vault_summary.rb', line 296 def to_s to_hash.to_s end |