Class: OCI::LoadBalancer::Models::CertificateDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/load_balancer/models/certificate_details.rb

Overview

The configuration details for a listener certificate bundle. For more information on SSL certficate configuration, see [Managing SSL Certificates](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/managingcertificates.htm).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CertificateDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :caCertificate (String) —

    The value to assign to the #ca_certificate property

  • :certificateName (String) —

    The value to assign to the #certificate_name property

  • :passphrase (String) —

    The value to assign to the #passphrase property

  • :privateKey (String) —

    The value to assign to the #private_key property

  • :publicCertificate (String) —

    The value to assign to the #public_certificate property



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 80

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}

  if attributes[:'caCertificate']
    self.ca_certificate = attributes[:'caCertificate']
  end

  if attributes[:'certificateName']
    self.certificate_name = attributes[:'certificateName']
  end

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

  if attributes[:'privateKey']
    self.private_key = attributes[:'privateKey']
  end

  if attributes[:'publicCertificate']
    self.public_certificate = attributes[:'publicCertificate']
  end

end

Instance Attribute Details

#ca_certificate ⇒ String

The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.

Example:

-----BEGIN CERTIFICATE-----
MIIEczCCA1ugAwIBAgIBADANBgkqhkiG9w0BAQQFAD..AkGA1UEBhMCR0Ix
EzARBgNVBAgTClNvbWUtU3RhdGUxFDASBgNVBAoTC0..0EgTHRkMTcwNQYD
VQQLEy5DbGFzcyAxIFB1YmxpYyBQcmltYXJ5IENlcn..XRpb24gQXV0aG9y
aXR5MRQwEgYDVQQDEwtCZXN0IENBIEx0ZDAeFw0wMD..TUwMTZaFw0wMTAy
...
-----END CERTIFICATE-----

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 24

def ca_certificate
  @ca_certificate
end

#certificate_name ⇒ String

[Required] A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information.

Example: ‘My_certificate_bundle`

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 33

def certificate_name
  @certificate_name
end

#passphrase ⇒ String

A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase.

Example: ‘Mysecretunlockingcode42!1!`

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 40

def passphrase
  @passphrase
end

#private_key ⇒ String

The SSL private key for your certificate, in PEM format.

Example:

-----BEGIN RSA PRIVATE KEY-----
jO1O1v2ftXMsawM90tnXwc6xhOAT1gDBC9S8DKeca..JZNUgYYwNS0dP2UK
tmyN+XqVcAKw4HqVmChXy5b5msu8eIq3uc2NqNVtR..2ksSLukP8pxXcHyb
+sEwvM4uf8qbnHAqwnOnP9+KV9vds6BaH1eRA4CHz..n+NVZlzBsTxTlS16
/Umr7wJzVrMqK5sDiSu4WuaaBdqMGfL5hLsTjcBFD..Da2iyQmSKuVD4lIZ
...
-----END RSA PRIVATE KEY-----

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 55

def private_key
  @private_key
end

#public_certificate ⇒ String

The public certificate, in PEM format, that you received from your SSL certificate provider.

Example:

-----BEGIN CERTIFICATE-----
MIIC2jCCAkMCAg38MA0GCSqGSIb3DQEBBQUAMIGbMQswCQYDVQQGEwJKUDEOMAwG
A1UECBMFVG9reW8xEDAOBgNVBAcTB0NodW8ta3UxETAPBgNVBAoTCEZyYW5rNERE
MRgwFgYDVQQLEw9XZWJDZXJ0IFN1cHBvcnQxGDAWBgNVBAMTD0ZyYW5rNEREIFdl
YiBDQTEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmcmFuazRkZC5jb20wHhcNMTIw
...
-----END CERTIFICATE-----

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 70

def public_certificate
  @public_certificate
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 110

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      ca_certificate == other_object.ca_certificate &&
      certificate_name == other_object.certificate_name &&
      passphrase == other_object.passphrase &&
      private_key == other_object.private_key &&
      public_certificate == other_object.public_certificate
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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 135

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


122
123
124
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 122

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 128

def hash
  [ca_certificate, certificate_name, passphrase, private_key, public_certificate].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 160

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



154
155
156
 
# File 'lib/oci/load_balancer/models/certificate_details.rb', line 154

def to_s
  to_hash.to_s
end