Class: OCI::LoadBalancer::Models::Certificate

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

Overview

The configuration details of 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 = {}) ⇒ Certificate

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :ca_certificate (String) —

    The value to assign to the #ca_certificate property

  • :certificate_name (String) —

    The value to assign to the #certificate_name property

  • :public_certificate (String) —

    The value to assign to the #public_certificate property



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/load_balancer/models/certificate.rb', line 56

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#ca_certificate ⇒ String

[Required] 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.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.rb', line 33

def certificate_name
  @certificate_name
end

#public_certificate ⇒ String

[Required] 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) 


48
49
50
 
# File 'lib/oci/load_balancer/models/certificate.rb', line 48

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



96
97
98
99
100
101
102
 
# File 'lib/oci/load_balancer/models/certificate.rb', line 96

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 &&
      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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/load_balancer/models/certificate.rb', line 119

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


106
107
108
 
# File 'lib/oci/load_balancer/models/certificate.rb', line 106

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/oci/load_balancer/models/certificate.rb', line 112

def hash
  [ca_certificate, certificate_name, 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



144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/load_balancer/models/certificate.rb', line 144

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



138
139
140
 
# File 'lib/oci/load_balancer/models/certificate.rb', line 138

def to_s
  to_hash.to_s
end