Class: OCI::CertificatesManagement::Models::CertificateAuthorityIssuanceRule

Inherits:
CertificateAuthorityRule show all
Defined in:
lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb

Overview

Issuance rules apply constraints to a certificate authority (CA) to enforce certain conditions regarding the resources it issues. For example, a path length constraint restricts how many subordinate CAs a CA can have. Or, a name constraint on certificate subject names specifies allowable namespaces for the hierarchical name forms in certificates that any CA in the certificate chain issues. You can't update the issuance rules configured for a CA after you create it.

Constant Summary

Constants inherited from CertificateAuthorityRule

OCI::CertificatesManagement::Models::CertificateAuthorityRule::RULE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CertificateAuthorityRule

#rule_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CertificateAuthorityRule

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CertificateAuthorityIssuanceRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 51

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['ruleType'] = 'CERTIFICATE_AUTHORITY_ISSUANCE_RULE'

  super(attributes)

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

  self.path_length_constraint = attributes[:'pathLengthConstraint'] if attributes[:'pathLengthConstraint']

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

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

  self.name_constraint = attributes[:'nameConstraint'] if attributes[:'nameConstraint']

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

  self.name_constraint = attributes[:'name_constraint'] if attributes[:'name_constraint']
end

Instance Attribute Details

#name_constraint ⇒ OCI::CertificatesManagement::Models::NameConstraint

Returns:



19
20
21
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 19

def name_constraint
  @name_constraint
end

#path_length_constraint ⇒ Integer

The number of levels of descendants that this certificate authority (CA) can issue. When set to zero, the CA can issue only leaf certificates. There is no limit if the constraint isn't specified.

Returns:

  • (Integer) 


16
17
18
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 16

def path_length_constraint
  @path_length_constraint
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'rule_type': :'ruleType',
    'path_length_constraint': :'pathLengthConstraint',
    'name_constraint': :'nameConstraint'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 33

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'rule_type': :'String',
    'path_length_constraint': :'Integer',
    'name_constraint': :'OCI::CertificatesManagement::Models::NameConstraint'
    # 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



81
82
83
84
85
86
87
88
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 81

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

  self.class == other.class &&
    rule_type == other.rule_type &&
    path_length_constraint == other.path_length_constraint &&
    name_constraint == other.name_constraint
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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 113

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


93
94
95
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 93

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



102
103
104
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 102

def hash
  [rule_type, path_length_constraint, name_constraint].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 146

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



140
141
142
 
# File 'lib/oci/certificates_management/models/certificate_authority_issuance_rule.rb', line 140

def to_s
  to_hash.to_s
end