Class: OCI::Vault::Models::SecretContentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vault/models/secret_content_details.rb

Overview

The content of the secret and metadata to help identify it. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

Base64SecretContentDetails

Constant Summary collapse

CONTENT_TYPE_ENUM = 
[
  CONTENT_TYPE_BASE64 = 'BASE64'.freeze
].freeze
STAGE_ENUM = 
[
  STAGE_CURRENT = 'CURRENT'.freeze,
  STAGE_PENDING = 'PENDING'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecretContentDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :content_type (String) —

    The value to assign to the #content_type property

  • :name (String) —

    The value to assign to the #name property

  • :stage (String) —

    The value to assign to the #stage property



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 83

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.content_type = attributes[:'contentType'] if attributes[:'contentType']

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

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

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

  self.stage = attributes[:'stage'] if attributes[:'stage']
  self.stage = "CURRENT" if stage.nil? && !attributes.key?(:'stage') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#content_type ⇒ String

[Required] The base64-encoded content of the secret.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 22

def content_type
  @content_type
end

#name ⇒ String

Names should be unique within a secret. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 26

def name
  @name
end

#stage ⇒ String

The rotation state of the secret content. The default is ‘CURRENT`, meaning that the secret is currently in use. A secret version that you mark as `PENDING` is staged and available for use, but you don’t yet want to rotate it into current, active use. For example, you might create or update a secret and mark its rotation state as ‘PENDING` if you haven’t yet updated the secret on the target system. When creating a secret, only the value ‘CURRENT` is applicable, although the value `LATEST` is also automatically applied. When updating a secret, you can specify a version’s rotation state as either ‘CURRENT` or `PENDING`.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 35

def stage
  @stage
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'content_type': :'contentType',
    'name': :'name',
    'stage': :'stage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



64
65
66
67
68
69
70
71
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 64

def self.get_subtype(object_hash)
  type = object_hash[:'contentType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Vault::Models::Base64SecretContentDetails' if type == 'BASE64'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Vault::Models::SecretContentDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'content_type': :'String',
    'name': :'String',
    'stage': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



124
125
126
127
128
129
130
131
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 124

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    content_type == other.content_type &&
    name == other.name &&
    stage == other.stage
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 156

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


136
137
138
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 136

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 145

def hash
  [content_type, name, stage].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 189

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

Returns:

  • (String) —

    String presentation of the object



183
184
185
 
# File 'lib/oci/vault/models/secret_content_details.rb', line 183

def to_s
  to_hash.to_s
end