Class: OCI::CertificatesManagement::Models::CreateCertificateAuthorityDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/certificates_management/models/create_certificate_authority_details.rb

Overview

The details for creating a certificate authority (CA).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCertificateAuthorityDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 106

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

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

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

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

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

  self.certificate_authority_config = attributes[:'certificateAuthorityConfig'] if attributes[:'certificateAuthorityConfig']

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

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

  self.certificate_revocation_list_details = attributes[:'certificateRevocationListDetails'] if attributes[:'certificateRevocationListDetails']

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

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

  self.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

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

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

  self.external_key_description = attributes[:'externalKeyDescription'] if attributes[:'externalKeyDescription']

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

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

  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.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']
end

Instance Attribute Details

#certificate_authority_config ⇒ OCI::CertificatesManagement::Models::CreateCertificateAuthorityConfigDetails

This attribute is required.

Returns:



29
30
31
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 29

def certificate_authority_config
  @certificate_authority_config
end

#certificate_authority_rules ⇒ Array<OCI::CertificatesManagement::Models::CertificateAuthorityRule>

A list of rules that control how the CA is used and managed.

Returns:



25
26
27
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 25

def certificate_authority_rules
  @certificate_authority_rules
end

#certificate_revocation_list_details ⇒ OCI::CertificatesManagement::Models::CertificateRevocationListDetails

Returns:



32
33
34
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 32

def certificate_revocation_list_details
  @certificate_revocation_list_details
end

#compartment_id ⇒ String

[Required] The compartment in which you want to create the CA.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 21

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


52
53
54
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 52

def defined_tags
  @defined_tags
end

#description ⇒ String

A brief description of the CA.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 17

def description
  @description
end

#external_key_description ⇒ String

For externally managed CAs, a description of the externally managed private key. Avoid entering confidential information.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 40

def external_key_description
  @external_key_description
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: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


46
47
48
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 46

def freeform_tags
  @freeform_tags
end

#kms_key_id ⇒ String

The OCID of the Oracle Cloud Infrastructure Vault key used to encrypt the CA.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 36

def kms_key_id
  @kms_key_id
end

#name ⇒ String

[Required] A user-friendly name for the CA. Names are unique within a compartment. Avoid entering confidential information. Valid characters include uppercase or lowercase letters, numbers, hyphens, underscores, and periods.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 13

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'certificate_authority_rules': :'certificateAuthorityRules',
    'certificate_authority_config': :'certificateAuthorityConfig',
    'certificate_revocation_list_details': :'certificateRevocationListDetails',
    'kms_key_id': :'kmsKeyId',
    'external_key_description': :'externalKeyDescription',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 73

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'certificate_authority_rules': :'Array<OCI::CertificatesManagement::Models::CertificateAuthorityRule>',
    'certificate_authority_config': :'OCI::CertificatesManagement::Models::CreateCertificateAuthorityConfigDetails',
    'certificate_revocation_list_details': :'OCI::CertificatesManagement::Models::CertificateRevocationListDetails',
    'kms_key_id': :'String',
    'external_key_description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 173

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    certificate_authority_rules == other.certificate_authority_rules &&
    certificate_authority_config == other.certificate_authority_config &&
    certificate_revocation_list_details == other.certificate_revocation_list_details &&
    kms_key_id == other.kms_key_id &&
    external_key_description == other.external_key_description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 212

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


192
193
194
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 192

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



201
202
203
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 201

def hash
  [name, description, compartment_id, certificate_authority_rules, certificate_authority_config, certificate_revocation_list_details, kms_key_id, external_key_description, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 245

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



239
240
241
 
# File 'lib/oci/certificates_management/models/create_certificate_authority_details.rb', line 239

def to_s
  to_hash.to_s
end