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 certificate bundle. For more information on SSL certficate configuration, see Managing SSL Certificates.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Instance Attribute Summary collapse

Class Method 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):

  • :certificate_name (String)

    The value to assign to the #certificate_name property

  • :public_certificate (String)

    The value to assign to the #public_certificate property

  • :ca_certificate (String)

    The value to assign to the #ca_certificate property



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/oci/load_balancer/models/certificate.rb', line 85

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ca_certificateString

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


52
53
54
# File 'lib/oci/load_balancer/models/certificate.rb', line 52

def ca_certificate
  @ca_certificate
end

#certificate_nameString

[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: example_certificate_bundle

Returns:

  • (String)


22
23
24
# File 'lib/oci/load_balancer/models/certificate.rb', line 22

def certificate_name
  @certificate_name
end

#public_certificateString

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


37
38
39
# File 'lib/oci/load_balancer/models/certificate.rb', line 37

def public_certificate
  @public_certificate
end

Class Method Details

.attribute_mapObject

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



55
56
57
58
59
60
61
62
63
# File 'lib/oci/load_balancer/models/certificate.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'certificate_name': :'certificateName',
    'public_certificate': :'publicCertificate',
    'ca_certificate': :'caCertificate'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



66
67
68
69
70
71
72
73
74
# File 'lib/oci/load_balancer/models/certificate.rb', line 66

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'certificate_name': :'String',
    'public_certificate': :'String',
    'ca_certificate': :'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



117
118
119
120
121
122
123
124
# File 'lib/oci/load_balancer/models/certificate.rb', line 117

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

  self.class == other.class &&
    certificate_name == other.certificate_name &&
    public_certificate == other.public_certificate &&
    ca_certificate == other.ca_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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/oci/load_balancer/models/certificate.rb', line 149

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


129
130
131
# File 'lib/oci/load_balancer/models/certificate.rb', line 129

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



182
183
184
185
186
187
188
189
190
191
# File 'lib/oci/load_balancer/models/certificate.rb', line 182

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



176
177
178
# File 'lib/oci/load_balancer/models/certificate.rb', line 176

def to_s
  to_hash.to_s
end